DeployCdkStackActionOptions

class aws_cdk.pipelines.DeployCdkStackActionOptions(*, 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)

Bases: object

(deprecated) Customization options 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

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.pipelines as pipelines

# artifact: codepipeline.Artifact

deploy_cdk_stack_action_options = pipelines.DeployCdkStackActionOptions(
    cloud_assembly_input=artifact,

    # the properties below are optional
    base_action_name="baseActionName",
    change_set_name="changeSetName",
    execute_run_order=123,
    output=artifact,
    output_file_name="outputFileName",
    prepare_run_order=123
)

Attributes

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

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]