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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.562Z")
 @Stability(value=Stable)
public interface S3DeployActionProps
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps

Construction properties of the S3 deploy Action.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 Artifact sourceOutput = new Artifact();
 Bucket targetBucket = new Bucket(this, "MyBucket");
 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 S3DeployAction deployAction = S3DeployAction.Builder.create()
         .actionName("S3Deploy")
         .bucket(targetBucket)
         .input(sourceOutput)
         .build();
 IStage deployStage = pipeline.addStage(StageOptions.builder()
         .stageName("Deploy")
         .actions(List.of(deployAction))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	S3DeployActionProps.Builder A builder for S3DeployActionProps
static class	S3DeployActionProps.Jsii$Proxy An implementation for S3DeployActionProps

Method Summary

Modifier and Type	Method and Description
static S3DeployActionProps.Builder	builder()
default BucketAccessControl	getAccessControl() The specified canned ACL to objects deployed to Amazon S3.
IBucket	getBucket() The Amazon S3 bucket that is the deploy target.
default List<CacheControl>	getCacheControl() The caching behavior for requests/responses for objects in the bucket.
default Boolean	getExtract() Should the deploy action extract the artifact before deploying to Amazon S3.
Artifact	getInput() The input Artifact to deploy to Amazon S3.
default String	getObjectKey() The key of the target object.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBucket

@Stability(value=Stable)
 @NotNull
IBucket getBucket()

The Amazon S3 bucket that is the deploy target.

getInput

@Stability(value=Stable)
 @NotNull
Artifact getInput()

The input Artifact to deploy to Amazon S3.

getAccessControl

@Stability(value=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(value=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

getExtract

@Stability(value=Stable)
 @Nullable
default Boolean getExtract()

Should the deploy action extract the artifact before deploying to Amazon S3.

Default: true

getObjectKey

@Stability(value=Stable)
 @Nullable
default String getObjectKey()

The key of the target object.

This is required if extract is false.

builder

@Stability(value=Stable)
static S3DeployActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Returns:

a S3DeployActionProps.Builder of S3DeployActionProps