software.amazon.awscdk.services.codepipeline.actions

Class S3DeployAction.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.S3DeployAction.Builder

Enclosing class:

S3DeployAction

@Stability(value=Stable)
public static final class S3DeployAction.Builder
extends Object

A fluent builder for S3DeployAction.

Method Summary

Modifier and Type	Method and Description
S3DeployAction.Builder	actionName(String actionName)
S3DeployAction.Builder	bucket(IBucket bucket)
S3DeployAction	build()
static S3DeployAction.Builder	create()
S3DeployAction.Builder	extract(Boolean extract)
S3DeployAction.Builder	input(Artifact input)
S3DeployAction.Builder	objectKey(String objectKey)
S3DeployAction.Builder	role(IRole role)
S3DeployAction.Builder	runOrder(Number runOrder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static S3DeployAction.Builder create()

Returns:

a new instance of S3DeployAction.Builder.

actionName

@Stability(value=Stable)
public S3DeployAction.Builder actionName(String actionName)

Parameters:

actionName - The physical, human-readable name of the Action. Not that Action names must be unique within a single Stage. This parameter is required.

Returns:

this

runOrder

@Stability(value=Stable)
public S3DeployAction.Builder runOrder(Number runOrder)

Parameters:

runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public S3DeployAction.Builder role(IRole role)

Parameters:

role - The Role in which context's this Action will be executing in. The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property. This parameter is required.

Returns:

this

bucket

@Stability(value=Stable)
public S3DeployAction.Builder bucket(IBucket bucket)

Parameters:

bucket - The Amazon S3 bucket that is the deploy target. This parameter is required.

Returns:

this

input

@Stability(value=Stable)
public S3DeployAction.Builder input(Artifact input)

Parameters:

input - The input Artifact to deploy to Amazon S3. This parameter is required.

Returns:

this

extract

@Stability(value=Stable)
public S3DeployAction.Builder extract(Boolean extract)

Parameters:

extract - Should the deploy action extract the artifact before deploying to Amazon S3. This parameter is required.

Returns:

this

objectKey

@Stability(value=Stable)
public S3DeployAction.Builder objectKey(String objectKey)

Parameters:

objectKey - The key of the target object. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public S3DeployAction build()