software.amazon.awscdk.services.s3.deployment

Class BucketDeploymentProps.Builder

java.lang.Object

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

Enclosing interface:

BucketDeploymentProps

public static final class BucketDeploymentProps.Builder
extends java.lang.Object

A builder for BucketDeploymentProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BucketDeploymentProps.Builder	accessControl(BucketAccessControl accessControl) Sets the value of BucketDeploymentProps.getAccessControl()
BucketDeploymentProps	build() Builds the configured instance.
BucketDeploymentProps.Builder	cacheControl(java.util.List<? extends CacheControl> cacheControl) Sets the value of BucketDeploymentProps.getCacheControl()
BucketDeploymentProps.Builder	contentDisposition(java.lang.String contentDisposition) Sets the value of BucketDeploymentProps.getContentDisposition()
BucketDeploymentProps.Builder	contentEncoding(java.lang.String contentEncoding) Sets the value of BucketDeploymentProps.getContentEncoding()
BucketDeploymentProps.Builder	contentLanguage(java.lang.String contentLanguage) Sets the value of BucketDeploymentProps.getContentLanguage()
BucketDeploymentProps.Builder	contentType(java.lang.String contentType) Sets the value of BucketDeploymentProps.getContentType()
BucketDeploymentProps.Builder	destinationBucket(IBucket destinationBucket) Sets the value of BucketDeploymentProps.getDestinationBucket()
BucketDeploymentProps.Builder	destinationKeyPrefix(java.lang.String destinationKeyPrefix) Sets the value of BucketDeploymentProps.getDestinationKeyPrefix()
BucketDeploymentProps.Builder	distribution(IDistribution distribution) Sets the value of BucketDeploymentProps.getDistribution()
BucketDeploymentProps.Builder	distributionPaths(java.util.List<java.lang.String> distributionPaths) Sets the value of BucketDeploymentProps.getDistributionPaths()
BucketDeploymentProps.Builder	ephemeralStorageSize(Size ephemeralStorageSize) Sets the value of BucketDeploymentProps.getEphemeralStorageSize()
BucketDeploymentProps.Builder	exclude(java.util.List<java.lang.String> exclude) Sets the value of BucketDeploymentProps.getExclude()
BucketDeploymentProps.Builder	expires(Expiration expires) Sets the value of BucketDeploymentProps.getExpires()
BucketDeploymentProps.Builder	include(java.util.List<java.lang.String> include) Sets the value of BucketDeploymentProps.getInclude()
BucketDeploymentProps.Builder	logRetention(RetentionDays logRetention) Sets the value of BucketDeploymentProps.getLogRetention()
BucketDeploymentProps.Builder	memoryLimit(java.lang.Number memoryLimit) Sets the value of BucketDeploymentProps.getMemoryLimit()
BucketDeploymentProps.Builder	metadata(UserDefinedObjectMetadata metadata) Sets the value of BucketDeploymentProps.getMetadata()
BucketDeploymentProps.Builder	prune(java.lang.Boolean prune) Sets the value of BucketDeploymentProps.getPrune()
BucketDeploymentProps.Builder	retainOnDelete(java.lang.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(java.lang.String serverSideEncryptionAwsKmsKeyId) Sets the value of BucketDeploymentProps.getServerSideEncryptionAwsKmsKeyId()
BucketDeploymentProps.Builder	serverSideEncryptionCustomerAlgorithm(java.lang.String serverSideEncryptionCustomerAlgorithm) Sets the value of BucketDeploymentProps.getServerSideEncryptionCustomerAlgorithm()
BucketDeploymentProps.Builder	sources(java.util.List<? extends ISource> sources) Sets the value of BucketDeploymentProps.getSources()
BucketDeploymentProps.Builder	storageClass(StorageClass storageClass) Sets the value of BucketDeploymentProps.getStorageClass()
BucketDeploymentProps.Builder	useEfs(java.lang.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(java.lang.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 Detail

Builder

public Builder()

Method Detail

destinationBucket

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

public BucketDeploymentProps.Builder sources(java.util.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

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

public BucketDeploymentProps.Builder cacheControl(java.util.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

public BucketDeploymentProps.Builder contentDisposition(java.lang.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

public BucketDeploymentProps.Builder contentEncoding(java.lang.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

public BucketDeploymentProps.Builder contentLanguage(java.lang.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

public BucketDeploymentProps.Builder contentType(java.lang.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

public BucketDeploymentProps.Builder destinationKeyPrefix(java.lang.String destinationKeyPrefix)

Sets the value of BucketDeploymentProps.getDestinationKeyPrefix()

Parameters:

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

Returns:

this

distribution

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

public BucketDeploymentProps.Builder distributionPaths(java.util.List<java.lang.String> distributionPaths)

Sets the value of BucketDeploymentProps.getDistributionPaths()

Parameters:

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

Returns:

this

ephemeralStorageSize

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

public BucketDeploymentProps.Builder exclude(java.util.List<java.lang.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

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

include

public BucketDeploymentProps.Builder include(java.util.List<java.lang.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

logRetention

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.

Returns:

this

memoryLimit

public BucketDeploymentProps.Builder memoryLimit(java.lang.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

public BucketDeploymentProps.Builder metadata(UserDefinedObjectMetadata metadata)

Sets the value of BucketDeploymentProps.getMetadata()

Parameters:

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

Returns:

this

prune

public BucketDeploymentProps.Builder prune(java.lang.Boolean prune)

Sets the value of BucketDeploymentProps.getPrune()

Parameters:

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

public BucketDeploymentProps.Builder retainOnDelete(java.lang.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

public BucketDeploymentProps.Builder role(IRole role)

Sets the value of BucketDeploymentProps.getRole()

Parameters:

role - Execution role associated with this function.

Returns:

this

serverSideEncryption

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

public BucketDeploymentProps.Builder serverSideEncryptionAwsKmsKeyId(java.lang.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

public BucketDeploymentProps.Builder serverSideEncryptionCustomerAlgorithm(java.lang.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

storageClass

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

public BucketDeploymentProps.Builder useEfs(java.lang.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

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

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

public BucketDeploymentProps.Builder websiteRedirectLocation(java.lang.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

public BucketDeploymentProps build()

Builds the configured instance.

Returns:

a new instance of BucketDeploymentProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided