Interface IAssetOptions

Namespace

Amazon.CDK

Assembly

Amazon.CDK.dll

Asset hash options.

public interface IAssetOptions

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;

            DockerImage dockerImage;
            ILocalBundling localBundling;
            var assetOptions = new AssetOptions {
                AssetHash = "assetHash",
                AssetHashType = AssetHashType.SOURCE,
                Bundling = new BundlingOptions {
                    Image = dockerImage,

                    // the properties below are optional
                    Command = new [] { "command" },
                    Entrypoint = new [] { "entrypoint" },
                    Environment = new Dictionary<string, string> {
                        { "environmentKey", "environment" }
                    },
                    Local = localBundling,
                    OutputType = BundlingOutput.ARCHIVED,
                    SecurityOpt = "securityOpt",
                    User = "user",
                    Volumes = new [] { new DockerVolume {
                        ContainerPath = "containerPath",
                        HostPath = "hostPath",

                        // the properties below are optional
                        Consistency = DockerVolumeConsistency.CONSISTENT
                    } },
                    WorkingDirectory = "workingDirectory"
                }
            };

Remarks

ExampleMetadata: fixture=_generated

Properties

AssetHash

Specify a custom hash for this asset.

string? AssetHash { get; }

Property Value

string

Remarks

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

AssetHashType

Specifies the type of hash to calculate for this asset.

AssetHashType? AssetHashType { get; }

Property Value

AssetHashType?

Remarks

If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM.

Default: - the default is AssetHashType.SOURCE, but if assetHash is explicitly specified this value defaults to AssetHashType.CUSTOM.

Bundling

Bundle the asset by executing a command in a Docker container or a custom bundling provider.

IBundlingOptions? Bundling { get; }

Property Value

IBundlingOptions

Remarks

The asset path will be mounted at /asset-input. The Docker container is responsible for putting content at /asset-output. The content at /asset-output will be zipped and used as the final asset.

Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to S3 otherwise