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

Class S3SourceActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<S3SourceActionProps>

Enclosing interface:

S3SourceActionProps

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

A builder for S3SourceActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
S3SourceActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
S3SourceActionProps.Builder	bucket(IBucket bucket)	Sets the value of S3SourceActionProps.getBucket()
S3SourceActionProps.Builder	bucketKey(String bucketKey)	Sets the value of S3SourceActionProps.getBucketKey()
S3SourceActionProps	build()	Builds the configured instance.
S3SourceActionProps.Builder	output(Artifact output)	Sets the value of S3SourceActionProps.getOutput()
S3SourceActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
S3SourceActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
S3SourceActionProps.Builder	trigger(S3Trigger trigger)	Sets the value of S3SourceActionProps.getTrigger()
S3SourceActionProps.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 S3SourceActionProps.Builder bucket(IBucket bucket)

Sets the value of S3SourceActionProps.getBucket()

Parameters:

bucket - The Amazon S3 bucket that stores the source code. This parameter is required. If you import an encrypted bucket in your stack, please specify the encryption key at import time by using Bucket.fromBucketAttributes() method.

Returns:

this

bucketKey

@Stability(Stable)
public S3SourceActionProps.Builder bucketKey(String bucketKey)

Sets the value of S3SourceActionProps.getBucketKey()

Parameters:

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

Returns:

this

output

@Stability(Stable)
public S3SourceActionProps.Builder output(Artifact output)

Sets the value of S3SourceActionProps.getOutput()

Parameters:

output - the value to be set. This parameter is required.

Returns:

this

trigger

@Stability(Stable)
public S3SourceActionProps.Builder trigger(S3Trigger trigger)

Sets the value of S3SourceActionProps.getTrigger()

Parameters:

trigger - 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.

Returns:

this

role

@Stability(Stable)
public S3SourceActionProps.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 S3SourceActionProps.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 S3SourceActionProps.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 S3SourceActionProps.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 S3SourceActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of S3SourceActionProps

Throws:

NullPointerException - if any required attribute was not provided