Package software.amazon.awscdk.services.codepipeline.actions

Class S3DeployActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<S3DeployActionProps>

Enclosing interface:

S3DeployActionProps

@Stability(Stable)
public static final class S3DeployActionProps.Builder
extends Object
implements software.amazon.jsii.Builder<S3DeployActionProps>

A builder for S3DeployActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
S3DeployActionProps.Builder	accessControl(BucketAccessControl accessControl)	Sets the value of S3DeployActionProps.getAccessControl()
S3DeployActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
S3DeployActionProps.Builder	bucket(IBucket bucket)	Sets the value of S3DeployActionProps.getBucket()
S3DeployActionProps	build()	Builds the configured instance.
S3DeployActionProps.Builder	cacheControl(List<? extends CacheControl> cacheControl)	Sets the value of S3DeployActionProps.getCacheControl()
S3DeployActionProps.Builder	encryptionKey(IKey encryptionKey)	Sets the value of S3DeployActionProps.getEncryptionKey()
S3DeployActionProps.Builder	extract(Boolean extract)	Sets the value of S3DeployActionProps.getExtract()
S3DeployActionProps.Builder	input(Artifact input)	Sets the value of S3DeployActionProps.getInput()
S3DeployActionProps.Builder	objectKey(String objectKey)	Sets the value of S3DeployActionProps.getObjectKey()
S3DeployActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
S3DeployActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
S3DeployActionProps.Builder	variablesNamespace(String variablesNamespace)	Sets the value of CommonActionProps.getVariablesNamespace()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

bucket

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

Sets the value of S3DeployActionProps.getBucket()

Parameters:

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

Returns:

this

input

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

Sets the value of S3DeployActionProps.getInput()

Parameters:

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

Returns:

this

accessControl

@Stability(Stable)
public S3DeployActionProps.Builder accessControl(BucketAccessControl accessControl)

Sets the value of S3DeployActionProps.getAccessControl()

Parameters:

accessControl - The specified canned ACL to objects deployed to Amazon S3. This overwrites any existing ACL that was applied to the object.

Returns:

this

cacheControl

@Stability(Stable)
public S3DeployActionProps.Builder cacheControl(List<? extends CacheControl> cacheControl)

Sets the value of S3DeployActionProps.getCacheControl()

Parameters:

cacheControl - The caching behavior for requests/responses for objects in the bucket. The final cache control property will be the result of joining all of the provided array elements with a comma (plus a space after the comma).

Returns:

this

encryptionKey

@Stability(Stable)
public S3DeployActionProps.Builder encryptionKey(IKey encryptionKey)

Sets the value of S3DeployActionProps.getEncryptionKey()

Parameters:

encryptionKey - The AWS KMS encryption key for the host bucket. The encryptionKey parameter encrypts uploaded artifacts with the provided AWS KMS key.

Returns:

this

extract

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

Sets the value of S3DeployActionProps.getExtract()

Parameters:

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

Returns:

this

objectKey

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

Sets the value of S3DeployActionProps.getObjectKey()

Parameters:

objectKey - The key of the target object. This is required if extract is false.

Returns:

this

role

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

Sets the value of CommonAwsActionProps.getRole()

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(Stable)
public S3DeployActionProps.Builder actionName(String actionName)

Sets the value of CommonActionProps.getActionName()

Parameters:

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

Returns:

this

runOrder

@Stability(Stable)
public S3DeployActionProps.Builder runOrder(Number runOrder)

Sets the value of CommonActionProps.getRunOrder()

Parameters:

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

Returns:

this

variablesNamespace

@Stability(Stable)
public S3DeployActionProps.Builder variablesNamespace(String variablesNamespace)

Sets the value of CommonActionProps.getVariablesNamespace()

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action.

Returns:

this

build

@Stability(Stable)
public S3DeployActionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<S3DeployActionProps>

Returns:

a new instance of S3DeployActionProps

Throws:

NullPointerException - if any required attribute was not provided