Class AssetProps
Inheritance
Namespace: Amazon.CDK.AWS.S3.Assets
Assembly: Amazon.CDK.AWS.S3.Assets.dll
Syntax (csharp)
public class AssetProps : Object, IAssetProps, IAssetOptions, ICopyOptions, IFileCopyOptions, IAssetOptions
Syntax (vb)
Public Class AssetProps
Inherits Object
Implements IAssetProps, IAssetOptions, ICopyOptions, IFileCopyOptions, IAssetOptions
Remarks
ExampleMetadata: lit=test/integ.assets.bundling.lit.ts infused
Examples
var asset = new Asset(this, "BundledAsset", new AssetProps {
Path = Join(__dirname, "markdown-asset"), // /asset-input and working directory in the container
Bundling = new BundlingOptions {
Image = DockerImage.FromBuild(Join(__dirname, "alpine-markdown")), // Build an image
Command = new [] { "sh", "-c", @"
markdown index.md > /asset-output/index.html
" }
}
});
Synopsis
Constructors
AssetProps() |
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 | (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. |
IgnoreMode | (deprecated) The ignore behavior to use for exclude patterns. |
Path | The disk location of the asset. |
Readers | A list of principals that should be able to read this asset from S3. |
SourceHash | (deprecated) Custom hash to use when identifying the specific version of the asset. |
Constructors
AssetProps()
public AssetProps()
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
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
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.
Path
The disk location of the asset.
public string Path { get; set; }
Property Value
System.String
Remarks
The path should refer to one of the following:
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.
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