Class InitFileAssetOptions
Additional options for creating an InitFile from an asset.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class InitFileAssetOptions : Object, IInitFileAssetOptions, IInitFileOptions, IAssetOptions, ICopyOptions, IFileCopyOptions, IAssetOptions
Syntax (vb)
Public Class InitFileAssetOptions
Inherits Object
Implements IInitFileAssetOptions, IInitFileOptions, IAssetOptions, ICopyOptions, IFileCopyOptions, 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.Assets;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK;
DockerImage dockerImage;
IGrantable grantable;
InitServiceRestartHandle initServiceRestartHandle;
ILocalBundling localBundling;
var initFileAssetOptions = new InitFileAssetOptions {
AssetHash = "assetHash",
AssetHashType = AssetHashType.SOURCE,
Base64Encoded = false,
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"
},
Exclude = new [] { "exclude" },
Follow = FollowMode.NEVER,
FollowSymlinks = SymlinkFollowMode.NEVER,
Group = "group",
IgnoreMode = IgnoreMode.GLOB,
Mode = "mode",
Owner = "owner",
Readers = new [] { grantable },
ServiceRestartHandles = new [] { initServiceRestartHandle },
SourceHash = "sourceHash"
};
Synopsis
Constructors
InitFileAssetOptions() |
Properties
AssetHash | Specify a custom hash for this asset. |
AssetHashType | Specifies the type of hash to calculate for this asset. |
Base64Encoded | True if the inlined content (from a string or file) should be treated as base64 encoded. |
Bundling | Bundle the asset by executing a command in a Docker container or a custom bundling provider. |
Exclude | (deprecated) Glob patterns to exclude from the copy. |
Follow | (deprecated) A strategy for how to handle symlinks. |
FollowSymlinks | A strategy for how to handle symlinks. |
Group | The name of the owning group for this file. |
IgnoreMode | (deprecated) The ignore behavior to use for exclude patterns. |
Mode | A six-digit octal value representing the mode for this file. |
Owner | The name of the owning user for this file. |
Readers | A list of principals that should be able to read this asset from S3. |
ServiceRestartHandles | Restart the given service after this file has been written. |
SourceHash | (deprecated) Custom hash to use when identifying the specific version of the asset. |
Constructors
InitFileAssetOptions()
public InitFileAssetOptions()
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
.
Base64Encoded
True if the inlined content (from a string or file) should be treated as base64 encoded.
public Nullable<bool> Base64Encoded { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Only applicable for inlined string and file content.
Default: false
Bundling
Bundle the asset by executing a command in a Docker container or a custom bundling provider.
public IBundlingOptions Bundling { get; set; }
Property Value
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
(deprecated) Glob patterns to exclude from the copy.
public string[] Exclude { get; set; }
Property Value
System.String[]
Remarks
Default: nothing is excluded
Stability: Deprecated
Follow
(deprecated) A strategy for how to handle symlinks.
public Nullable<FollowMode> Follow { get; set; }
Property Value
System.Nullable<FollowMode>
Remarks
Default: Never
Stability: Deprecated
FollowSymlinks
A strategy for how to handle symlinks.
public Nullable<SymlinkFollowMode> FollowSymlinks { get; set; }
Property Value
System.Nullable<SymlinkFollowMode>
Remarks
Default: SymlinkFollowMode.NEVER
Group
The name of the owning group for this file.
public string Group { get; set; }
Property Value
System.String
Remarks
Not supported for Windows systems.
Default: 'root'
IgnoreMode
(deprecated) The ignore behavior to use for exclude patterns.
public Nullable<IgnoreMode> IgnoreMode { get; set; }
Property Value
System.Nullable<IgnoreMode>
Remarks
Default: - GLOB for file assets, DOCKER or GLOB for docker assets depending on whether the '
Stability: Deprecated
Aws-cdk: /aws-ecr-assets:dockerIgnoreSupport' flag is set.
Mode
A six-digit octal value representing the mode for this file.
public string Mode { get; set; }
Property Value
System.String
Remarks
Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644.
Not supported for Windows systems.
Default: '000644'
Owner
The name of the owning user for this file.
public string Owner { get; set; }
Property Value
System.String
Remarks
Not supported for Windows systems.
Default: 'root'
Readers
A list of principals that should be able to read this asset from S3.
public IGrantable[] Readers { get; set; }
Property Value
Remarks
You can use asset.grantRead(principal)
to grant read permissions later.
Default: - No principals that can read file asset.
ServiceRestartHandles
Restart the given service after this file has been written.
public InitServiceRestartHandle[] ServiceRestartHandles { get; set; }
Property Value
Remarks
Default: - Do not restart any service
SourceHash
(deprecated) Custom hash to use when identifying the specific version of the asset.
public string SourceHash { get; set; }
Property Value
System.String
Remarks
For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.
NOTE: the source 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 source hash, you will need to make sure it is updated every time the source changes, or otherwise it is possible that some deployments will not be invalidated.
Default: - automatically calculate source hash based on the contents of the source file or directory.
Stability: Deprecated