CloudFormationTemplate
- class aws_cdk.aws_servicecatalog.CloudFormationTemplate
Bases:
object
Represents the Product Provisioning Artifact Template.
- ExampleMetadata:
infused
Example:
import aws_cdk as cdk class S3BucketProduct(servicecatalog.ProductStack): def __init__(self, scope, id): super().__init__(scope, id) s3.Bucket(self, "BucketProduct") product = servicecatalog.CloudFormationProduct(self, "Product", product_name="My Product", owner="Product Owner", product_versions=[servicecatalog.CloudFormationProductVersion( product_version_name="v1", cloud_formation_template=servicecatalog.CloudFormationTemplate.from_product_stack(S3BucketProduct(self, "S3BucketProduct")) ) ] )
Methods
- abstract bind(scope)
Called when the product is initialized to allow this object to bind to the stack, add resources and have fun.
- Parameters:
scope (
Construct
) – The binding scope. Don’t be smart about trying to down-cast or assume it’s initialized. You may just use it as a construct scope.- Return type:
Static Methods
- 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 provisioning artifacts template from a local disk path.
- Parameters:
path (
str
) – A file containing the provisioning artifacts.deploy_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.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.GLOB
- Return type:
- classmethod from_product_stack(product_stack)
Creates a product with the resources defined in the given product stack.
- Parameters:
product_stack (
ProductStack
) –- Return type:
- classmethod from_url(url)
Template from URL.
- Parameters:
url (
str
) – The url that points to the provisioning artifacts template.- Return type: