CfnCloudFormationProduct
- class aws_cdk.aws_servicecatalog.CfnCloudFormationProduct(scope, id, *, name, owner, accept_language=None, description=None, distributor=None, product_type=None, provisioning_artifact_parameters=None, replace_provisioning_artifacts=None, source_connection=None, support_description=None, support_email=None, support_url=None, tags=None)
Bases:
CfnResourceA CloudFormation
AWS::ServiceCatalog::CloudFormationProduct.Specifies a product.
- CloudformationResource:
AWS::ServiceCatalog::CloudFormationProduct
- Link:
- 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.aws_servicecatalog as servicecatalog # info: Any cfn_cloud_formation_product = servicecatalog.CfnCloudFormationProduct(self, "MyCfnCloudFormationProduct", name="name", owner="owner", # the properties below are optional accept_language="acceptLanguage", description="description", distributor="distributor", product_type="productType", provisioning_artifact_parameters=[servicecatalog.CfnCloudFormationProduct.ProvisioningArtifactPropertiesProperty( info=info, # the properties below are optional description="description", disable_template_validation=False, name="name", type="type" )], replace_provisioning_artifacts=False, source_connection=servicecatalog.CfnCloudFormationProduct.SourceConnectionProperty( connection_parameters=servicecatalog.CfnCloudFormationProduct.ConnectionParametersProperty( code_star=servicecatalog.CfnCloudFormationProduct.CodeStarParametersProperty( artifact_path="artifactPath", branch="branch", connection_arn="connectionArn", repository="repository" ) ), type="type" ), support_description="supportDescription", support_email="supportEmail", support_url="supportUrl", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::ServiceCatalog::CloudFormationProduct.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
name (
str) – The name of the product.owner (
str) – The owner of the product.accept_language (
Optional[str]) – The language code. -jp- Japanese -zh- Chinesedescription (
Optional[str]) – The description of the product.distributor (
Optional[str]) – The distributor of the product.product_type (
Optional[str]) – The type of product.provisioning_artifact_parameters (
Union[IResolvable,Sequence[Union[IResolvable,ProvisioningArtifactPropertiesProperty,Dict[str,Any]]],None]) – The configuration of the provisioning artifact (also known as a version).replace_provisioning_artifacts (
Union[bool,IResolvable,None]) – This property is turned off by default. If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name. If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.source_connection (
Union[IResolvable,SourceConnectionProperty,Dict[str,Any],None]) – A top levelProductViewDetailresponse containing details about the product’s connection. AWS Service Catalog returns this field for theCreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse.support_description (
Optional[str]) – The support information about the product.support_email (
Optional[str]) – The contact email for product support.support_url (
Optional[str]) – The contact URL for product support.^https?:\/\/// is the pattern used to validate SupportUrl.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – One or more tags.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::ServiceCatalog::CloudFormationProduct'
- accept_language
The language code.
jp- Japanesezh- Chinese
- attr_product_name
The name of the product.
- CloudformationAttribute:
ProductName
- attr_provisioning_artifact_ids
The IDs of the provisioning artifacts.
- CloudformationAttribute:
ProvisioningArtifactIds
- attr_provisioning_artifact_names
The names of the provisioning artifacts.
- CloudformationAttribute:
ProvisioningArtifactNames
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
The description of the product.
- distributor
The distributor of the product.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the product.
- node
The construct tree node associated with this construct.
- owner
The owner of the product.
- product_type
The type of product.
- provisioning_artifact_parameters
The configuration of the provisioning artifact (also known as a version).
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- replace_provisioning_artifacts
This property is turned off by default.
If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name.
If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.
- source_connection
A top level
ProductViewDetailresponse containing details about the product’s connection.AWS Service Catalog returns this field for the
CreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- support_description
The support information about the product.
- support_email
The contact email for product support.
- support_url
The contact URL for product support.
^https?:\/\/// is the pattern used to validate SupportUrl.
- tags
One or more tags.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct)- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any)- Return type:
bool
CodeStarParametersProperty
- class CfnCloudFormationProduct.CodeStarParametersProperty(*, artifact_path, branch, connection_arn, repository)
Bases:
objectThe subtype containing details about the Codestar connection
Type.- Parameters:
artifact_path (
str) – The absolute path wehre the artifact resides within the repo and branch, formatted as “folder/file.json.”.branch (
str) – The specific branch where the artifact resides.connection_arn (
str) – The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.repository (
str) – The specific repository where the product’s artifact-to-be-synced resides, formatted as “Account/Repo.”.
- Link:
- 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.aws_servicecatalog as servicecatalog code_star_parameters_property = servicecatalog.CfnCloudFormationProduct.CodeStarParametersProperty( artifact_path="artifactPath", branch="branch", connection_arn="connectionArn", repository="repository" )
Attributes
- artifact_path
The absolute path wehre the artifact resides within the repo and branch, formatted as “folder/file.json.”.
- branch
The specific branch where the artifact resides.
- connection_arn
The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.
- repository
The specific repository where the product’s artifact-to-be-synced resides, formatted as “Account/Repo.”.
ConnectionParametersProperty
- class CfnCloudFormationProduct.ConnectionParametersProperty(*, code_star=None)
Bases:
objectProvides connection details.
- Parameters:
code_star (
Union[IResolvable,CodeStarParametersProperty,Dict[str,Any],None]) – ProvidesConnectionTypedetails.- Link:
- 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.aws_servicecatalog as servicecatalog connection_parameters_property = servicecatalog.CfnCloudFormationProduct.ConnectionParametersProperty( code_star=servicecatalog.CfnCloudFormationProduct.CodeStarParametersProperty( artifact_path="artifactPath", branch="branch", connection_arn="connectionArn", repository="repository" ) )
Attributes
ProvisioningArtifactPropertiesProperty
- class CfnCloudFormationProduct.ProvisioningArtifactPropertiesProperty(*, info, description=None, disable_template_validation=None, name=None, type=None)
Bases:
objectInformation about a provisioning artifact (also known as a version) for a product.
- Parameters:
info (
Any) – Specify the template source with one of the following options, but not both. Keys accepted: [LoadTemplateFromURL,ImportFromPhysicalId] The URL of the AWS CloudFormation template in Amazon S3 in JSON format. Specify the URL in JSON format as follows:"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports AWS CloudFormation stack arn. Specify the physical id in JSON format as follows:ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]description (
Optional[str]) – The description of the provisioning artifact, including how it differs from the previous provisioning artifact.disable_template_validation (
Union[bool,IResolvable,None]) – If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.name (
Optional[str]) – The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.type (
Optional[str]) – The type of provisioning artifact. -CLOUD_FORMATION_TEMPLATE- AWS CloudFormation template -MARKETPLACE_AMI- AWS Marketplace AMI -MARKETPLACE_CAR- AWS Marketplace Clusters and AWS Resources -TERRAFORM_OPEN_SOURCE- Terraform open source configuration file
- Link:
- 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.aws_servicecatalog as servicecatalog # info: Any provisioning_artifact_properties_property = servicecatalog.CfnCloudFormationProduct.ProvisioningArtifactPropertiesProperty( info=info, # the properties below are optional description="description", disable_template_validation=False, name="name", type="type" )
Attributes
- description
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
- disable_template_validation
If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
- info
Specify the template source with one of the following options, but not both.
Keys accepted: [
LoadTemplateFromURL,ImportFromPhysicalId]The URL of the AWS CloudFormation template in Amazon S3 in JSON format. Specify the URL in JSON format as follows:
"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports AWS CloudFormation stack arn. Specify the physical id in JSON format as follows:ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]
- name
The name of the provisioning artifact (for example, v1 v2beta).
No spaces are allowed.
- type
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE- AWS CloudFormation templateMARKETPLACE_AMI- AWS Marketplace AMIMARKETPLACE_CAR- AWS Marketplace Clusters and AWS ResourcesTERRAFORM_OPEN_SOURCE- Terraform open source configuration file
SourceConnectionProperty
- class CfnCloudFormationProduct.SourceConnectionProperty(*, connection_parameters, type)
Bases:
objectA top level
ProductViewDetailresponse containing details about the product’s connection.AWS Service Catalog returns this field for the
CreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse.- Parameters:
connection_parameters (
Union[IResolvable,ConnectionParametersProperty,Dict[str,Any]]) – The connection details based on the connectionType.type (
str) – The only supportedSourceConnectiontype is Codestar.
- Link:
- 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.aws_servicecatalog as servicecatalog source_connection_property = servicecatalog.CfnCloudFormationProduct.SourceConnectionProperty( connection_parameters=servicecatalog.CfnCloudFormationProduct.ConnectionParametersProperty( code_star=servicecatalog.CfnCloudFormationProduct.CodeStarParametersProperty( artifact_path="artifactPath", branch="branch", connection_arn="connectionArn", repository="repository" ) ), type="type" )
Attributes
- connection_parameters
The connection details based on the connection
Type.
- type
The only supported
SourceConnectiontype is Codestar.