Interface AssetOptions

All Superinterfaces:
AssetOptions, FileCopyOptions, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
AssetProps, CustomCommandOptions, InitFileAssetOptions, InitSourceAssetOptions
All Known Implementing Classes:
AssetOptions.Jsii$Proxy, AssetProps.Jsii$Proxy, CustomCommandOptions.Jsii$Proxy, InitFileAssetOptions.Jsii$Proxy, InitSourceAssetOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:25.122Z") @Stability(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();
 
  • Method Details

    • getDeployTime

      @Stability(Stable) @Nullable default Boolean getDeployTime()
      Whether or not the asset needs to exist beyond deployment time;

      i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds.

      For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets.

      Default: false

    • getReaders

      @Stability(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(Stable) static AssetOptions.Builder builder()
      Returns:
      a AssetOptions.Builder of AssetOptions