BucketDeployment.Builder

java.lang.Object
- software.amazon.awscdk.services.s3.deployment.BucketDeployment.Builder

Enclosing class:: BucketDeployment

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

A fluent builder for BucketDeployment.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BucketDeployment.Builder`	`accessControl(BucketAccessControl accessControl)` System-defined x-amz-acl metadata to be set on all objects in the deployment.
`BucketDeployment`	`build()`
`BucketDeployment.Builder`	`cacheControl(java.util.List<? extends CacheControl> cacheControl)` System-defined cache-control metadata to be set on all objects in the deployment.
`BucketDeployment.Builder`	`contentDisposition(java.lang.String contentDisposition)` System-defined cache-disposition metadata to be set on all objects in the deployment.
`BucketDeployment.Builder`	`contentEncoding(java.lang.String contentEncoding)` System-defined content-encoding metadata to be set on all objects in the deployment.
`BucketDeployment.Builder`	`contentLanguage(java.lang.String contentLanguage)` System-defined content-language metadata to be set on all objects in the deployment.
`BucketDeployment.Builder`	`contentType(java.lang.String contentType)` System-defined content-type metadata to be set on all objects in the deployment.
`static BucketDeployment.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`BucketDeployment.Builder`	`destinationBucket(IBucket destinationBucket)` The S3 bucket to sync the contents of the zip file to.
`BucketDeployment.Builder`	`destinationKeyPrefix(java.lang.String destinationKeyPrefix)` Key prefix in the destination bucket.
`BucketDeployment.Builder`	`distribution(IDistribution distribution)` The CloudFront distribution using the destination bucket as an origin.
`BucketDeployment.Builder`	`distributionPaths(java.util.List<java.lang.String> distributionPaths)` The file paths to invalidate in the CloudFront distribution.
`BucketDeployment.Builder`	`ephemeralStorageSize(Size ephemeralStorageSize)` The size of the AWS Lambda function’s /tmp directory in MiB.
`BucketDeployment.Builder`	`exclude(java.util.List<java.lang.String> exclude)` If this is set, matching files or objects will be excluded from the deployment's sync command.
`BucketDeployment.Builder`	`expires(Expiration expires)` System-defined expires metadata to be set on all objects in the deployment.
`BucketDeployment.Builder`	`include(java.util.List<java.lang.String> include)` If this is set, matching files or objects will be included with the deployment's sync command.
`BucketDeployment.Builder`	`logRetention(RetentionDays logRetention)` The number of days that the lambda function's log events are kept in CloudWatch Logs.
`BucketDeployment.Builder`	`memoryLimit(java.lang.Number 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.
`BucketDeployment.Builder`	`metadata(UserDefinedObjectMetadata metadata)` User-defined object metadata to be set on all objects in the deployment.
`BucketDeployment.Builder`	`prune(java.lang.Boolean 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).
`BucketDeployment.Builder`	`retainOnDelete(java.lang.Boolean retainOnDelete)` 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)` Execution role associated with this function.
`BucketDeployment.Builder`	`serverSideEncryption(ServerSideEncryption serverSideEncryption)` System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment.
`BucketDeployment.Builder`	`serverSideEncryptionAwsKmsKeyId(java.lang.String serverSideEncryptionAwsKmsKeyId)` System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment.
`BucketDeployment.Builder`	`serverSideEncryptionCustomerAlgorithm(java.lang.String serverSideEncryptionCustomerAlgorithm)` System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment.
`BucketDeployment.Builder`	`sources(java.util.List<? extends ISource> sources)` The sources from which to deploy the contents of this bucket.
`BucketDeployment.Builder`	`storageClass(StorageClass storageClass)` System-defined x-amz-storage-class metadata to be set on all objects in the deployment.
`BucketDeployment.Builder`	`useEfs(java.lang.Boolean useEfs)` Mount an EFS file system.
`BucketDeployment.Builder`	`vpc(IVpc vpc)` The VPC network to place the deployment lambda handler in.
`BucketDeployment.Builder`	`vpcSubnets(SubnetSelection vpcSubnets)` Where in the VPC to place the deployment lambda handler.
`BucketDeployment.Builder`	`websiteRedirectLocation(java.lang.String websiteRedirectLocation)` 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
```
public static BucketDeployment.Builder create(software.constructs.Construct scope,
                                              java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of BucketDeployment.Builder.
  - destinationBucket
```
public BucketDeployment.Builder destinationBucket(IBucket destinationBucket)
```
    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
```
public BucketDeployment.Builder sources(java.util.List<? extends ISource> sources)
```
    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
  - accessControl
```
public BucketDeployment.Builder accessControl(BucketAccessControl accessControl)
```
    System-defined x-amz-acl metadata to be set on all objects in the deployment.
    Default: - Not set.
    
    Parameters:
    
    accessControl - System-defined x-amz-acl 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/userguide/acl-overview.html#canned-acl
  - cacheControl
```
public BucketDeployment.Builder cacheControl(java.util.List<? extends CacheControl> cacheControl)
```
    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
```
public BucketDeployment.Builder contentDisposition(java.lang.String contentDisposition)
```
    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
```
public BucketDeployment.Builder contentEncoding(java.lang.String contentEncoding)
```
    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
```
public BucketDeployment.Builder contentLanguage(java.lang.String contentLanguage)
```
    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
```
public BucketDeployment.Builder contentType(java.lang.String contentType)
```
    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
```
public BucketDeployment.Builder destinationKeyPrefix(java.lang.String destinationKeyPrefix)
```
    Key prefix in the destination bucket.
    Must be <=104 characters
    Default: "/" (unzip to root of the destination bucket)
    
    Parameters:
    
    destinationKeyPrefix - Key prefix in the destination bucket. This parameter is required.
    
    Returns:
    
    this
  - distribution
```
public BucketDeployment.Builder distribution(IDistribution 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.
    Default: - No invalidation occurs
    
    Parameters:
    
    distribution - The CloudFront distribution using the destination bucket as an origin. This parameter is required.
    
    Returns:
    
    this
  - distributionPaths
```
public BucketDeployment.Builder distributionPaths(java.util.List<java.lang.String> distributionPaths)
```
    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
  - ephemeralStorageSize
```
public BucketDeployment.Builder ephemeralStorageSize(Size ephemeralStorageSize)
```
    The size of the AWS Lambda function’s /tmp directory in MiB.
    Default: 512 MiB
    
    Parameters:
    
    ephemeralStorageSize - The size of the AWS Lambda function’s /tmp directory in MiB. This parameter is required.
    
    Returns:
    
    this
  - exclude
```
public BucketDeployment.Builder exclude(java.util.List<java.lang.String> 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.
    Default: - No exclude filters are used
    
    Parameters:
    
    exclude - If this is set, matching files or objects will be excluded from the deployment's sync command. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters
  - expires
```
public BucketDeployment.Builder expires(Expiration expires)
```
    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
  - include
```
public BucketDeployment.Builder include(java.util.List<java.lang.String> 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.
    Default: - No include filters are used and all files are included with the sync command
    
    Parameters:
    
    include - If this is set, matching files or objects will be included with the deployment's sync command. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters
  - logRetention
```
public BucketDeployment.Builder logRetention(RetentionDays logRetention)
```
    The number of days that the lambda function's log events are kept in CloudWatch Logs.
    Default: logs.RetentionDays.INFINITE
    
    Parameters:
    
    logRetention - The number of days that the lambda function's log events are kept in CloudWatch Logs. This parameter is required.
    
    Returns:
    
    this
  - memoryLimit
```
public BucketDeployment.Builder memoryLimit(java.lang.Number 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.
    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
```
public BucketDeployment.Builder metadata(UserDefinedObjectMetadata metadata)
```
    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
```
public BucketDeployment.Builder prune(java.lang.Boolean 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).
    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
```
public BucketDeployment.Builder retainOnDelete(java.lang.Boolean 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.
    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
```
public BucketDeployment.Builder role(IRole role)
```
    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
```
public BucketDeployment.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
```
    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
```
public BucketDeployment.Builder serverSideEncryptionAwsKmsKeyId(java.lang.String serverSideEncryptionAwsKmsKeyId)
```
    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
```
public BucketDeployment.Builder serverSideEncryptionCustomerAlgorithm(java.lang.String 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
    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
```
public BucketDeployment.Builder storageClass(StorageClass storageClass)
```
    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
  - useEfs
```
public BucketDeployment.Builder useEfs(java.lang.Boolean 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.
    Default: - No EFS. Lambda has access only to 512MB of disk space.
    
    Parameters:
    
    useEfs - Mount an EFS file system. This parameter is required.
    
    Returns:
    
    this
  - vpc
```
public BucketDeployment.Builder vpc(IVpc vpc)
```
    The VPC network to place the deployment lambda handler in.
    This is required if useEfs is set.
    Default: None
    
    Parameters:
    
    vpc - The VPC network to place the deployment lambda handler in. This parameter is required.
    
    Returns:
    
    this
  - vpcSubnets
```
public BucketDeployment.Builder vpcSubnets(SubnetSelection vpcSubnets)
```
    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
```
public BucketDeployment.Builder websiteRedirectLocation(java.lang.String websiteRedirectLocation)
```
    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
```
public BucketDeployment build()
```

Class BucketDeployment.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

destinationBucket

sources

accessControl

cacheControl

contentDisposition

contentEncoding

contentLanguage

contentType

destinationKeyPrefix

distribution

distributionPaths

ephemeralStorageSize

exclude

expires

include

logRetention

memoryLimit

metadata

prune

retainOnDelete

role

serverSideEncryption

serverSideEncryptionAwsKmsKeyId

serverSideEncryptionCustomerAlgorithm

storageClass

useEfs

vpc

vpcSubnets

websiteRedirectLocation

build