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(value=Experimental)
 @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 and Description
protected	Jsii$Proxy(IBucket destinationBucket, List<? extends ISource> sources, List<? extends CacheControl> cacheControl, String contentDisposition, String contentEncoding, String contentLanguage, String contentType, String destinationKeyPrefix, IDistribution distribution, List<String> distributionPaths, Expiration expires, Number memoryLimit, UserDefinedObjectMetadata metadata, Boolean prune, Boolean retainOnDelete, IRole role, ServerSideEncryption serverSideEncryption, String serverSideEncryptionAwsKmsKeyId, String serverSideEncryptionCustomerAlgorithm, StorageClass storageClass, IVpc vpc, SubnetSelection vpcSubnets, String websiteRedirectLocation) 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 and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
List<CacheControl>	getCacheControl() (experimental) System-defined cache-control metadata to be set on all objects in the deployment.
String	getContentDisposition() (experimental) System-defined cache-disposition metadata to be set on all objects in the deployment.
String	getContentEncoding() (experimental) System-defined content-encoding metadata to be set on all objects in the deployment.
String	getContentLanguage() (experimental) System-defined content-language metadata to be set on all objects in the deployment.
String	getContentType() (experimental) System-defined content-type metadata to be set on all objects in the deployment.
IBucket	getDestinationBucket() (experimental) The S3 bucket to sync the contents of the zip file to.
String	getDestinationKeyPrefix() (experimental) Key prefix in the destination bucket.
IDistribution	getDistribution() (experimental) The CloudFront distribution using the destination bucket as an origin.
List<String>	getDistributionPaths() (experimental) The file paths to invalidate in the CloudFront distribution.
Expiration	getExpires() (experimental) System-defined expires metadata to be set on all objects in the deployment.
Number	getMemoryLimit() (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.
UserDefinedObjectMetadata	getMetadata() (experimental) User-defined object metadata to be set on all objects in the deployment.
Boolean	getPrune() (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).
Boolean	getRetainOnDelete() (experimental) If this is set to "false", the destination files will be deleted when the resource is deleted or the destination is updated.
IRole	getRole() (experimental) Execution role associated with this function.
ServerSideEncryption	getServerSideEncryption() (experimental) System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment.
String	getServerSideEncryptionAwsKmsKeyId() (experimental) System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment.
String	getServerSideEncryptionCustomerAlgorithm() (experimental) System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment.
List<ISource>	getSources() (experimental) The sources from which to deploy the contents of this bucket.
StorageClass	getStorageClass() (experimental) System-defined x-amz-storage-class metadata to be set on all objects in the deployment.
IVpc	getVpc() (experimental) The VPC network to place the deployment lambda handler in.
SubnetSelection	getVpcSubnets() (experimental) Where in the VPC to place the deployment lambda handler.
String	getWebsiteRedirectLocation() (experimental) System-defined x-amz-website-redirect-location metadata to be set on all objects in the deployment.
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

Methods inherited from interface software.amazon.awscdk.services.s3.deployment.BucketDeploymentProps

builder

Constructor Detail

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(IBucket destinationBucket,
                     List<? extends ISource> sources,
                     List<? extends CacheControl> cacheControl,
                     String contentDisposition,
                     String contentEncoding,
                     String contentLanguage,
                     String contentType,
                     String destinationKeyPrefix,
                     IDistribution distribution,
                     List<String> distributionPaths,
                     Expiration expires,
                     Number memoryLimit,
                     UserDefinedObjectMetadata metadata,
                     Boolean prune,
                     Boolean retainOnDelete,
                     IRole role,
                     ServerSideEncryption serverSideEncryption,
                     String serverSideEncryptionAwsKmsKeyId,
                     String serverSideEncryptionCustomerAlgorithm,
                     StorageClass storageClass,
                     IVpc vpc,
                     SubnetSelection vpcSubnets,
                     String websiteRedirectLocation)

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

Method Detail

getDestinationBucket

public final IBucket getDestinationBucket()

Description copied from interface: BucketDeploymentProps

(experimental) 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

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

Specified by:

getSources in interface BucketDeploymentProps

getCacheControl

public final List<CacheControl> getCacheControl()

Description copied from interface: BucketDeploymentProps

(experimental) 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

(experimental) 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

(experimental) 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

(experimental) 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

(experimental) 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

(experimental) Key prefix in the destination bucket.

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

Specified by:

getDestinationKeyPrefix in interface BucketDeploymentProps

getDistribution

public final IDistribution getDistribution()

Description copied from interface: BucketDeploymentProps

(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

Specified by:

getDistribution in interface BucketDeploymentProps

getDistributionPaths

public final List<String> getDistributionPaths()

Description copied from interface: BucketDeploymentProps

(experimental) 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

getExpires

public final Expiration getExpires()

Description copied from interface: BucketDeploymentProps

(experimental) 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

getMemoryLimit

public final Number getMemoryLimit()

Description copied from interface: BucketDeploymentProps

(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

Specified by:

getMemoryLimit in interface BucketDeploymentProps

getMetadata

public final UserDefinedObjectMetadata getMetadata()

Description copied from interface: BucketDeploymentProps

(experimental) 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

getPrune

public final Boolean getPrune()

Description copied from interface: BucketDeploymentProps

(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

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

(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

Specified by:

getRetainOnDelete in interface BucketDeploymentProps

See Also:

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

getRole

public final IRole getRole()

Description copied from interface: BucketDeploymentProps

(experimental) Execution role associated with this function.

Default: - A role is automatically created

Specified by:

getRole in interface BucketDeploymentProps

getServerSideEncryption

public final ServerSideEncryption getServerSideEncryption()

Description copied from interface: BucketDeploymentProps

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

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

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

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

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

Specified by:

getServerSideEncryptionCustomerAlgorithm in interface BucketDeploymentProps

See Also:

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

getStorageClass

public final StorageClass getStorageClass()

Description copied from interface: BucketDeploymentProps

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

Specified by:

getStorageClass in interface BucketDeploymentProps

See Also:

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

getVpc

public final IVpc getVpc()

Description copied from interface: BucketDeploymentProps

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

Default: None

Specified by:

getVpc in interface BucketDeploymentProps

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: BucketDeploymentProps

(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

Specified by:

getVpcSubnets in interface BucketDeploymentProps

getWebsiteRedirectLocation

public final String getWebsiteRedirectLocation()

Description copied from interface: BucketDeploymentProps

(experimental) 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