Package 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(Stable) public static final class S3SourceAction.Builder extends Object implements software.amazon.jsii.Builder<S3SourceAction>
A fluent builder for S3SourceAction.

  • Method Details

    • create

      @Stability(Stable) public static S3SourceAction.Builder create()
      Returns:
      a new instance of S3SourceAction.Builder.

    • actionName

      @Stability(Stable) public S3SourceAction.Builder actionName(String actionName)
      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(Stable) public S3SourceAction.Builder runOrder(Number runOrder)
      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:

    • variablesNamespace

      @Stability(Stable) public S3SourceAction.Builder variablesNamespace(String variablesNamespace)
      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(Stable) public S3SourceAction.Builder role(IRole 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.

      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(Stable) public S3SourceAction.Builder bucket(IBucket bucket)
      The Amazon S3 bucket that stores the source code.

      If you import an encrypted bucket in your stack, please specify the encryption key at import time by using Bucket.fromBucketAttributes() method.

      Parameters:
      bucket - The Amazon S3 bucket that stores the source code. This parameter is required.
      Returns:
      this

    • bucketKey

      @Stability(Stable) public S3SourceAction.Builder bucketKey(String bucketKey)
      The key within the S3 bucket that stores the source code.

      Example: 

       "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(Stable) public S3SourceAction.Builder output(Artifact output)
      Parameters:
      output - This parameter is required.
      Returns:
      this

    • trigger

      @Stability(Stable) public S3SourceAction.Builder trigger(S3Trigger 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.

      Default: S3Trigger.POLL

      Parameters:
      trigger - How should CodePipeline detect source changes for this Action. This parameter is required.
      Returns:
      this
      See Also:

    • build

      @Stability(Stable) public S3SourceAction build()
      Specified by:
      build in interface software.amazon.jsii.Builder<S3SourceAction>
      Returns:
      a newly built instance of S3SourceAction.