software.amazon.awscdk.services.s3.assets

Interface AssetOptions

All Superinterfaces:

AssetOptions, FileCopyOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AssetProps, InitFileAssetOptions, InitSourceAssetOptions

All Known Implementing Classes:

AssetProps.Jsii$Proxy, InitFileAssetOptions.Jsii$Proxy, InitSourceAssetOptions.Jsii$Proxy

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

Example:

 Function.Builder.create(this, "Function")
         .code(Code.fromAsset(join(__dirname, "my-python-handler"), AssetOptions.builder()
                 .bundling(BundlingOptions.builder()
                         .image(Runtime.PYTHON_3_9.getBundlingImage())
                         .command(List.of("bash", "-c", "pip install -r requirements.txt -t /asset-output && cp -au . /asset-output"))
                         .build())
                 .build()))
         .runtime(Runtime.PYTHON_3_9)
         .handler("index.handler")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AssetOptions.Builder	builder()
default List<IGrantable>	getReaders() A list of principals that should be able to read this asset from S3.

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

getReaders

@Stability(value=Stable)
 @Nullable
default List<IGrantable> getReaders()

A list of principals that should be able to read this asset from S3.

You can use asset.grantRead(principal) to grant read permissions later.

Default: - No principals that can read file asset.

builder

@Stability(value=Stable)
static AssetOptions.Builder builder()

Specified by:

builder in interface AssetOptions

Specified by:

builder in interface FileCopyOptions

Returns:

a AssetOptions.Builder of AssetOptions