software.amazon.awscdk.services.s3.assets

Interface AssetProps

All Superinterfaces:

AssetOptions, CopyOptions, FileCopyOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AssetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:14.262Z")
 @Stability(value=Experimental)
public interface AssetProps
extends software.amazon.jsii.JsiiSerializable, AssetOptions

Example:

 import software.amazon.awscdk.services.s3.assets.Asset;
 Instance instance;
 Asset asset = Asset.Builder.create(this, "Asset")
         .path("./configure.sh")
         .build();
 String localPath = instance.userData.addS3DownloadCommand(S3DownloadOptions.builder()
         .bucket(asset.getBucket())
         .bucketKey(asset.getS3ObjectKey())
         .region("us-east-1")
         .build());
 instance.userData.addExecuteFileCommand(ExecuteFileOptions.builder()
         .filePath(localPath)
         .arguments("--verbose -y")
         .build());
 asset.grantRead(instance.getRole());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AssetProps.Builder A builder for AssetProps
static class	AssetProps.Jsii$Proxy An implementation for AssetProps

Method Summary

Modifier and Type	Method and Description
static AssetProps.Builder	builder()
String	getPath() (experimental) The disk location of the asset.

Methods inherited from interface software.amazon.awscdk.services.s3.assets.AssetOptions

getExclude, getIgnoreMode, getReaders, getSourceHash

Methods inherited from interface software.amazon.awscdk.assets.CopyOptions

getFollow

Methods inherited from interface software.amazon.awscdk.core.FileCopyOptions

getFollowSymlinks

Methods inherited from interface software.amazon.awscdk.core.AssetOptions

getAssetHash, getAssetHashType, getBundling

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPath

@Stability(value=Experimental)
 @NotNull
String getPath()

(experimental) The disk location of the asset.

The path should refer to one of the following:

• A regular file or a .zip file, in which case the file will be uploaded as-is to S3.
• A directory, in which case it will be archived into a .zip file and uploaded to S3.

builder

@Stability(value=Experimental)
static AssetProps.Builder builder()

Specified by:

builder in interface AssetOptions

Specified by:

builder in interface CopyOptions

Specified by:

builder in interface FileCopyOptions

Returns:

a AssetProps.Builder of AssetProps