Skip to content

AssetOptions

Asset hash options.

Initializer 

import ros_cdk_core
ros_cdk_core.AssetOptions(
  asset_hash: str = None,
  asset_hash_type: AssetHashType = None,
  bundling: BundlingOptions = None
)

Properties

Name Type Description
asset_hash str Specify a custom hash for this asset.
asset_hash_type 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.

asset_hashOptional 

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_typeOptional 

asset_hash_type: 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.

bundlingOptional 

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.