software.amazon.awscdk.services.s3.deployment

Class BucketDeployment.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<BucketDeployment>

Enclosing class:

BucketDeployment

@Stability(value=Experimental)
public static final class BucketDeployment.Builder
extends Object
implements software.amazon.jsii.Builder<BucketDeployment>

(experimental) A fluent builder for BucketDeployment.

Method Summary

Modifier and Type	Method and Description
BucketDeployment	build()
BucketDeployment.Builder	cacheControl(List<? extends CacheControl> cacheControl) (experimental) System-defined cache-control metadata to be set on all objects in the deployment.
BucketDeployment.Builder	contentDisposition(String contentDisposition) (experimental) System-defined cache-disposition metadata to be set on all objects in the deployment.
BucketDeployment.Builder	contentEncoding(String contentEncoding) (experimental) System-defined content-encoding metadata to be set on all objects in the deployment.
BucketDeployment.Builder	contentLanguage(String contentLanguage) (experimental) System-defined content-language metadata to be set on all objects in the deployment.
BucketDeployment.Builder	contentType(String contentType) (experimental) System-defined content-type metadata to be set on all objects in the deployment.
static BucketDeployment.Builder	create(software.constructs.Construct scope, String id)
BucketDeployment.Builder	destinationBucket(IBucket destinationBucket) (experimental) The S3 bucket to sync the contents of the zip file to.
BucketDeployment.Builder	destinationKeyPrefix(String destinationKeyPrefix) (experimental) Key prefix in the destination bucket.
BucketDeployment.Builder	distribution(IDistribution distribution) (experimental) The CloudFront distribution using the destination bucket as an origin.
BucketDeployment.Builder	distributionPaths(List<String> distributionPaths) (experimental) The file paths to invalidate in the CloudFront distribution.
BucketDeployment.Builder	expires(Expiration expires) (experimental) System-defined expires metadata to be set on all objects in the deployment.
BucketDeployment.Builder	memoryLimit(Number memoryLimit) (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.
BucketDeployment.Builder	metadata(UserDefinedObjectMetadata metadata) (experimental) User-defined object metadata to be set on all objects in the deployment.
BucketDeployment.Builder	prune(Boolean prune) (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).
BucketDeployment.Builder	retainOnDelete(Boolean retainOnDelete) (experimental) If this is set to "false", the destination files will be deleted when the resource is deleted or the destination is updated.
BucketDeployment.Builder	role(IRole role) (experimental) Execution role associated with this function.
BucketDeployment.Builder	serverSideEncryption(ServerSideEncryption serverSideEncryption) (experimental) System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment.
BucketDeployment.Builder	serverSideEncryptionAwsKmsKeyId(String serverSideEncryptionAwsKmsKeyId) (experimental) System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment.
BucketDeployment.Builder	serverSideEncryptionCustomerAlgorithm(String serverSideEncryptionCustomerAlgorithm) (experimental) System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment.
BucketDeployment.Builder	sources(List<? extends ISource> sources) (experimental) The sources from which to deploy the contents of this bucket.
BucketDeployment.Builder	storageClass(StorageClass storageClass) (experimental) System-defined x-amz-storage-class metadata to be set on all objects in the deployment.
BucketDeployment.Builder	vpc(IVpc vpc) (experimental) The VPC network to place the deployment lambda handler in.
BucketDeployment.Builder	vpcSubnets(SubnetSelection vpcSubnets) (experimental) Where in the VPC to place the deployment lambda handler.
BucketDeployment.Builder	websiteRedirectLocation(String websiteRedirectLocation) (experimental) System-defined x-amz-website-redirect-location metadata to be set on all objects in the deployment.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static BucketDeployment.Builder create(software.constructs.Construct scope,
                                                                             String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of BucketDeployment.Builder.

destinationBucket

@Stability(value=Experimental)
public BucketDeployment.Builder destinationBucket(IBucket destinationBucket)

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

Parameters:

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

Returns:

this

sources

@Stability(value=Experimental)
public BucketDeployment.Builder sources(List<? extends ISource> sources)

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

Parameters:

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

Returns:

this

cacheControl

@Stability(value=Experimental)
public BucketDeployment.Builder cacheControl(List<? extends CacheControl> cacheControl)

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

Default: - Not set.

Parameters:

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

Returns:

this

See Also:

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

contentDisposition

@Stability(value=Experimental)
public BucketDeployment.Builder contentDisposition(String contentDisposition)

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

Default: - Not set.

Parameters:

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

Returns:

this

See Also:

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

contentEncoding

@Stability(value=Experimental)
public BucketDeployment.Builder contentEncoding(String contentEncoding)

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

Default: - Not set.

Parameters:

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

Returns:

this

See Also:

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

contentLanguage

@Stability(value=Experimental)
public BucketDeployment.Builder contentLanguage(String contentLanguage)

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

Default: - Not set.

Parameters:

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

Returns:

this

See Also:

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

contentType

@Stability(value=Experimental)
public BucketDeployment.Builder contentType(String contentType)

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

Default: - Not set.

Parameters:

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

Returns:

this

See Also:

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

destinationKeyPrefix

@Stability(value=Experimental)
public BucketDeployment.Builder destinationKeyPrefix(String destinationKeyPrefix)

(experimental) Key prefix in the destination bucket.

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

Parameters:

destinationKeyPrefix - Key prefix in the destination bucket. This parameter is required.

Returns:

this

distribution

@Stability(value=Experimental)
public BucketDeployment.Builder distribution(IDistribution distribution)

(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

Parameters:

distribution - The CloudFront distribution using the destination bucket as an origin. This parameter is required.

Returns:

this

distributionPaths

@Stability(value=Experimental)
public BucketDeployment.Builder distributionPaths(List<String> distributionPaths)

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

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

Parameters:

distributionPaths - The file paths to invalidate in the CloudFront distribution. This parameter is required.

Returns:

this

expires

@Stability(value=Experimental)
public BucketDeployment.Builder expires(Expiration expires)

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

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

Parameters:

expires - System-defined expires metadata to be set on all objects in the deployment. This parameter is required.

Returns:

this

See Also:

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

memoryLimit

@Stability(value=Experimental)
public BucketDeployment.Builder memoryLimit(Number memoryLimit)

(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

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. This parameter is required.

Returns:

this

metadata

@Stability(value=Experimental)
public BucketDeployment.Builder metadata(UserDefinedObjectMetadata metadata)

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

Default: - No user metadata is set

Parameters:

metadata - User-defined object metadata to be set on all objects in the deployment. This parameter is required.

Returns:

this

See Also:

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

prune

@Stability(value=Experimental)
public BucketDeployment.Builder prune(Boolean prune)

(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

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). This parameter is required.

Returns:

this

See Also:

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

retainOnDelete

@Stability(value=Experimental)
public BucketDeployment.Builder retainOnDelete(Boolean retainOnDelete)

(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

Parameters:

retainOnDelete - If this is set to "false", the destination files will be deleted when the resource is deleted or the destination is updated. This parameter is required.

Returns:

this

See Also:

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

role

@Stability(value=Experimental)
public BucketDeployment.Builder role(IRole role)

(experimental) Execution role associated with this function.

Default: - A role is automatically created

Parameters:

role - Execution role associated with this function. This parameter is required.

Returns:

this

serverSideEncryption

@Stability(value=Experimental)
public BucketDeployment.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)

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

Parameters:

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

Returns:

this

See Also:

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

serverSideEncryptionAwsKmsKeyId

@Stability(value=Experimental)
public BucketDeployment.Builder serverSideEncryptionAwsKmsKeyId(String serverSideEncryptionAwsKmsKeyId)

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

Parameters:

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

Returns:

this

See Also:

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

serverSideEncryptionCustomerAlgorithm

@Stability(value=Experimental)
public BucketDeployment.Builder serverSideEncryptionCustomerAlgorithm(String serverSideEncryptionCustomerAlgorithm)

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

Parameters:

serverSideEncryptionCustomerAlgorithm - System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment. This parameter is required.

Returns:

this

See Also:

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

storageClass

@Stability(value=Experimental)
public BucketDeployment.Builder storageClass(StorageClass storageClass)

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

Parameters:

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

Returns:

this

See Also:

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

vpc

@Stability(value=Experimental)
public BucketDeployment.Builder vpc(IVpc vpc)

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

Default: None

Parameters:

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

Returns:

this

vpcSubnets

@Stability(value=Experimental)
public BucketDeployment.Builder vpcSubnets(SubnetSelection vpcSubnets)

(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

Parameters:

vpcSubnets - Where in the VPC to place the deployment lambda handler. This parameter is required.

Returns:

this

websiteRedirectLocation

@Stability(value=Experimental)
public BucketDeployment.Builder websiteRedirectLocation(String websiteRedirectLocation)

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

Default: - No website redirection.

Parameters:

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

Returns:

this

See Also:

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

build

@Stability(value=Experimental)
public BucketDeployment build()

Specified by:

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