software.amazon.awscdk.services.s3.deployment

Class Source

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.s3.deployment.Source

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.158Z")
public class Source
extends software.amazon.jsii.JsiiObject

Specifies bucket deployment source.

Usage:

  Source.bucket(bucket, key)
  Source.asset('/local/path/to/directory')
  Source.asset('/local/path/to/a/file.zip')
  Source.data('hello/world/file.txt', 'Hello, world!')
  Source.data('config.json', { baz: topic.topicArn })
 

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Source(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Source(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static ISource	asset(java.lang.String path) Uses a local asset as the deployment source.
static ISource	asset(java.lang.String path, AssetOptions options) Uses a local asset as the deployment source.
static ISource	bucket(IBucket bucket, java.lang.String zipObjectKey) Uses a .zip file stored in an S3 bucket as the source for the destination bucket contents.
static ISource	data(java.lang.String objectKey, java.lang.String data) Deploys an object with the specified string contents into the bucket.
static ISource	jsonData(java.lang.String objectKey, java.lang.Object obj) Deploys an object with the specified JSON object into the bucket.

Methods inherited from class java.lang.Object

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

Constructor Detail

Source

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

Source

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

Method Detail

asset

public static ISource asset(java.lang.String path,
                            AssetOptions options)

Uses a local asset as the deployment source.

If the local asset is a .zip archive, make sure you trust the producer of the archive.

Parameters:

path - The path to a local .zip file or a directory. This parameter is required.

options -

asset

public static ISource asset(java.lang.String path)

Uses a local asset as the deployment source.

If the local asset is a .zip archive, make sure you trust the producer of the archive.

Parameters:

path - The path to a local .zip file or a directory. This parameter is required.

bucket

public static ISource bucket(IBucket bucket,
                             java.lang.String zipObjectKey)

Uses a .zip file stored in an S3 bucket as the source for the destination bucket contents.

Make sure you trust the producer of the archive.

Parameters:

bucket - The S3 Bucket. This parameter is required.

zipObjectKey - The S3 object key of the zip file with contents. This parameter is required.

data

public static ISource data(java.lang.String objectKey,
                           java.lang.String data)

Deploys an object with the specified string contents into the bucket.

The content can include deploy-time values (such as snsTopic.topicArn) that will get resolved only during deployment.

To store a JSON object use Source.jsonData().

Parameters:

objectKey - The destination S3 object key (relative to the root of the S3 deployment). This parameter is required.

data - The data to be stored in the object. This parameter is required.

jsonData

public static ISource jsonData(java.lang.String objectKey,
                               java.lang.Object obj)

Deploys an object with the specified JSON object into the bucket.

The object can include deploy-time values (such as snsTopic.topicArn) that will get resolved only during deployment.

Parameters:

objectKey - The destination S3 object key (relative to the root of the S3 deployment). This parameter is required.

obj - A JSON object. This parameter is required.