software.amazon.awscdk.services.s3.assets

Interface AssetProps

All Superinterfaces:

AssetOptions, FileCopyOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AssetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.822Z")
 @Stability(value=Stable)
public interface AssetProps
extends software.amazon.jsii.JsiiSerializable, AssetOptions

Example:

 Asset asset = Asset.Builder.create(this, "BundledAsset")
         .path(join(__dirname, "markdown-asset")) // /asset-input and working directory in the container
         .bundling(BundlingOptions.builder()
                 .image(DockerImage.fromBuild(join(__dirname, "alpine-markdown"))) // Build an image
                 .command(List.of("sh", "-c", "\n            markdown index.md > /asset-output/index.html\n          "))
                 .build())
         .build();
 

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() The disk location of the asset.

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

getReaders

Methods inherited from interface software.amazon.awscdk.AssetOptions

getAssetHash, getAssetHashType, getBundling

Methods inherited from interface software.amazon.awscdk.FileCopyOptions

getExclude, getFollowSymlinks, getIgnoreMode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPath

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

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=Stable)
static AssetProps.Builder builder()

Specified by:

builder in interface AssetOptions

Specified by:

builder in interface FileCopyOptions

Returns:

a AssetProps.Builder of AssetProps