Package software.amazon.awscdk.services.s3.deployment

Class BucketDeployment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.services.s3.deployment.BucketDeployment
All Implemented Interfaces:
IConstruct, IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:45.550Z") @Stability(Stable) 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
    Description
    static final class 
    BucketDeployment.Builder
    A fluent builder for BucketDeployment.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

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

    IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    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 software.constructs.Construct

    toString

    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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • BucketDeployment

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

    • BucketDeployment

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

    • BucketDeployment

      @Stability(Stable) public BucketDeployment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull BucketDeploymentProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • getDeployedBucket

      @Stability(Stable) @NotNull 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).