Class AssetStagingProps

Initialization properties for AssetStaging.

Inheritance

object

AssetStagingProps

Implements

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class AssetStagingProps : IAssetStagingProps, IFingerprintOptions, ICopyOptions, IAssetOptions

Syntax (vb)

Public Class AssetStagingProps Implements IAssetStagingProps, IFingerprintOptions, ICopyOptions, IAssetOptions

Remarks

ExampleMetadata: fixture=_generated

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 assetStagingProps = new AssetStagingProps {
                SourcePath = "sourcePath",

                // the properties below are optional
                AssetHash = "assetHash",
                AssetHashType = AssetHashType.SOURCE,
                Bundling = new BundlingOptions {
                    Image = dockerImage,

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

                        // the properties below are optional
                        Consistency = DockerVolumeConsistency.CONSISTENT
                    } },
                    VolumesFrom = new [] { "volumesFrom" },
                    WorkingDirectory = "workingDirectory"
                },
                Exclude = new [] { "exclude" },
                ExtraHash = "extraHash",
                Follow = SymlinkFollowMode.NEVER,
                IgnoreMode = IgnoreMode.GLOB
            };

Synopsis

Constructors

AssetStagingProps()

Initialization properties for AssetStaging.

Properties

AssetHash	Specify a custom hash for this asset.
AssetHashType	Specifies the type of hash to calculate for this asset.
Bundling	Bundle the asset by executing a command in a Docker container or a custom bundling provider.
Exclude	File paths matching the patterns will be excluded.
ExtraHash	Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
Follow	A strategy for how to handle symlinks.
IgnoreMode	The ignore behavior to use for `exclude` patterns.
SourcePath	The source file or directory to copy from.

Constructors

AssetStagingProps()

Initialization properties for AssetStaging.

public AssetStagingProps()

Remarks

ExampleMetadata: fixture=_generated

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 assetStagingProps = new AssetStagingProps {
                SourcePath = "sourcePath",

                // the properties below are optional
                AssetHash = "assetHash",
                AssetHashType = AssetHashType.SOURCE,
                Bundling = new BundlingOptions {
                    Image = dockerImage,

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

                        // the properties below are optional
                        Consistency = DockerVolumeConsistency.CONSISTENT
                    } },
                    VolumesFrom = new [] { "volumesFrom" },
                    WorkingDirectory = "workingDirectory"
                },
                Exclude = new [] { "exclude" },
                ExtraHash = "extraHash",
                Follow = SymlinkFollowMode.NEVER,
                IgnoreMode = IgnoreMode.GLOB
            };

Properties

AssetHash

Specify a custom hash for this asset.

public string? AssetHash { get; set; }

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.

public AssetHashType? AssetHashType { get; set; }

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.

public IBundlingOptions? Bundling { get; set; }

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

Exclude

File paths matching the patterns will be excluded.

public string[]? Exclude { get; set; }

Property Value

string[]

Remarks

See ignoreMode to set the matching behavior. Has no effect on Assets bundled using the bundling property.

Default: - nothing is excluded

ExtraHash

Extra information to encode into the fingerprint (e.g. build instructions and other inputs).

public string? ExtraHash { get; set; }

Property Value

string

Remarks

Default: - hash is only based on source content

Follow

A strategy for how to handle symlinks.

public SymlinkFollowMode? Follow { get; set; }

Property Value

SymlinkFollowMode?

Remarks

Default: SymlinkFollowMode.NEVER

IgnoreMode

The ignore behavior to use for exclude patterns.

public IgnoreMode? IgnoreMode { get; set; }

Property Value

IgnoreMode?

Remarks

Default: IgnoreMode.GLOB

SourcePath

The source file or directory to copy from.

public string SourcePath { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Implements

IAssetStagingProps

IFingerprintOptions

ICopyOptions

IAssetOptions