- class aws_cdk.aws_ecs.S3EnvironmentFile(bucket, key, object_version=None)
Environment file from S3.
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs from aws_cdk import aws_s3 as s3 # bucket: s3.Bucket s3_environment_file = ecs.S3EnvironmentFile(bucket, "key", "objectVersion")
Called when the container is initialized to allow this object to bind to the stack.
- classmethod from_asset(path, *, deploy_time=None, readers=None, asset_hash=None, asset_hash_type=None, bundling=None, exclude=None, follow_symlinks=None, ignore_mode=None)
Loads the environment file from a local disk path.
str) – Local disk path.
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: false
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.
str]) – Specify a custom hash for this asset. If
assetHashTypeis 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]) – Specifies the type of hash to calculate for this asset. If
assetHashis configured, this option must be
AssetHashType.CUSTOM. Default: - the default is
AssetHashType.SOURCE, but if
assetHashis explicitly specified this value defaults to
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-outputwill 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
str]]) – File paths matching the patterns will be excluded. See
ignoreModeto set the matching behavior. Has no effect on Assets bundled using the
bundlingproperty. Default: - nothing is excluded
SymlinkFollowMode]) – A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVER
IgnoreMode]) – The ignore behavior to use for
excludepatterns. Default: IgnoreMode.GLOB
- Return type:
- classmethod from_bucket(bucket, key, object_version=None)
Loads the environment file from an S3 bucket.