software.amazon.awscdk.services.s3.deployment

Class BucketDeployment

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

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

All Implemented Interfaces:

IConstruct, IDependable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.148Z")
public class BucketDeployment
extends Construct

`BucketDeployment` populates an S3 bucket with the contents of .zip files from other S3 buckets or from local disk.

Example:

 Bucket websiteBucket;
 BucketDeployment deployment = BucketDeployment.Builder.create(this, "DeployWebsite")
         .sources(List.of(Source.asset(join(__dirname, "my-website"))))
         .destinationBucket(websiteBucket)
         .build();
 new ConstructThatReadsFromTheBucket(this, "Consumer", Map.of(
         // Use 'deployment.deployedBucket' instead of 'websiteBucket' here
         "bucket", deployment.getDeployedBucket()));
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BucketDeployment.Builder A fluent builder for BucketDeployment.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BucketDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BucketDeployment(software.amazon.jsii.JsiiObjectRef objRef)
	BucketDeployment(software.constructs.Construct scope, java.lang.String id, BucketDeploymentProps props)

Method Summary

Modifier and Type	Method and Description
IBucket	getDeployedBucket() The bucket after the deployment.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

BucketDeployment

protected BucketDeployment(software.amazon.jsii.JsiiObjectRef objRef)

BucketDeployment

protected BucketDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

BucketDeployment

public BucketDeployment(software.constructs.Construct scope,
                        java.lang.String id,
                        BucketDeploymentProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getDeployedBucket

public IBucket getDeployedBucket()

The bucket after the deployment.

If you want to reference the destination bucket in another construct and make sure the bucket deployment has happened before the next operation is started, pass the other construct a reference to deployment.deployedBucket.

Doing this replaces calling otherResource.node.addDependency(deployment).