Class S3DeployAction.Builder

java.lang.Object
software.amazon.awscdk.services.codepipeline.actions.S3DeployAction.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<S3DeployAction>
Enclosing class:
S3DeployAction

@Stability(Stable) public static final class S3DeployAction.Builder extends Object implements software.amazon.jsii.Builder<S3DeployAction>
A fluent builder for S3DeployAction.
  • Method Details

    • create

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

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

      invalid @link
      IAction.bind
      method in the
      invalid @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(Stable) public S3DeployAction.Builder bucket(IBucket bucket)
      The Amazon S3 bucket that is the deploy target.

      Parameters:
      bucket - The Amazon S3 bucket that is the deploy target. This parameter is required.
      Returns:
      this
    • input

      @Stability(Stable) public S3DeployAction.Builder input(Artifact input)
      The input Artifact to deploy to Amazon S3.

      Parameters:
      input - The input Artifact to deploy to Amazon S3. This parameter is required.
      Returns:
      this
    • accessControl

      @Stability(Stable) public S3DeployAction.Builder accessControl(BucketAccessControl accessControl)
      The specified canned ACL to objects deployed to Amazon S3.

      This overwrites any existing ACL that was applied to the object.

      Default: - the original object ACL

      Parameters:
      accessControl - The specified canned ACL to objects deployed to Amazon S3. This parameter is required.
      Returns:
      this
    • cacheControl

      @Stability(Stable) public S3DeployAction.Builder cacheControl(List<? extends CacheControl> 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).

      Default: - none, decided by the HTTP client

      Parameters:
      cacheControl - The caching behavior for requests/responses for objects in the bucket. This parameter is required.
      Returns:
      this
    • extract

      @Stability(Stable) public S3DeployAction.Builder extract(Boolean extract)
      Should the deploy action extract the artifact before deploying to Amazon S3.

      Default: true

      Parameters:
      extract - Should the deploy action extract the artifact before deploying to Amazon S3. This parameter is required.
      Returns:
      this
    • objectKey

      @Stability(Stable) public S3DeployAction.Builder objectKey(String objectKey)
      The key of the target object.

      This is required if extract is false.

      Parameters:
      objectKey - The key of the target object. This parameter is required.
      Returns:
      this
    • build

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