AssetOptions

Initializer

import ros_cdk_ossassets
ros_cdk_ossassets.AssetOptions(
  exclude: typing.List[str] = None,
  follow_symlinks: SymlinkFollowMode = None,
  ignore_mode: IgnoreMode = None,
  asset_hash: str = None,
  asset_hash_type: AssetHashType = None,
  bundling: BundlingOptions = None,
  deploy_time: bool = None
)

Properties

Name	Type	Description
exclude	typing.List[str]	File paths matching the patterns will be excluded.
follow_symlinks	ros_cdk_core.SymlinkFollowMode	A strategy for how to handle symlinks.
ignore_mode	ros_cdk_core.IgnoreMode	The ignore behavior to use for exclude patterns.
asset_hash	str	Specify a custom hash for this asset.
asset_hash_type	ros_cdk_core.AssetHashType	Specifies the type of hash to calculate for this asset.
bundling	ros_cdk_core.BundlingOptions	Bundle the asset by executing a command in a Docker container or a custom bundling provider.
deploy_time	bool	Whether or not the asset needs to exist beyond deployment time;

---

exclude^Optional

exclude: typing.List[str]

• Type: typing.List[str]
• 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_symlinks^Optional

follow_symlinks: SymlinkFollowMode

• Type: ros_cdk_core.SymlinkFollowMode
• Default: SymlinkFollowMode.NEVER

A strategy for how to handle symlinks.

---

ignore_mode^Optional

ignore_mode: IgnoreMode

• Type: ros_cdk_core.IgnoreMode
• Default: IgnoreMode.GLOB

The ignore behavior to use for exclude patterns.

---

asset_hash^Optional

asset_hash: str

• Type: str
• 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.

---

asset_hash_type^Optional

asset_hash_type: AssetHashType

• Type: ros_cdk_core.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

bundling: BundlingOptions

• Type: ros_cdk_core.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.

---

deploy_time^Optional

deploy_time: bool

• Type: bool
• Default: false

Whether or not the asset needs to exist beyond deployment time;

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 ROS deployment succeeds.

For example, FC Function assets are copied over to Function during deployment. Therefore, it is not necessary to store the asset in OSS bucket, so we consider those deployTime assets.

---