Package 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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:45.553Z")
@Stability(Stable)
public interface BucketDeploymentProps
extends software.amazon.jsii.JsiiSerializable

Properties for BucketDeployment.

Example:

 Bucket websiteBucket;
 BucketDeployment deployment = BucketDeployment.Builder.create(this, "DeployWebsite")
         .sources(List.of(Source.asset(join(__dirname, "my-website"))))
         .destinationBucket(websiteBucket)
         .build();
 new ConstructThatReadsFromTheBucket(this, "Consumer", Map.of(
         // Use 'deployment.deployedBucket' instead of 'websiteBucket' here
         "bucket", deployment.getDeployedBucket()));
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BucketDeploymentProps.Builder	builder()
default BucketAccessControl	getAccessControl()	System-defined x-amz-acl metadata to be set on all objects in the deployment.
default List<CacheControl>	getCacheControl()	System-defined cache-control metadata to be set on all objects in the deployment.
default String	getContentDisposition()	System-defined cache-disposition metadata to be set on all objects in the deployment.
default String	getContentEncoding()	System-defined content-encoding metadata to be set on all objects in the deployment.
default String	getContentLanguage()	System-defined content-language metadata to be set on all objects in the deployment.
default String	getContentType()	System-defined content-type metadata to be set on all objects in the deployment.
IBucket	getDestinationBucket()	The S3 bucket to sync the contents of the zip file to.
default String	getDestinationKeyPrefix()	Key prefix in the destination bucket.
default IDistribution	getDistribution()	The CloudFront distribution using the destination bucket as an origin.
default List<String>	getDistributionPaths()	The file paths to invalidate in the CloudFront distribution.
default Size	getEphemeralStorageSize()	The size of the AWS Lambda function’s /tmp directory in MiB.
default List<String>	getExclude()	If this is set, matching files or objects will be excluded from the deployment's sync command.
default Expiration	getExpires()	System-defined expires metadata to be set on all objects in the deployment.
default List<String>	getInclude()	If this is set, matching files or objects will be included with the deployment's sync command.
default RetentionDays	getLogRetention()	The number of days that the lambda function's log events are kept in CloudWatch Logs.
default Number	getMemoryLimit()	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()	User-defined object metadata to be set on all objects in the deployment.
default Boolean	getPrune()	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()	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()	Execution role associated with this function.
default ServerSideEncryption	getServerSideEncryption()	System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment.
default String	getServerSideEncryptionAwsKmsKeyId()	System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment.
default String	getServerSideEncryptionCustomerAlgorithm()	System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment.
List<ISource>	getSources()	The sources from which to deploy the contents of this bucket.
default StorageClass	getStorageClass()	System-defined x-amz-storage-class metadata to be set on all objects in the deployment.
default Boolean	getUseEfs()	Mount an EFS file system.
default IVpc	getVpc()	The VPC network to place the deployment lambda handler in.
default SubnetSelection	getVpcSubnets()	Where in the VPC to place the deployment lambda handler.
default String	getWebsiteRedirectLocation()	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 Details

getDestinationBucket

@Stability(Stable)
@NotNull
IBucket getDestinationBucket()

The S3 bucket to sync the contents of the zip file to.

getSources

@Stability(Stable)
@NotNull
List<ISource> getSources()

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

getAccessControl

@Stability(Stable)
@Nullable
default BucketAccessControl getAccessControl()

System-defined x-amz-acl metadata to be set on all objects in the deployment.

Default: - Not set.

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl

getCacheControl

@Stability(Stable)
@Nullable
default List<CacheControl> getCacheControl()

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(Stable)
@Nullable
default String getContentDisposition()

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(Stable)
@Nullable
default String getContentEncoding()

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(Stable)
@Nullable
default String getContentLanguage()

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(Stable)
@Nullable
default String getContentType()

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(Stable)
@Nullable
default String getDestinationKeyPrefix()

Key prefix in the destination bucket.

Must be <=104 characters

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

getDistribution

@Stability(Stable)
@Nullable
default IDistribution getDistribution()

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(Stable)
@Nullable
default List<String> getDistributionPaths()

The file paths to invalidate in the CloudFront distribution.

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

getEphemeralStorageSize

@Stability(Stable)
@Nullable
default Size getEphemeralStorageSize()

The size of the AWS Lambda function’s /tmp directory in MiB.

Default: 512 MiB

getExclude

@Stability(Stable)
@Nullable
default List<String> getExclude()

If this is set, matching files or objects will be excluded from the deployment's sync command.

This can be used to exclude a file from being pruned in the destination bucket.

If you want to just exclude files from the deployment package (which excludes these files evaluated when invalidating the asset), you should leverage the exclude property of AssetOptions when defining your source.

Default: - No exclude filters are used

See Also:

• https://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters

getExpires

@Stability(Stable)
@Nullable
default Expiration getExpires()

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

getInclude

@Stability(Stable)
@Nullable
default List<String> getInclude()

If this is set, matching files or objects will be included with the deployment's sync command.

Since all files from the deployment package are included by default, this property is usually leveraged alongside an exclude filter.

Default: - No include filters are used and all files are included with the sync command

See Also:

• https://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters

getLogRetention

@Stability(Stable)
@Nullable
default RetentionDays getLogRetention()

The number of days that the lambda function's log events are kept in CloudWatch Logs.

Default: logs.RetentionDays.INFINITE

getMemoryLimit

@Stability(Stable)
@Nullable
default Number getMemoryLimit()

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(Stable)
@Nullable
default UserDefinedObjectMetadata getMetadata()

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(Stable)
@Nullable
default Boolean getPrune()

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(Stable)
@Nullable
default Boolean getRetainOnDelete()

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(Stable)
@Nullable
default IRole getRole()

Execution role associated with this function.

Default: - A role is automatically created

getServerSideEncryption

@Stability(Stable)
@Nullable
default ServerSideEncryption getServerSideEncryption()

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(Stable)
@Nullable
default String getServerSideEncryptionAwsKmsKeyId()

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(Stable)
@Nullable
default String getServerSideEncryptionCustomerAlgorithm()

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(Stable)
@Nullable
default StorageClass getStorageClass()

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

getUseEfs

@Stability(Stable)
@Nullable
default Boolean getUseEfs()

Mount an EFS file system.

Enable this if your assets are large and you encounter disk space errors. Enabling this option will require a VPC to be specified.

Default: - No EFS. Lambda has access only to 512MB of disk space.

getVpc

@Stability(Stable)
@Nullable
default IVpc getVpc()

The VPC network to place the deployment lambda handler in.

This is required if useEfs is set.

Default: None

getVpcSubnets

@Stability(Stable)
@Nullable
default SubnetSelection getVpcSubnets()

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(Stable)
@Nullable
default String getWebsiteRedirectLocation()

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(Stable)
static BucketDeploymentProps.Builder builder()

Returns:

a BucketDeploymentProps.Builder of BucketDeploymentProps