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

Interface S3DeployActionProps

All Superinterfaces:
CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
S3DeployActionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)", date="2023-10-26T00:56:05.781Z") @Stability(Stable) public interface S3DeployActionProps extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps
Construction properties of the S3DeployAction S3 deploy Action.

Example: 

 import software.amazon.awscdk.services.kms.*;
 Artifact sourceOutput = new Artifact();
 Bucket targetBucket = new Bucket(this, "MyBucket");
 IKey key = Key.Builder.create(this, "EnvVarEncryptKey")
         .description("sample key")
         .build();
 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 S3DeployAction deployAction = S3DeployAction.Builder.create()
         .actionName("S3Deploy")
         .bucket(targetBucket)
         .input(sourceOutput)
         .encryptionKey(key)
         .build();
 IStage deployStage = pipeline.addStage(StageOptions.builder()
         .stageName("Deploy")
         .actions(List.of(deployAction))
         .build());

  • Method Details

    • getBucket

      @Stability(Stable) @NotNull IBucket getBucket()
      The Amazon S3 bucket that is the deploy target.

    • getInput

      @Stability(Stable) @NotNull Artifact getInput()
      The input Artifact to deploy to Amazon S3.

    • getAccessControl

      @Stability(Stable) @Nullable default BucketAccessControl getAccessControl()
      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

    • getCacheControl

      @Stability(Stable) @Nullable default List<CacheControl> getCacheControl()
      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

    • getEncryptionKey

      @Stability(Stable) @Nullable default IKey getEncryptionKey()
      The AWS KMS encryption key for the host bucket.

      The encryptionKey parameter encrypts uploaded artifacts with the provided AWS KMS key.

      Default: - none

    • getExtract

      @Stability(Stable) @Nullable default Boolean getExtract()
      Should the deploy action extract the artifact before deploying to Amazon S3.

      Default: true

    • getObjectKey

      @Stability(Stable) @Nullable default String getObjectKey()
      The key of the target object.

      This is required if extract is false.

    • builder

      @Stability(Stable) static S3DeployActionProps.Builder builder()
      Returns:
      a S3DeployActionProps.Builder of S3DeployActionProps