Class AssetProps
Inheritance
Namespace: Amazon.CDK.AWS.S3.Assets
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AssetProps : Object, IAssetProps, IAssetOptions, IAssetOptions, IFileCopyOptions
Syntax (vb)
Public Class AssetProps
Inherits Object
Implements IAssetProps, IAssetOptions, IAssetOptions, IFileCopyOptions
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK;
var asset = new Asset(this, "BundledAsset", new AssetProps {
Path = "/path/to/asset",
Bundling = new BundlingOptions {
Image = DockerImage.FromRegistry("alpine"),
Command = new [] { "command-that-produces-an-archive.sh" },
OutputType = BundlingOutput.NOT_ARCHIVED
}
});
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. |
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 |
Path | The disk location of the asset. |
Readers | A list of principals that should be able to read this asset from S3. |
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
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
FollowSymlinks
A strategy for how to handle symlinks.
public Nullable<SymlinkFollowMode> FollowSymlinks { get; set; }
Property Value
System.Nullable<SymlinkFollowMode>
Remarks
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
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.