Package io.github.cdklabs.awslambdarust

Interface BundlingOptions

  • All Superinterfaces:
    software.amazon.awscdk.DockerRunOptions, software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    BundlingOptions.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-05-06T06:07:14.509Z")
@Stability(Experimental)
public interface BundlingOptions
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.DockerRunOptions
    (experimental) Bundling options.

    • Method Detail

      • getAssetHash

        @Stability(Experimental)
@Nullable
default String getAssetHash()
        (experimental) Specify a custom hash for this asset.

        If assetHashType is set it must be set to AssetHashType.CUSTOM. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

        NOTE: the 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 hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated.

        Default: - based on `assetHashType`

      • getAssetHashType

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.AssetHashType getAssetHashType()
        (experimental) Determines how the asset hash is calculated. Assets will get rebuilt and uploaded only if their hash has changed.

        If the asset hash is set to OUTPUT (default), the hash is calculated after bundling. This means that any change in the output will cause the asset to be invalidated and uploaded. Bear in mind that the rust binary that is output can be different depending on the target that it was compiled for.

        If the asset hash is set to SOURCE, then only changes to the source directory will cause the asset to rebuild. If your go project has multiple Lambda functions this means that an update to any one function could cause all the functions to be rebuilt and uploaded.

        Default: AssetHashType.CUSTOM

      • getBuildArgs

        @Stability(Experimental)
@Nullable
default Map<String,​String> getBuildArgs()
        (experimental) Build arguments to pass when building the bundling image.

        Default: - no build arguments are passed

      • getBundlingFileAccess

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.BundlingFileAccess getBundlingFileAccess()
        (experimental) Which option to use to copy the source files to the docker container and output files back.

        Default: - BundlingFileAccess.BIND_MOUNT

      • getCommandHooks

        @Stability(Experimental)
@Nullable
default ICommandHooks getCommandHooks()
        (experimental) Command hooks.

        Default: - do not run additional commands

      • getDockerImage

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.DockerImage getDockerImage()
        (experimental) A custom bundling Docker image.

        Default: - use the Docker image provided by

      • getExtraBuildArgs

        @Stability(Experimental)
@Nullable
default List<String> getExtraBuildArgs()
        (experimental) Additional arguments that are passed in at build time to package manager.

        Examples

        • --all-features
        • --no-default-features

      • getFeatures

        @Stability(Experimental)
@Nullable
default List<String> getFeatures()
        (experimental) A list of features to activate when compiling Rust code.

      • getForceDockerBundling

        @Stability(Experimental)
@Nullable
default Boolean getForceDockerBundling()
        (experimental) Force bundling in a Docker container even if local bundling is possible.

        Default: - false

      • getLogLevel

        @Stability(Experimental)
@Nullable
default LogLevel getLogLevel()
        (experimental) Log level for cargo.

        Default: LogLevel.WARNING

      • getPackageManagerType

        @Stability(Experimental)
@Nullable
default PackageManagerType getPackageManagerType()
        (experimental) The type of package manager to use.

        Default: - PackageManagerType.CARGO_ZIGBUILD

      • getTarget

        @Stability(Experimental)
@Nullable
default String getTarget()
        (experimental) Cross compilation target environment for the generated binary.