software.amazon.awscdk.services.s3.deployment

Interface BucketDeploymentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BucketDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:47.920Z")
 @Stability(value=Experimental)
public interface BucketDeploymentProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for `BucketDeployment`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BucketDeploymentProps.Builder	builder()
default List<CacheControl>	getCacheControl() (experimental) System-defined cache-control metadata to be set on all objects in the deployment.
default String	getContentDisposition() (experimental) System-defined cache-disposition metadata to be set on all objects in the deployment.
default String	getContentEncoding() (experimental) System-defined content-encoding metadata to be set on all objects in the deployment.
default String	getContentLanguage() (experimental) System-defined content-language metadata to be set on all objects in the deployment.
default String	getContentType() (experimental) System-defined content-type metadata to be set on all objects in the deployment.
IBucket	getDestinationBucket() (experimental) The S3 bucket to sync the contents of the zip file to.
default String	getDestinationKeyPrefix() (experimental) Key prefix in the destination bucket.
default IDistribution	getDistribution() (experimental) The CloudFront distribution using the destination bucket as an origin.
default List<String>	getDistributionPaths() (experimental) The file paths to invalidate in the CloudFront distribution.
default Expiration	getExpires() (experimental) System-defined expires metadata to be set on all objects in the deployment.
default Number	getMemoryLimit() (experimental) The amount of memory (in MiB) to allocate to the AWS Lambda function which replicates the files from the CDK bucket to the destination bucket.
default UserDefinedObjectMetadata	getMetadata() (experimental) User-defined object metadata to be set on all objects in the deployment.
default Boolean	getPrune() (experimental) If this is set to false, files in the destination bucket that do not exist in the asset, will NOT be deleted during deployment (create/update).
default Boolean	getRetainOnDelete() (experimental) If this is set to "false", the destination files will be deleted when the resource is deleted or the destination is updated.
default IRole	getRole() (experimental) Execution role associated with this function.
default ServerSideEncryption	getServerSideEncryption() (experimental) System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment.
default String	getServerSideEncryptionAwsKmsKeyId() (experimental) System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment.
default String	getServerSideEncryptionCustomerAlgorithm() (experimental) System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment.
List<ISource>	getSources() (experimental) The sources from which to deploy the contents of this bucket.
default StorageClass	getStorageClass() (experimental) System-defined x-amz-storage-class metadata to be set on all objects in the deployment.
default IVpc	getVpc() (experimental) The VPC network to place the deployment lambda handler in.
default SubnetSelection	getVpcSubnets() (experimental) Where in the VPC to place the deployment lambda handler.
default String	getWebsiteRedirectLocation() (experimental) System-defined x-amz-website-redirect-location metadata to be set on all objects in the deployment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDestinationBucket

@Stability(value=Experimental)
 @NotNull
IBucket getDestinationBucket()

(experimental) The S3 bucket to sync the contents of the zip file to.

getSources

@Stability(value=Experimental)
 @NotNull
List<ISource> getSources()

(experimental) The sources from which to deploy the contents of this bucket.

getCacheControl

@Stability(value=Experimental)
 @Nullable
default List<CacheControl> getCacheControl()

(experimental) System-defined cache-control metadata to be set on all objects in the deployment.

Default: - Not set.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

getContentDisposition

@Stability(value=Experimental)
 @Nullable
default String getContentDisposition()

(experimental) System-defined cache-disposition metadata to be set on all objects in the deployment.

Default: - Not set.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

getContentEncoding

@Stability(value=Experimental)
 @Nullable
default String getContentEncoding()

(experimental) System-defined content-encoding metadata to be set on all objects in the deployment.

Default: - Not set.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

getContentLanguage

@Stability(value=Experimental)
 @Nullable
default String getContentLanguage()

(experimental) System-defined content-language metadata to be set on all objects in the deployment.

Default: - Not set.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

getContentType

@Stability(value=Experimental)
 @Nullable
default String getContentType()

(experimental) System-defined content-type metadata to be set on all objects in the deployment.

Default: - Not set.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

getDestinationKeyPrefix

@Stability(value=Experimental)
 @Nullable
default String getDestinationKeyPrefix()

(experimental) Key prefix in the destination bucket.

Default: "/" (unzip to root of the destination bucket)

getDistribution

@Stability(value=Experimental)
 @Nullable
default IDistribution getDistribution()

(experimental) The CloudFront distribution using the destination bucket as an origin.

Files in the distribution's edge caches will be invalidated after files are uploaded to the destination bucket.

Default: - No invalidation occurs

getDistributionPaths

@Stability(value=Experimental)
 @Nullable
default List<String> getDistributionPaths()

(experimental) The file paths to invalidate in the CloudFront distribution.

Default: - All files under the destination bucket key prefix will be invalidated.

getExpires

@Stability(value=Experimental)
 @Nullable
default Expiration getExpires()

(experimental) System-defined expires metadata to be set on all objects in the deployment.

Default: - The objects in the distribution will not expire.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

getMemoryLimit

@Stability(value=Experimental)
 @Nullable
default Number getMemoryLimit()

(experimental) The amount of memory (in MiB) to allocate to the AWS Lambda function which replicates the files from the CDK bucket to the destination bucket.

If you are deploying large files, you will need to increase this number accordingly.

Default: 128

getMetadata

@Stability(value=Experimental)
 @Nullable
default UserDefinedObjectMetadata getMetadata()

(experimental) User-defined object metadata to be set on all objects in the deployment.

Default: - No user metadata is set

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata

getPrune

@Stability(value=Experimental)
 @Nullable
default Boolean getPrune()

(experimental) If this is set to false, files in the destination bucket that do not exist in the asset, will NOT be deleted during deployment (create/update).

Default: true

See Also:

https://docs.aws.amazon.com/cli/latest/reference/s3/sync.html

getRetainOnDelete

@Stability(value=Experimental)
 @Nullable
default Boolean getRetainOnDelete()

(experimental) If this is set to "false", the destination files will be deleted when the resource is deleted or the destination is updated.

NOTICE: Configuring this to "false" might have operational implications. Please visit to the package documentation referred below to make sure you fully understand those implications.

Default: true - when resource is deleted/updated, files are retained

See Also:

https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/aws-s3-deployment#retain-on-delete

getRole

@Stability(value=Experimental)
 @Nullable
default IRole getRole()

(experimental) Execution role associated with this function.

Default: - A role is automatically created

getServerSideEncryption

@Stability(value=Experimental)
 @Nullable
default ServerSideEncryption getServerSideEncryption()

(experimental) System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment.

Default: - Server side encryption is not used.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

getServerSideEncryptionAwsKmsKeyId

@Stability(value=Experimental)
 @Nullable
default String getServerSideEncryptionAwsKmsKeyId()

(experimental) System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment.

Default: - Not set.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

getServerSideEncryptionCustomerAlgorithm

@Stability(value=Experimental)
 @Nullable
default String getServerSideEncryptionCustomerAlgorithm()

(experimental) System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment.

Warning: This is not a useful parameter until this bug is fixed: https://github.com/aws/aws-cdk/issues/6080

Default: - Not set.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html#sse-c-how-to-programmatically-intro

getStorageClass

@Stability(value=Experimental)
 @Nullable
default StorageClass getStorageClass()

(experimental) System-defined x-amz-storage-class metadata to be set on all objects in the deployment.

Default: - Default storage-class for the bucket is used.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

getVpc

@Stability(value=Experimental)
 @Nullable
default IVpc getVpc()

(experimental) The VPC network to place the deployment lambda handler in.

Default: None

getVpcSubnets

@Stability(value=Experimental)
 @Nullable
default SubnetSelection getVpcSubnets()

(experimental) Where in the VPC to place the deployment lambda handler.

Only used if 'vpc' is supplied.

Default: - the Vpc default strategy if not specified

getWebsiteRedirectLocation

@Stability(value=Experimental)
 @Nullable
default String getWebsiteRedirectLocation()

(experimental) System-defined x-amz-website-redirect-location metadata to be set on all objects in the deployment.

Default: - No website redirection.

See Also:

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

builder

@Stability(value=Experimental)
static BucketDeploymentProps.Builder builder()

Returns:

a BucketDeploymentProps.Builder of BucketDeploymentProps