AssetStagingProps

Initialization properties for AssetStaging.

Initializer

import { AssetStagingProps } from '@alicloud/ros-cdk-core'
const assetStagingProps: AssetStagingProps = { ... }

Properties

Name	Type	Description
exclude	string[]	File paths matching the patterns will be excluded.
follow	SymlinkFollowMode	A strategy for how to handle symlinks.
ignoreMode	IgnoreMode	The ignore behavior to use for exclude patterns.
extraHash	string	Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
assetHash	string	Specify a custom hash for this asset.
assetHashType	AssetHashType	Specifies the type of hash to calculate for this asset.
bundling	BundlingOptions	Bundle the asset by executing a command in a Docker container or a custom bundling provider.
sourcePath	string	The source file or directory to copy from.

---

exclude^Optional

public readonly exclude: string[];

• Type: string[]
• Default: nothing is excluded

File paths matching the patterns will be excluded.

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

---

follow^Optional

public readonly follow: SymlinkFollowMode;

• Type: SymlinkFollowMode
• Default: SymlinkFollowMode.NEVER

A strategy for how to handle symlinks.

---

ignoreMode^Optional

public readonly ignoreMode: IgnoreMode;

• Type: IgnoreMode
• Default: IgnoreMode.GLOB

The ignore behavior to use for exclude patterns.

---

extraHash^Optional

public readonly extraHash: string;

• Type: string
• Default: hash is only based on source content

Extra information to encode into the fingerprint (e.g. build instructions and other inputs).

---

assetHash^Optional

public readonly assetHash: string;

• Type: string
• Default: based on assetHashType

Specify a custom hash for this asset.

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 OSS bucket, 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.

---

assetHashType^Optional

public readonly assetHashType: AssetHashType;

• Type: AssetHashType
• Default: the default is AssetHashType.SOURCE, but if assetHash is explicitly specified this value defaults to AssetHashType.CUSTOM.

Specifies the type of hash to calculate for this asset.

If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM.

---

bundling^Optional

public readonly bundling: BundlingOptions;

• Type: BundlingOptions
• Default: uploaded as-is to OSS bucket if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to OSS bucket otherwise.

Bundle the asset by executing a command in a Docker container or a custom bundling provider.

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.

---

sourcePath^Required

public readonly sourcePath: string;

• Type: string

The source file or directory to copy from.

---