software.amazon.awscdk.services.codepipeline.actions

Class S3DeployActionProps.Builder

java.lang.Object

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

Enclosing interface:

S3DeployActionProps

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

A builder for S3DeployActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
S3DeployActionProps.Builder	actionName(String actionName) Sets the value of ActionName
S3DeployActionProps.Builder	bucket(IBucket bucket) Sets the value of Bucket
S3DeployActionProps	build() Builds the configured instance.
S3DeployActionProps.Builder	extract(Boolean extract) Sets the value of Extract
S3DeployActionProps.Builder	input(Artifact input) Sets the value of Input
S3DeployActionProps.Builder	objectKey(String objectKey) Sets the value of ObjectKey
S3DeployActionProps.Builder	role(IRole role) Sets the value of Role
S3DeployActionProps.Builder	runOrder(Number runOrder) Sets the value of RunOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

bucket

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

Sets the value of Bucket

Parameters:

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

Returns:

this

input

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

Sets the value of Input

Parameters:

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

Returns:

this

extract

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

Sets the value of Extract

Parameters:

extract - Should the deploy action extract the artifact before deploying to Amazon S3.

Returns:

this

objectKey

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

Sets the value of ObjectKey

Parameters:

objectKey - The key of the target object.

Returns:

this

role

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

Sets the value of 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.

Returns:

this

actionName

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

Sets the value of 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 S3DeployActionProps.Builder runOrder(Number runOrder)

Sets the value of RunOrder

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Returns:

a new instance of S3DeployActionProps

Throws:

NullPointerException - if any required attribute was not provided