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

Class BucketDeploymentProps.Builder

java.lang.Object

software.amazon.awscdk.services.s3.deployment.BucketDeploymentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BucketDeploymentProps>

Enclosing interface:

BucketDeploymentProps

@Stability(Stable)
public static final class BucketDeploymentProps.Builder
extends Object
implements software.amazon.jsii.Builder<BucketDeploymentProps>

A builder for BucketDeploymentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BucketDeploymentProps.Builder	accessControl(BucketAccessControl accessControl)	Sets the value of BucketDeploymentProps.getAccessControl()
BucketDeploymentProps	build()	Builds the configured instance.
BucketDeploymentProps.Builder	cacheControl(List<? extends CacheControl> cacheControl)	Sets the value of BucketDeploymentProps.getCacheControl()
BucketDeploymentProps.Builder	contentDisposition(String contentDisposition)	Sets the value of BucketDeploymentProps.getContentDisposition()
BucketDeploymentProps.Builder	contentEncoding(String contentEncoding)	Sets the value of BucketDeploymentProps.getContentEncoding()
BucketDeploymentProps.Builder	contentLanguage(String contentLanguage)	Sets the value of BucketDeploymentProps.getContentLanguage()
BucketDeploymentProps.Builder	contentType(String contentType)	Sets the value of BucketDeploymentProps.getContentType()
BucketDeploymentProps.Builder	destinationBucket(IBucket destinationBucket)	Sets the value of BucketDeploymentProps.getDestinationBucket()
BucketDeploymentProps.Builder	destinationKeyPrefix(String destinationKeyPrefix)	Sets the value of BucketDeploymentProps.getDestinationKeyPrefix()
BucketDeploymentProps.Builder	distribution(IDistribution distribution)	Sets the value of BucketDeploymentProps.getDistribution()
BucketDeploymentProps.Builder	distributionPaths(List<String> distributionPaths)	Sets the value of BucketDeploymentProps.getDistributionPaths()
BucketDeploymentProps.Builder	ephemeralStorageSize(Size ephemeralStorageSize)	Sets the value of BucketDeploymentProps.getEphemeralStorageSize()
BucketDeploymentProps.Builder	exclude(List<String> exclude)	Sets the value of BucketDeploymentProps.getExclude()
BucketDeploymentProps.Builder	expires(Expiration expires)	Sets the value of BucketDeploymentProps.getExpires()
BucketDeploymentProps.Builder	extract(Boolean extract)	Sets the value of BucketDeploymentProps.getExtract()
BucketDeploymentProps.Builder	include(List<String> include)	Sets the value of BucketDeploymentProps.getInclude()
BucketDeploymentProps.Builder	logGroup(ILogGroup logGroup)	Sets the value of BucketDeploymentProps.getLogGroup()
BucketDeploymentProps.Builder	logRetention(RetentionDays logRetention)	Sets the value of BucketDeploymentProps.getLogRetention()
BucketDeploymentProps.Builder	memoryLimit(Number memoryLimit)	Sets the value of BucketDeploymentProps.getMemoryLimit()
BucketDeploymentProps.Builder	metadata(Map<String,String> metadata)	Sets the value of BucketDeploymentProps.getMetadata()
BucketDeploymentProps.Builder	outputObjectKeys(Boolean outputObjectKeys)	Sets the value of BucketDeploymentProps.getOutputObjectKeys()
BucketDeploymentProps.Builder	prune(Boolean prune)	Sets the value of BucketDeploymentProps.getPrune()
BucketDeploymentProps.Builder	retainOnDelete(Boolean retainOnDelete)	Sets the value of BucketDeploymentProps.getRetainOnDelete()
BucketDeploymentProps.Builder	role(IRole role)	Sets the value of BucketDeploymentProps.getRole()
BucketDeploymentProps.Builder	serverSideEncryption(ServerSideEncryption serverSideEncryption)	Sets the value of BucketDeploymentProps.getServerSideEncryption()
BucketDeploymentProps.Builder	serverSideEncryptionAwsKmsKeyId(String serverSideEncryptionAwsKmsKeyId)	Sets the value of BucketDeploymentProps.getServerSideEncryptionAwsKmsKeyId()
BucketDeploymentProps.Builder	serverSideEncryptionCustomerAlgorithm(String serverSideEncryptionCustomerAlgorithm)	Sets the value of BucketDeploymentProps.getServerSideEncryptionCustomerAlgorithm()
BucketDeploymentProps.Builder	signContent(Boolean signContent)	Sets the value of BucketDeploymentProps.getSignContent()
BucketDeploymentProps.Builder	sources(List<? extends ISource> sources)	Sets the value of BucketDeploymentProps.getSources()
BucketDeploymentProps.Builder	storageClass(StorageClass storageClass)	Sets the value of BucketDeploymentProps.getStorageClass()
BucketDeploymentProps.Builder	useEfs(Boolean useEfs)	Sets the value of BucketDeploymentProps.getUseEfs()
BucketDeploymentProps.Builder	vpc(IVpc vpc)	Sets the value of BucketDeploymentProps.getVpc()
BucketDeploymentProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of BucketDeploymentProps.getVpcSubnets()
BucketDeploymentProps.Builder	websiteRedirectLocation(String websiteRedirectLocation)	Sets the value of BucketDeploymentProps.getWebsiteRedirectLocation()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

destinationBucket

@Stability(Stable)
public BucketDeploymentProps.Builder destinationBucket(IBucket destinationBucket)

Sets the value of BucketDeploymentProps.getDestinationBucket()

Parameters:

destinationBucket - The S3 bucket to sync the contents of the zip file to. This parameter is required.

Returns:

this

sources

@Stability(Stable)
public BucketDeploymentProps.Builder sources(List<? extends ISource> sources)

Sets the value of BucketDeploymentProps.getSources()

Parameters:

sources - The sources from which to deploy the contents of this bucket. This parameter is required.

Returns:

this

accessControl

@Stability(Stable)
public BucketDeploymentProps.Builder accessControl(BucketAccessControl accessControl)

Sets the value of BucketDeploymentProps.getAccessControl()

Parameters:

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

Returns:

this

cacheControl

@Stability(Stable)
public BucketDeploymentProps.Builder cacheControl(List<? extends CacheControl> cacheControl)

Sets the value of BucketDeploymentProps.getCacheControl()

Parameters:

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

Returns:

this

contentDisposition

@Stability(Stable)
public BucketDeploymentProps.Builder contentDisposition(String contentDisposition)

Sets the value of BucketDeploymentProps.getContentDisposition()

Parameters:

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

Returns:

this

contentEncoding

@Stability(Stable)
public BucketDeploymentProps.Builder contentEncoding(String contentEncoding)

Sets the value of BucketDeploymentProps.getContentEncoding()

Parameters:

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

Returns:

this

contentLanguage

@Stability(Stable)
public BucketDeploymentProps.Builder contentLanguage(String contentLanguage)

Sets the value of BucketDeploymentProps.getContentLanguage()

Parameters:

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

Returns:

this

contentType

@Stability(Stable)
public BucketDeploymentProps.Builder contentType(String contentType)

Sets the value of BucketDeploymentProps.getContentType()

Parameters:

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

Returns:

this

destinationKeyPrefix

@Stability(Stable)
public BucketDeploymentProps.Builder destinationKeyPrefix(String destinationKeyPrefix)

Sets the value of BucketDeploymentProps.getDestinationKeyPrefix()

Parameters:

destinationKeyPrefix - 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.

Returns:

this

distribution

@Stability(Stable)
public BucketDeploymentProps.Builder distribution(IDistribution distribution)

Sets the value of BucketDeploymentProps.getDistribution()

Parameters:

distribution - 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.

Returns:

this

distributionPaths

@Stability(Stable)
public BucketDeploymentProps.Builder distributionPaths(List<String> distributionPaths)

Sets the value of BucketDeploymentProps.getDistributionPaths()

Parameters:

distributionPaths - The file paths to invalidate in the CloudFront distribution.

Returns:

this

ephemeralStorageSize

@Stability(Stable)
public BucketDeploymentProps.Builder ephemeralStorageSize(Size ephemeralStorageSize)

Sets the value of BucketDeploymentProps.getEphemeralStorageSize()

Parameters:

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

Returns:

this

exclude

@Stability(Stable)
public BucketDeploymentProps.Builder exclude(List<String> exclude)

Sets the value of BucketDeploymentProps.getExclude()

Parameters:

exclude - 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.

Returns:

this

expires

@Stability(Stable)
public BucketDeploymentProps.Builder expires(Expiration expires)

Sets the value of BucketDeploymentProps.getExpires()

Parameters:

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

Returns:

this

extract

@Stability(Stable)
public BucketDeploymentProps.Builder extract(Boolean extract)

Sets the value of BucketDeploymentProps.getExtract()

Parameters:

extract - 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.

Returns:

this

include

@Stability(Stable)
public BucketDeploymentProps.Builder include(List<String> include)

Sets the value of BucketDeploymentProps.getInclude()

Parameters:

include - 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.

Returns:

this

logGroup

@Stability(Stable)
public BucketDeploymentProps.Builder logGroup(ILogGroup logGroup)

Sets the value of BucketDeploymentProps.getLogGroup()

Parameters:

logGroup - 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.

Returns:

this

logRetention

@Stability(Stable)
public BucketDeploymentProps.Builder logRetention(RetentionDays logRetention)

Sets the value of BucketDeploymentProps.getLogRetention()

Parameters:

logRetention - 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.

Returns:

this

memoryLimit

@Stability(Stable)
public BucketDeploymentProps.Builder memoryLimit(Number memoryLimit)

Sets the value of BucketDeploymentProps.getMemoryLimit()

Parameters:

memoryLimit - 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.

Returns:

this

metadata

@Stability(Stable)
public BucketDeploymentProps.Builder metadata(Map<String,String> metadata)

Sets the value of BucketDeploymentProps.getMetadata()

Parameters:

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

Returns:

this

outputObjectKeys

@Stability(Stable)
public BucketDeploymentProps.Builder outputObjectKeys(Boolean outputObjectKeys)

Sets the value of BucketDeploymentProps.getOutputObjectKeys()

Parameters:

outputObjectKeys - 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

Returns:

this

prune

@Stability(Stable)
public BucketDeploymentProps.Builder prune(Boolean prune)

Sets the value of BucketDeploymentProps.getPrune()

Parameters:

prune - 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).

Returns:

this

retainOnDelete

@Stability(Stable)
public BucketDeploymentProps.Builder retainOnDelete(Boolean retainOnDelete)

Sets the value of BucketDeploymentProps.getRetainOnDelete()

Parameters:

retainOnDelete - 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.

Returns:

this

role

@Stability(Stable)
public BucketDeploymentProps.Builder role(IRole role)

Sets the value of BucketDeploymentProps.getRole()

Parameters:

role - Execution role associated with this function.

Returns:

this

serverSideEncryption

@Stability(Stable)
public BucketDeploymentProps.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)

Sets the value of BucketDeploymentProps.getServerSideEncryption()

Parameters:

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

Returns:

this

serverSideEncryptionAwsKmsKeyId

@Stability(Stable)
public BucketDeploymentProps.Builder serverSideEncryptionAwsKmsKeyId(String serverSideEncryptionAwsKmsKeyId)

Sets the value of BucketDeploymentProps.getServerSideEncryptionAwsKmsKeyId()

Parameters:

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

Returns:

this

serverSideEncryptionCustomerAlgorithm

@Stability(Stable)
public BucketDeploymentProps.Builder serverSideEncryptionCustomerAlgorithm(String serverSideEncryptionCustomerAlgorithm)

Sets the value of BucketDeploymentProps.getServerSideEncryptionCustomerAlgorithm()

Parameters:

serverSideEncryptionCustomerAlgorithm - 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

Returns:

this

signContent

@Stability(Stable)
public BucketDeploymentProps.Builder signContent(Boolean signContent)

Sets the value of BucketDeploymentProps.getSignContent()

Parameters:

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

Returns:

this

storageClass

@Stability(Stable)
public BucketDeploymentProps.Builder storageClass(StorageClass storageClass)

Sets the value of BucketDeploymentProps.getStorageClass()

Parameters:

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

Returns:

this

useEfs

@Stability(Stable)
public BucketDeploymentProps.Builder useEfs(Boolean useEfs)

Sets the value of BucketDeploymentProps.getUseEfs()

Parameters:

useEfs - 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.

Returns:

this

vpc

@Stability(Stable)
public BucketDeploymentProps.Builder vpc(IVpc vpc)

Sets the value of BucketDeploymentProps.getVpc()

Parameters:

vpc - The VPC network to place the deployment lambda handler in. This is required if useEfs is set.

Returns:

this

vpcSubnets

@Stability(Stable)
public BucketDeploymentProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of BucketDeploymentProps.getVpcSubnets()

Parameters:

vpcSubnets - Where in the VPC to place the deployment lambda handler. Only used if 'vpc' is supplied.

Returns:

this

websiteRedirectLocation

@Stability(Stable)
public BucketDeploymentProps.Builder websiteRedirectLocation(String websiteRedirectLocation)

Sets the value of BucketDeploymentProps.getWebsiteRedirectLocation()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public BucketDeploymentProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BucketDeploymentProps>

Returns:

a new instance of BucketDeploymentProps

Throws:

NullPointerException - if any required attribute was not provided