DeployCdkStackActionProps

class aws_cdk.pipelines.DeployCdkStackActionProps(*, cloud_assembly_input, base_action_name=None, change_set_name=None, execute_run_order=None, output=None, output_file_name=None, prepare_run_order=None, action_role, stack_name, template_path, cloud_formation_execution_role=None, dependency_stack_artifact_ids=None, region=None, stack_artifact_id=None, template_configuration_path=None)

Bases: DeployCdkStackActionOptions

(deprecated) Properties for a DeployCdkStackAction.

Parameters
  • cloud_assembly_input (Artifact) – (deprecated) The CodePipeline artifact that holds the Cloud Assembly.

  • base_action_name (Optional[str]) – (deprecated) Base name of the action. Default: stackName

  • change_set_name (Optional[str]) – (deprecated) Name of the change set to create and deploy. Default: ‘PipelineChange’

  • execute_run_order (Union[int, float, None]) – (deprecated) Run order for the Execute action. Default: - prepareRunOrder + 1

  • output (Optional[Artifact]) – (deprecated) Artifact to write Stack Outputs to. Default: - No outputs

  • output_file_name (Optional[str]) – (deprecated) Filename in output to write Stack outputs to. Default: - Required when ‘output’ is set

  • prepare_run_order (Union[int, float, None]) – (deprecated) Run order for the Prepare action. Default: 1

  • action_role (IRole) – (deprecated) Role for the action to assume. This controls the account to deploy into

  • stack_name (str) – (deprecated) The name of the stack that should be created/updated.

  • template_path (str) – (deprecated) Relative path of template in the input artifact.

  • cloud_formation_execution_role (Optional[IRole]) – (deprecated) Role to execute CloudFormation under. Default: - Execute CloudFormation using the action role

  • dependency_stack_artifact_ids (Optional[Sequence[str]]) – (deprecated) Artifact ID for the stacks this stack depends on. Used for pipeline order checking. Default: - No dependencies

  • region (Optional[str]) – (deprecated) Region to deploy into. Default: - Same region as pipeline

  • stack_artifact_id (Optional[str]) – (deprecated) Artifact ID for the stack deployed here. Used for pipeline order checking. Default: - Order will not be checked

  • template_configuration_path (Optional[str]) – (deprecated) Template configuration path relative to the input artifact. Default: - No template configuration

Deprecated

This class is part of the old API. Use the API based on the CodePipeline class instead

Stability

deprecated

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_codepipeline as codepipeline
import aws_cdk.aws_iam as iam
import aws_cdk.pipelines as pipelines

# artifact: codepipeline.Artifact
# role: iam.Role

deploy_cdk_stack_action_props = pipelines.DeployCdkStackActionProps(
    action_role=role,
    cloud_assembly_input=artifact,
    stack_name="stackName",
    template_path="templatePath",

    # the properties below are optional
    base_action_name="baseActionName",
    change_set_name="changeSetName",
    cloud_formation_execution_role=role,
    dependency_stack_artifact_ids=["dependencyStackArtifactIds"],
    execute_run_order=123,
    output=artifact,
    output_file_name="outputFileName",
    prepare_run_order=123,
    region="region",
    stack_artifact_id="stackArtifactId",
    template_configuration_path="templateConfigurationPath"
)

Attributes

action_role

(deprecated) Role for the action to assume.

This controls the account to deploy into

Stability

deprecated

Return type

IRole

base_action_name

(deprecated) Base name of the action.

Default

stackName

Stability

deprecated

Return type

Optional[str]

change_set_name

(deprecated) Name of the change set to create and deploy.

Default

‘PipelineChange’

Stability

deprecated

Return type

Optional[str]

cloud_assembly_input

(deprecated) The CodePipeline artifact that holds the Cloud Assembly.

Stability

deprecated

Return type

Artifact

cloud_formation_execution_role

(deprecated) Role to execute CloudFormation under.

Default
  • Execute CloudFormation using the action role

Stability

deprecated

Return type

Optional[IRole]

dependency_stack_artifact_ids

(deprecated) Artifact ID for the stacks this stack depends on.

Used for pipeline order checking.

Default
  • No dependencies

Stability

deprecated

Return type

Optional[List[str]]

execute_run_order

(deprecated) Run order for the Execute action.

Default
  • prepareRunOrder + 1

Stability

deprecated

Return type

Union[int, float, None]

output

(deprecated) Artifact to write Stack Outputs to.

Default
  • No outputs

Stability

deprecated

Return type

Optional[Artifact]

output_file_name

(deprecated) Filename in output to write Stack outputs to.

Default
  • Required when ‘output’ is set

Stability

deprecated

Return type

Optional[str]

prepare_run_order

(deprecated) Run order for the Prepare action.

Default

1

Stability

deprecated

Return type

Union[int, float, None]

region

(deprecated) Region to deploy into.

Default
  • Same region as pipeline

Stability

deprecated

Return type

Optional[str]

stack_artifact_id

(deprecated) Artifact ID for the stack deployed here.

Used for pipeline order checking.

Default
  • Order will not be checked

Stability

deprecated

Return type

Optional[str]

stack_name

(deprecated) The name of the stack that should be created/updated.

Stability

deprecated

Return type

str

template_configuration_path

(deprecated) Template configuration path relative to the input artifact.

Default
  • No template configuration

Stability

deprecated

Return type

Optional[str]

template_path

(deprecated) Relative path of template in the input artifact.

Stability

deprecated

Return type

str