ServiceCatalogDeployActionBeta1Props

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

Bases: CommonAwsActionProps

Construction properties of the ServiceCatalogDeployActionBeta1 ServiceCatalog deploy CodePipeline Action.

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 IAction.bind method in the ActionBindOptions.role property. Default: a new Role will be generated

  • product_id (str) – The identifier of the product in the Service Catalog. This product must already exist.

  • product_version_name (str) – The name of the version of the Service Catalog product to be deployed.

  • template_path (ArtifactPath) – The path to the cloudformation artifact.

  • product_version_description (Optional[str]) – The optional description of this version of the Service Catalog product. Default: ‘’

ExampleMetadata:

infused

Example:

cdk_build_output = codepipeline.Artifact()
service_catalog_deploy_action = codepipeline_actions.ServiceCatalogDeployActionBeta1(
    action_name="ServiceCatalogDeploy",
    template_path=cdk_build_output.at_path("Sample.template.json"),
    product_version_name="Version - " + Date.now.to_string,
    product_version_description="This is a version from the pipeline with a new description.",
    product_id="prod-XXXXXXXX"
)

Attributes

action_name

The physical, human-readable name of the Action.

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

product_id

The identifier of the product in the Service Catalog.

This product must already exist.

product_version_description

The optional description of this version of the Service Catalog product.

Default:

‘’

product_version_name

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

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 IAction.bind method in the ActionBindOptions.role property.

Default:

a new Role will be generated

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

template_path

The path to the cloudformation artifact.

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