Class InitSourceAssetOptions

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

Inheritance
System.Object
InitSourceAssetOptions
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class InitSourceAssetOptions : Object, IInitSourceAssetOptions, IInitSourceOptions, IAssetOptions, IAssetOptions, IFileCopyOptions
Syntax (vb)
Public Class InitSourceAssetOptions
    Inherits Object
    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.AWS.KMS;

DockerImage dockerImage;
IGrantable grantable;
InitServiceRestartHandle initServiceRestartHandle;
Key key;
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,
    Exclude = new [] { "exclude" },
    FollowSymlinks = SymlinkFollowMode.NEVER,
    IgnoreMode = IgnoreMode.GLOB,
    Readers = new [] { grantable },
    ServiceRestartHandles = new [] { initServiceRestartHandle },
    SourceKMSKey = key
};

Synopsis

Constructors

InitSourceAssetOptions()

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;
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()

public InitSourceAssetOptions()

Properties

AssetHash

Specify a custom hash for this asset.

public string AssetHash { get; set; }
Property Value

System.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 Nullable<AssetHashType> AssetHashType { get; set; }
Property Value

System.Nullable<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 Nullable<bool> DeployTime { get; set; }
Property Value

System.Nullable<System.Boolean>

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

Exclude

File paths matching the patterns will be excluded.

public string[] Exclude { get; set; }
Property Value

System.String[]

Remarks

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

Default: - nothing is excluded

A strategy for how to handle symlinks.

public Nullable<SymlinkFollowMode> FollowSymlinks { get; set; }
Property Value

System.Nullable<SymlinkFollowMode>

Default: SymlinkFollowMode.NEVER

IgnoreMode

The ignore behavior to use for exclude patterns.

public Nullable<IgnoreMode> IgnoreMode { get; set; }
Property Value

System.Nullable<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 IKey SourceKMSKey { get; set; }
Property Value

IKey

Remarks

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

Implements