software.amazon.awscdk.services.s3.assets

Interface AssetOptions

All Superinterfaces:

AssetOptions, CopyOptions, FileCopyOptions

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-28T18:14:37.412Z")
public interface AssetOptions
extends CopyOptions, FileCopyOptions, AssetOptions

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 java.util.List<java.lang.String>	getExclude() Deprecated.
default IgnoreMode	getIgnoreMode() Deprecated.
default java.util.List<IGrantable>	getReaders() A list of principals that should be able to read this asset from S3.
default java.lang.String	getSourceHash() Deprecated. see `assetHash` and `assetHashType`

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

Method Detail

getReaders

default java.util.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.

getSourceHash

@Deprecated
default java.lang.String getSourceHash()

Deprecated. see `assetHash` and `assetHashType`

(deprecated) Custom hash to use when identifying the specific version of the asset.

For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

NOTE: the source hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the source hash, you will need to make sure it is updated every time the source changes, or otherwise it is possible that some deployments will not be invalidated.

Default: - automatically calculate source hash based on the contents of the source file or directory.

getExclude

@Deprecated
default java.util.List<java.lang.String> getExclude()

Deprecated.

(deprecated) Glob patterns to exclude from the copy.

Default: nothing is excluded

Specified by:

getExclude in interface CopyOptions

Specified by:

getExclude in interface FileCopyOptions

getIgnoreMode

@Deprecated
default IgnoreMode getIgnoreMode()

Deprecated.

(deprecated) The ignore behavior to use for exclude patterns.

Default: - GLOB for file assets, DOCKER or GLOB for docker assets depending on whether the '

Specified by:

getIgnoreMode in interface CopyOptions

Specified by:

getIgnoreMode in interface FileCopyOptions

builder

static AssetOptions.Builder builder()

Specified by:

builder in interface AssetOptions

Specified by:

builder in interface CopyOptions

Specified by:

builder in interface FileCopyOptions

Returns:

a AssetOptions.Builder of AssetOptions