ServiceCatalogDeployActionProps¶

class aws_cdk.aws_codepipeline_actions.ServiceCatalogDeployActionProps(*, action_name, run_order=None, variables_namespace=None, role=None, product_id, product_version_name, template_path, product_version_description=None)¶

Bases: aws_cdk.aws_codepipeline.CommonAwsActionProps

(experimental) Construction properties of the {@link ServiceCatalogDeployAction ServiceCatalog deploy CodePipeline Action}.

Note: this API is still experimental, and may have breaking changes in the future!

Parameters

action_name (str) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.
run_order (Union[int, float, None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1
variables_namespace (Optional[str]) – The name of the namespace to use for variables emitted by this action. Default: - a name will be generated, based on the stage and action names, if any of the action’s variables were referenced - otherwise, no namespace will be set
role (Optional[IRole]) – The Role in which context’s this Action will be executing in. The Pipeline’s Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property. Default: a new Role will be generated
product_id (str) – (experimental) The identifier of the product in the Service Catalog. This product must already exist.
product_version_name (str) – (experimental) The name of the version of the Service Catalog product to be deployed.
template_path (ArtifactPath) – (experimental) The path to the cloudformation artifact.
product_version_description (Optional[str]) – (experimental) The optional description of this version of the Service Catalog product. Default: ‘’

Stability

experimental

Attributes

action_name¶

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

Return type: str

product_id¶

(experimental) The identifier of the product in the Service Catalog.

This product must already exist.

Stability: experimental
Return type: str

product_version_description¶

(experimental) The optional description of this version of the Service Catalog product.

Default: ‘’
Stability: experimental
Return type: Optional[str]

product_version_name¶

(experimental) The name of the version of the Service Catalog product to be deployed.

Stability: experimental
Return type: str

role¶

The Role in which context’s this Action will be executing in.

The Pipeline’s Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated
Return type: Optional[IRole]

run_order¶

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default: 1
See: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
Return type: Union[int, float, None]

template_path¶

(experimental) The path to the cloudformation artifact.

Stability: experimental
Return type: ArtifactPath

variables_namespace¶

The name of the namespace to use for variables emitted by this action.

Default

a name will be generated, based on the stage and action names,

if any of the action’s variables were referenced - otherwise, no namespace will be set

Return type: Optional[str]