Class InitSourceAssetOptions

Additional options for an InitSource that builds an asset from local files.

Inheritance

object

InitSourceAssetOptions

Implements

IInitSourceAssetOptions

IInitSourceOptions

IAssetOptions

IAssetOptions

IFileCopyOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class InitSourceAssetOptions : IInitSourceAssetOptions, IInitSourceOptions, IAssetOptions, IAssetOptions, IFileCopyOptions

Syntax (vb)

Public Class InitSourceAssetOptions Implements IInitSourceAssetOptions, IInitSourceOptions, IAssetOptions, IAssetOptions, IFileCopyOptions

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;
            using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.IAM;
            using Amazon.CDK.Interfaces.KMS;

            DockerImage dockerImage;
            IGrantable grantable;
            InitServiceRestartHandle initServiceRestartHandle;
            IKeyRef keyRef;
            ILocalBundling localBundling;

            var initSourceAssetOptions = new InitSourceAssetOptions {
                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"
                },
                DeployTime = false,
                DisplayName = "displayName",
                Exclude = new [] { "exclude" },
                FollowSymlinks = SymlinkFollowMode.NEVER,
                IgnoreMode = IgnoreMode.GLOB,
                Readers = new [] { grantable },
                ServiceRestartHandles = new [] { initServiceRestartHandle },
                SourceKMSKey = keyRef
            };

Synopsis

Constructors

InitSourceAssetOptions()

Additional options for an InitSource that builds an asset from local files.

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.
DeployTime	Whether or not the asset needs to exist beyond deployment time;
DisplayName	A display name for this asset.
Exclude	File paths matching the patterns will be excluded.
FollowSymlinks	A strategy for how to handle symlinks.
IgnoreMode	The ignore behavior to use for exclude patterns.
Readers	A list of principals that should be able to read this asset from S3.
ServiceRestartHandles	Restart the given services after this archive has been extracted.
SourceKMSKey	The ARN of the KMS key used to encrypt the handler code.

Constructors

InitSourceAssetOptions()

Additional options for an InitSource that builds an asset from local files.

public InitSourceAssetOptions()

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;
            using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.IAM;
            using Amazon.CDK.Interfaces.KMS;

            DockerImage dockerImage;
            IGrantable grantable;
            InitServiceRestartHandle initServiceRestartHandle;
            IKeyRef keyRef;
            ILocalBundling localBundling;

            var initSourceAssetOptions = new InitSourceAssetOptions {
                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"
                },
                DeployTime = false,
                DisplayName = "displayName",
                Exclude = new [] { "exclude" },
                FollowSymlinks = SymlinkFollowMode.NEVER,
                IgnoreMode = IgnoreMode.GLOB,
                Readers = new [] { grantable },
                ServiceRestartHandles = new [] { initServiceRestartHandle },
                SourceKMSKey = keyRef
            };

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

DeployTime

Whether or not the asset needs to exist beyond deployment time;

public bool? DeployTime { get; set; }

Property Value

bool?

Remarks

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

DisplayName

A display name for this asset.

public string? DisplayName { get; set; }

Property Value

string

Remarks

If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used.

The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as lambda.Code.fromAsset()), this will look like MyFunction/Code.

We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like /MyBetaStack/MyFunction/Code when you are actually deploying to production.

Default: - Stack-relative construct path

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

FollowSymlinks

A strategy for how to handle symlinks.

public SymlinkFollowMode? FollowSymlinks { 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

Readers

A list of principals that should be able to read this asset from S3.

public IGrantable[]? Readers { get; set; }

Property Value

IGrantable[]

Remarks

You can use asset.grantRead(principal) to grant read permissions later.

Default: - No principals that can read file asset.

ServiceRestartHandles

Restart the given services after this archive has been extracted.

public InitServiceRestartHandle[]? ServiceRestartHandles { get; set; }

Property Value

InitServiceRestartHandle[]

Remarks

Default: - Do not restart any service

SourceKMSKey

The ARN of the KMS key used to encrypt the handler code.

public IKeyRef? SourceKMSKey { get; set; }

Property Value

IKeyRef

Remarks

Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.

Implements

IInitSourceAssetOptions

IInitSourceOptions

IAssetOptions

IAssetOptions

IFileCopyOptions