Package software.amazon.awscdk.services.s3.deployment

Class BucketDeploymentProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.s3.deployment.BucketDeploymentProps.Jsii$Proxy

All Implemented Interfaces:

BucketDeploymentProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

BucketDeploymentProps

@Stability(Stable)
@Internal
public static final class BucketDeploymentProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements BucketDeploymentProps

An implementation for BucketDeploymentProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3.deployment.BucketDeploymentProps

BucketDeploymentProps.Builder, BucketDeploymentProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(BucketDeploymentProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the BucketDeploymentProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final BucketAccessControl	getAccessControl()	System-defined x-amz-acl metadata to be set on all objects in the deployment.
final List<CacheControl>	getCacheControl()	System-defined cache-control metadata to be set on all objects in the deployment.
final String	getContentDisposition()	System-defined cache-disposition metadata to be set on all objects in the deployment.
final String	getContentEncoding()	System-defined content-encoding metadata to be set on all objects in the deployment.
final String	getContentLanguage()	System-defined content-language metadata to be set on all objects in the deployment.
final String	getContentType()	System-defined content-type metadata to be set on all objects in the deployment.
final IBucket	getDestinationBucket()	The S3 bucket to sync the contents of the zip file to.
final String	getDestinationKeyPrefix()	Key prefix in the destination bucket.
final IDistributionRef	getDistribution()	The CloudFront distribution using the destination bucket as an origin.
final List<String>	getDistributionPaths()	The file paths to invalidate in the CloudFront distribution.
final Size	getEphemeralStorageSize()	The size of the AWS Lambda function’s /tmp directory in MiB.
final List<String>	getExclude()	If this is set, matching files or objects will be excluded from the deployment's sync command.
final Expiration	getExpires()	System-defined expires metadata to be set on all objects in the deployment.
final Boolean	getExtract()	If this is set, the zip file will be synced to the destination S3 bucket and extracted.
final List<String>	getInclude()	If this is set, matching files or objects will be included with the deployment's sync command.
final ILogGroup	getLogGroup()	The Log Group used for logging of events emitted by the custom resource's lambda function.
final RetentionDays	getLogRetention()	The number of days that the lambda function's log events are kept in CloudWatch Logs.
final 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.
final Map<String,String>	getMetadata()	User-defined object metadata to be set on all objects in the deployment.
final Boolean	getOutputObjectKeys()	If set to false, the custom resource will not send back the SourceObjectKeys.
final Boolean	getPrune()	By default, files in the destination bucket that don't exist in the source will be deleted when the BucketDeployment resource is created or updated.
final Boolean	getRetainOnDelete()	If this is set to "false", the destination files will be deleted when the resource is deleted or the destination is updated.
final IRole	getRole()	Execution role associated with this function.
final List<ISecurityGroup>	getSecurityGroups()	The list of security groups to associate with the lambda handlers network interfaces.
final ServerSideEncryption	getServerSideEncryption()	System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment.
final String	getServerSideEncryptionAwsKmsKeyId()	System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment.
final String	getServerSideEncryptionCustomerAlgorithm()	System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment.
final Boolean	getSignContent()	If set to true, uploads will precompute the value of x-amz-content-sha256 and include it in the signed S3 request headers.
final List<ISource>	getSources()	The sources from which to deploy the contents of this bucket.
final StorageClass	getStorageClass()	System-defined x-amz-storage-class metadata to be set on all objects in the deployment.
final Boolean	getUseEfs()	Mount an EFS file system.
final IVpc	getVpc()	The VPC network to place the deployment lambda handler in.
final SubnetSelection	getVpcSubnets()	Where in the VPC to place the deployment lambda handler.
final Boolean	getWaitForDistributionInvalidation()	In case of using a cloudfront distribtuion, if this property is set to false then the custom resource will not wait and verify for Cloudfront invalidation to complete.
final String	getWebsiteRedirectLocation()	System-defined x-amz-website-redirect-location metadata to be set on all objects in the deployment.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(BucketDeploymentProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the BucketDeploymentProps.Builder.

Method Details

getDestinationBucket

public final IBucket getDestinationBucket()

Description copied from interface: BucketDeploymentProps

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

Specified by:

getDestinationBucket in interface BucketDeploymentProps

getSources

public final List<ISource> getSources()

Description copied from interface: BucketDeploymentProps

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

Specified by:

getSources in interface BucketDeploymentProps

getAccessControl

public final BucketAccessControl getAccessControl()

Description copied from interface: BucketDeploymentProps

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

Default: - Not set.

Specified by:

getAccessControl in interface BucketDeploymentProps

See Also:

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

getCacheControl

public final List<CacheControl> getCacheControl()

Description copied from interface: BucketDeploymentProps

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

Default: - Not set.

Specified by:

getCacheControl in interface BucketDeploymentProps

See Also:

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

getContentDisposition

public final String getContentDisposition()

Description copied from interface: BucketDeploymentProps

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

Default: - Not set.

Specified by:

getContentDisposition in interface BucketDeploymentProps

See Also:

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

getContentEncoding

public final String getContentEncoding()

Description copied from interface: BucketDeploymentProps

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

Default: - Not set.

Specified by:

getContentEncoding in interface BucketDeploymentProps

See Also:

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

getContentLanguage

public final String getContentLanguage()

Description copied from interface: BucketDeploymentProps

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

Default: - Not set.

Specified by:

getContentLanguage in interface BucketDeploymentProps

See Also:

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

getContentType

public final String getContentType()

Description copied from interface: BucketDeploymentProps

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

Default: - Not set.

Specified by:

getContentType in interface BucketDeploymentProps

See Also:

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

getDestinationKeyPrefix

public final String getDestinationKeyPrefix()

Description copied from interface: BucketDeploymentProps

Key prefix in the destination bucket. Must be <=104 characters.

If it's set with prune: true, it will only prune files with the prefix.

We recommend to always configure the destinationKeyPrefix property. This will prevent the deployment from accidentally deleting data that wasn't uploaded by it.

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

Specified by:

getDestinationKeyPrefix in interface BucketDeploymentProps

getDistribution

public final IDistributionRef getDistribution()

Description copied from interface: BucketDeploymentProps

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

Specified by:

getDistribution in interface BucketDeploymentProps

getDistributionPaths

public final List<String> getDistributionPaths()

Description copied from interface: BucketDeploymentProps

The file paths to invalidate in the CloudFront distribution.

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

Specified by:

getDistributionPaths in interface BucketDeploymentProps

getEphemeralStorageSize

public final Size getEphemeralStorageSize()

Description copied from interface: BucketDeploymentProps

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

Default: 512 MiB

Specified by:

getEphemeralStorageSize in interface BucketDeploymentProps

getExclude

public final List<String> getExclude()

Description copied from interface: BucketDeploymentProps

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

Specified by:

getExclude in interface BucketDeploymentProps

See Also:

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

getExpires

public final Expiration getExpires()

Description copied from interface: BucketDeploymentProps

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

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

Specified by:

getExpires in interface BucketDeploymentProps

See Also:

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

getExtract

public final Boolean getExtract()

Description copied from interface: BucketDeploymentProps

If this is set, the zip file will be synced to the destination S3 bucket and extracted.

If false, the file will remain zipped in the destination bucket.

Default: true

Specified by:

getExtract in interface BucketDeploymentProps

getInclude

public final List<String> getInclude()

Description copied from interface: BucketDeploymentProps

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

Specified by:

getInclude in interface BucketDeploymentProps

See Also:

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

getLogGroup

public final ILogGroup getLogGroup()

Description copied from interface: BucketDeploymentProps

The Log Group used for logging of events emitted by the custom resource's lambda function.

Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first.

Default: - a default log group created by AWS Lambda

Specified by:

getLogGroup in interface BucketDeploymentProps

getLogRetention

public final RetentionDays getLogRetention()

Description copied from interface: BucketDeploymentProps

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

This is a legacy API and we strongly recommend you migrate to logGroup if you can. logGroup allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.

Default: logs.RetentionDays.INFINITE

Specified by:

getLogRetention in interface BucketDeploymentProps

getMemoryLimit

public final Number getMemoryLimit()

Description copied from interface: BucketDeploymentProps

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

Specified by:

getMemoryLimit in interface BucketDeploymentProps

getMetadata

public final Map<String,String> getMetadata()

Description copied from interface: BucketDeploymentProps

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

Default: - No user metadata is set

Specified by:

getMetadata in interface BucketDeploymentProps

See Also:

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

getOutputObjectKeys

public final Boolean getOutputObjectKeys()

Description copied from interface: BucketDeploymentProps

If set to false, the custom resource will not send back the SourceObjectKeys.

This is useful when you are facing the error Response object is too long

See https://github.com/aws/aws-cdk/issues/28579

Default: true

Specified by:

getOutputObjectKeys in interface BucketDeploymentProps

getPrune

public final Boolean getPrune()

Description copied from interface: BucketDeploymentProps

By default, files in the destination bucket that don't exist in the source will be deleted when the BucketDeployment resource is created or updated.

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

Specified by:

getPrune in interface BucketDeploymentProps

See Also:

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

getRetainOnDelete

public final Boolean getRetainOnDelete()

Description copied from interface: BucketDeploymentProps

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

Specified by:

getRetainOnDelete in interface BucketDeploymentProps

See Also:

• https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-s3-deployment#retain-on-delete

getRole

public final IRole getRole()

Description copied from interface: BucketDeploymentProps

Execution role associated with this function.

Default: - A role is automatically created

Specified by:

getRole in interface BucketDeploymentProps

getSecurityGroups

public final List<ISecurityGroup> getSecurityGroups()

Description copied from interface: BucketDeploymentProps

The list of security groups to associate with the lambda handlers network interfaces.

Only used if 'vpc' is supplied.

Default: undefined - If the function is placed within a VPC and a security group is not specified a dedicated security group will be created for this function.

Specified by:

getSecurityGroups in interface BucketDeploymentProps

getServerSideEncryption

public final ServerSideEncryption getServerSideEncryption()

Description copied from interface: BucketDeploymentProps

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

Default: - Server side encryption is not used.

Specified by:

getServerSideEncryption in interface BucketDeploymentProps

See Also:

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

getServerSideEncryptionAwsKmsKeyId

public final String getServerSideEncryptionAwsKmsKeyId()

Description copied from interface: BucketDeploymentProps

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

Default: - Not set.

Specified by:

getServerSideEncryptionAwsKmsKeyId in interface BucketDeploymentProps

See Also:

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

getServerSideEncryptionCustomerAlgorithm

public final String getServerSideEncryptionCustomerAlgorithm()

Description copied from interface: BucketDeploymentProps

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.

Specified by:

getServerSideEncryptionCustomerAlgorithm in interface BucketDeploymentProps

See Also:

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

getSignContent

public final Boolean getSignContent()

Description copied from interface: BucketDeploymentProps

If set to true, uploads will precompute the value of x-amz-content-sha256 and include it in the signed S3 request headers.

Default: - `x-amz-content-sha256` will not be computed

Specified by:

getSignContent in interface BucketDeploymentProps

getStorageClass

public final StorageClass getStorageClass()

Description copied from interface: BucketDeploymentProps

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.

Specified by:

getStorageClass in interface BucketDeploymentProps

See Also:

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

getUseEfs

public final Boolean getUseEfs()

Description copied from interface: BucketDeploymentProps

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.

Specified by:

getUseEfs in interface BucketDeploymentProps

getVpc

public final IVpc getVpc()

Description copied from interface: BucketDeploymentProps

The VPC network to place the deployment lambda handler in.

This is required if useEfs is set.

Default: None

Specified by:

getVpc in interface BucketDeploymentProps

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: BucketDeploymentProps

Where in the VPC to place the deployment lambda handler.

Only used if 'vpc' is supplied.

Default: - the Vpc default strategy if not specified

Specified by:

getVpcSubnets in interface BucketDeploymentProps

getWaitForDistributionInvalidation

public final Boolean getWaitForDistributionInvalidation()

Description copied from interface: BucketDeploymentProps

In case of using a cloudfront distribtuion, if this property is set to false then the custom resource will not wait and verify for Cloudfront invalidation to complete.

This may speed up deployment and avoid intermittent Cloudfront issues. However, this is risky and not recommended as cache invalidation can silently fail.

Default: true

Specified by:

getWaitForDistributionInvalidation in interface BucketDeploymentProps

See Also:

• https://github.com/aws/aws-cdk/issues/15891

getWebsiteRedirectLocation

public final String getWebsiteRedirectLocation()

Description copied from interface: BucketDeploymentProps

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

Default: - No website redirection.

Specified by:

getWebsiteRedirectLocation in interface BucketDeploymentProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object