CustomCommandOptions
- class aws_cdk.aws_lambda.CustomCommandOptions(*, asset_hash=None, asset_hash_type=None, bundling=None, exclude=None, follow_symlinks=None, ignore_mode=None, deploy_time=None, readers=None, command_options=None)
Bases:
AssetOptions
Options for creating
AssetCode
with a custom command, such as running a buildfile.- Parameters:
asset_hash (
Optional
[str
]) – Specify a custom hash for this asset. IfassetHashType
is set it must be set toAssetHashType.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 onassetHashType
asset_hash_type (
Optional
[AssetHashType
]) – Specifies the type of hash to calculate for this asset. IfassetHash
is configured, this option must beundefined
orAssetHashType.CUSTOM
. Default: - the default isAssetHashType.SOURCE
, but ifassetHash
is explicitly specified this value defaults toAssetHashType.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 otherwiseexclude (
Optional
[Sequence
[str
]]) – File paths matching the patterns will be excluded. SeeignoreMode
to set the matching behavior. Has no effect on Assets bundled using thebundling
property. Default: - nothing is excludedfollow_symlinks (
Optional
[SymlinkFollowMode
]) – A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVERignore_mode (
Optional
[IgnoreMode
]) – The ignore behavior to use forexclude
patterns. Default: IgnoreMode.GLOBdeploy_time (
Optional
[bool
]) – 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 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: falsereaders (
Optional
[Sequence
[IGrantable
]]) – A list of principals that should be able to read this asset from S3. You can useasset.grantRead(principal)
to grant read permissions later. Default: - No principals that can read file asset.command_options (
Optional
[Mapping
[str
,Any
]]) – options that are passed to the spawned process, which determine the characteristics of the spawned process. Default: : seechild_process.SpawnSyncOptions
(https://nodejs.org/api/child_process.html#child_processspawnsynccommand-args-options).
- 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 as cdk from aws_cdk import aws_iam as iam from aws_cdk import aws_lambda as lambda_ # command_options: Any # docker_image: cdk.DockerImage # grantable: iam.IGrantable # local_bundling: cdk.ILocalBundling custom_command_options = lambda.CustomCommandOptions( asset_hash="assetHash", asset_hash_type=cdk.AssetHashType.SOURCE, bundling=cdk.BundlingOptions( image=docker_image, # the properties below are optional bundling_file_access=cdk.BundlingFileAccess.VOLUME_COPY, command=["command"], entrypoint=["entrypoint"], environment={ "environment_key": "environment" }, local=local_bundling, network="network", output_type=cdk.BundlingOutput.ARCHIVED, platform="platform", security_opt="securityOpt", user="user", volumes=[cdk.DockerVolume( container_path="containerPath", host_path="hostPath", # the properties below are optional consistency=cdk.DockerVolumeConsistency.CONSISTENT )], volumes_from=["volumesFrom"], working_directory="workingDirectory" ), command_options={ "command_options_key": command_options }, deploy_time=False, exclude=["exclude"], follow_symlinks=cdk.SymlinkFollowMode.NEVER, ignore_mode=cdk.IgnoreMode.GLOB, readers=[grantable] )
Attributes
- asset_hash
Specify a custom hash for this asset.
If
assetHashType
is set it must be set toAssetHashType.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
Specifies the type of hash to calculate for this asset.
If
assetHash
is configured, this option must beundefined
orAssetHashType.CUSTOM
.- Default:
the default is
AssetHashType.SOURCE
, but ifassetHash
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.
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
- command_options
options that are passed to the spawned process, which determine the characteristics of the spawned process.
- Default:
: see
child_process.SpawnSyncOptions
(https://nodejs.org/api/child_process.html#child_processspawnsynccommand-args-options).
- deploy_time
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 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.
See
ignoreMode
to set the matching behavior. Has no effect on Assets bundled using thebundling
property.- Default:
nothing is excluded
- follow_symlinks
A strategy for how to handle symlinks.
- Default:
SymlinkFollowMode.NEVER
- ignore_mode
The ignore behavior to use for
exclude
patterns.- Default:
IgnoreMode.GLOB
- 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.