InitSourceAssetOptions

class aws_cdk.aws_ec2.InitSourceAssetOptions(*, service_restart_handles=None, exclude=None, follow=None, ignore_mode=None, follow_symlinks=None, asset_hash=None, asset_hash_type=None, bundling=None, readers=None, source_hash=None)

Bases: InitSourceOptions, AssetOptions

Additional options for an InitSource that builds an asset from local files.

Parameters

service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given services after this archive has been extracted. Default: - Do not restart any service
exclude (Optional[Sequence[str]]) – Glob patterns to exclude from the copy. Default: - nothing is excluded
follow (Optional[FollowMode]) – (deprecated) A strategy for how to handle symlinks. Default: Never
ignore_mode (Optional[IgnoreMode]) – The ignore behavior to use for exclude patterns. Default: IgnoreMode.GLOB
follow_symlinks (Optional[SymlinkFollowMode]) – A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVER
asset_hash (Optional[str]) – 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 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
asset_hash_type (Optional[AssetHashType]) – Specifies the type of hash to calculate for this asset. 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 (Union[BundlingOptions, Dict[str, Any], None]) – 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. 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
readers (Optional[Sequence[IGrantable]]) – A list of principals that should be able to read this asset from S3. You can use asset.grantRead(principal) to grant read permissions later. Default: - No principals that can read file asset.
source_hash (Optional[str]) – (deprecated) Custom hash to use when identifying the specific version of the asset. 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.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.assets as assets
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_iam as iam
import aws_cdk.core as cdk

# docker_image: cdk.DockerImage
# grantable: iam.IGrantable
# init_service_restart_handle: ec2.InitServiceRestartHandle
# local_bundling: cdk.ILocalBundling

init_source_asset_options = ec2.InitSourceAssetOptions(
    asset_hash="assetHash",
    asset_hash_type=cdk.AssetHashType.SOURCE,
    bundling=cdk.BundlingOptions(
        image=docker_image,

        # the properties below are optional
        command=["command"],
        entrypoint=["entrypoint"],
        environment={
            "environment_key": "environment"
        },
        local=local_bundling,
        output_type=cdk.BundlingOutput.ARCHIVED,
        security_opt="securityOpt",
        user="user",
        volumes=[cdk.DockerVolume(
            container_path="containerPath",
            host_path="hostPath",

            # the properties below are optional
            consistency=cdk.DockerVolumeConsistency.CONSISTENT
        )],
        working_directory="workingDirectory"
    ),
    exclude=["exclude"],
    follow=assets.FollowMode.NEVER,
    follow_symlinks=cdk.SymlinkFollowMode.NEVER,
    ignore_mode=cdk.IgnoreMode.GLOB,
    readers=[grantable],
    service_restart_handles=[init_service_restart_handle],
    source_hash="sourceHash"
)

Attributes

asset_hash

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 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

Return type

Optional[str]

asset_hash_type

Specifies the type of hash to calculate for this asset.

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.

Return type: Optional[AssetHashType]

bundling

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.

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

Return type: Optional[BundlingOptions]

exclude

Glob patterns to exclude from the copy.

Default

nothing is excluded

Return type

Optional[List[str]]

follow

(deprecated) A strategy for how to handle symlinks.

Default: Never
Deprecated: use followSymlinks instead
Stability: deprecated
Return type: Optional[FollowMode]

follow_symlinks

A strategy for how to handle symlinks.

Default: SymlinkFollowMode.NEVER
Return type: Optional[SymlinkFollowMode]

ignore_mode

The ignore behavior to use for exclude patterns.

Default: IgnoreMode.GLOB
Return type: Optional[IgnoreMode]

readers

A list of principals that should be able to read this asset from S3.

You can use asset.grantRead(principal) to grant read permissions later.

Default

No principals that can read file asset.

Return type

Optional[List[IGrantable]]

service_restart_handles

Restart the given services after this archive has been extracted.

Default

Do not restart any service

Return type

Optional[List[InitServiceRestartHandle]]

source_hash

(deprecated) Custom hash to use when identifying the specific version of the asset.

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.

Deprecated: see assetHash and assetHashType
Stability: deprecated
Return type: Optional[str]