software.amazon.awscdk.services.codepipeline.actions

Class S3SourceAction.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<S3SourceAction>

Enclosing class:

S3SourceAction

@Stability(value=Experimental)
public static final class S3SourceAction.Builder
extends Object
implements software.amazon.jsii.Builder<S3SourceAction>

(experimental) A fluent builder for S3SourceAction.

Method Summary

Modifier and Type	Method and Description
S3SourceAction.Builder	actionName(String actionName) (experimental) The physical, human-readable name of the Action.
S3SourceAction.Builder	bucket(IBucket bucket) (experimental) The Amazon S3 bucket that stores the source code.
S3SourceAction.Builder	bucketKey(String bucketKey) (experimental) The key within the S3 bucket that stores the source code.
S3SourceAction	build()
static S3SourceAction.Builder	create()
S3SourceAction.Builder	output(Artifact output)
S3SourceAction.Builder	role(IRole role) (experimental) The Role in which context's this Action will be executing in.
S3SourceAction.Builder	runOrder(Number runOrder) (experimental) The runOrder property for this Action.
S3SourceAction.Builder	trigger(S3Trigger trigger) (experimental) How should CodePipeline detect source changes for this Action.
S3SourceAction.Builder	variablesNamespace(String variablesNamespace) (experimental) The name of the namespace to use for variables emitted by this action.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static S3SourceAction.Builder create()

Returns:

a new instance of S3SourceAction.Builder.

actionName

@Stability(value=Experimental)
public S3SourceAction.Builder actionName(String actionName)

(experimental) The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required.

Returns:

this

runOrder

@Stability(value=Experimental)
public S3SourceAction.Builder runOrder(Number runOrder)

(experimental) The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default: 1

Parameters:

runOrder - The runOrder property for this Action. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

variablesNamespace

@Stability(value=Experimental)
public S3SourceAction.Builder variablesNamespace(String variablesNamespace)

(experimental) The name of the namespace to use for variables emitted by this action.

Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

Parameters:

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

Returns:

this

role

@Stability(value=Experimental)
public S3SourceAction.Builder role(IRole role)

(experimental) 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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated

Parameters:

role - The Role in which context's this Action will be executing in. This parameter is required.

Returns:

this

bucket

@Stability(value=Experimental)
public S3SourceAction.Builder bucket(IBucket bucket)

(experimental) The Amazon S3 bucket that stores the source code.

Parameters:

bucket - The Amazon S3 bucket that stores the source code. This parameter is required.

Returns:

this

bucketKey

@Stability(value=Experimental)
public S3SourceAction.Builder bucketKey(String bucketKey)

(experimental) The key within the S3 bucket that stores the source code.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 "path/to/file.zip";

Parameters:

bucketKey - The key within the S3 bucket that stores the source code. This parameter is required.

Returns:

this

output

@Stability(value=Experimental)
public S3SourceAction.Builder output(Artifact output)

Parameters:

output - This parameter is required.

Returns:

this

trigger

@Stability(value=Experimental)
public S3SourceAction.Builder trigger(S3Trigger trigger)

(experimental) How should CodePipeline detect source changes for this Action.

Note that if this is S3Trigger.EVENTS, you need to make sure to include the source Bucket in a CloudTrail Trail, as otherwise the CloudWatch Events will not be emitted.

Default: S3Trigger.POLL

Parameters:

trigger - How should CodePipeline detect source changes for this Action. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/log-s3-data-events.html

build

@Stability(value=Experimental)
public S3SourceAction build()

Specified by:

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