UpdatePipelineAction

class aws_cdk.pipelines.UpdatePipelineAction(scope, id, *, cloud_assembly_input, pipeline_stack_hierarchical_id, build_spec=None, cdk_cli_version=None, docker_credentials=None, pipeline_stack_name=None, privileged=None, project_name=None)

Bases: Construct

(deprecated) Action to self-mutate the pipeline.

Creates a CodeBuild project which will use the CDK CLI to deploy the pipeline stack.

You do not need to instantiate this action – it will automatically be added by the pipeline.

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_codebuild as codebuild
import aws_cdk.aws_codepipeline as codepipeline
import aws_cdk.pipelines as pipelines

# artifact: codepipeline.Artifact
# build_spec: codebuild.BuildSpec
# docker_credential: pipelines.DockerCredential

update_pipeline_action = pipelines.UpdatePipelineAction(self, "MyUpdatePipelineAction",
    cloud_assembly_input=artifact,
    pipeline_stack_hierarchical_id="pipelineStackHierarchicalId",

    # the properties below are optional
    build_spec=build_spec,
    cdk_cli_version="cdkCliVersion",
    docker_credentials=[docker_credential],
    pipeline_stack_name="pipelineStackName",
    privileged=False,
    project_name="projectName"
)
Parameters
  • scope (Construct) –

  • id (str) –

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

  • pipeline_stack_hierarchical_id (str) – (deprecated) Hierarchical id of the pipeline stack.

  • build_spec (Optional[BuildSpec]) – (deprecated) Custom BuildSpec that is merged with generated one. Default: - none

  • cdk_cli_version (Optional[str]) – (deprecated) Version of CDK CLI to ‘npm install’. Default: - Latest version

  • docker_credentials (Optional[Sequence[DockerCredential]]) – (deprecated) Docker registries and associated credentials necessary during the pipeline self-update stage. Default: []

  • pipeline_stack_name (Optional[str]) – (deprecated) Name of the pipeline stack. Default: - none

  • privileged (Optional[bool]) – (deprecated) Whether the build step should run in privileged mode. Default: - false

  • project_name (Optional[str]) – (deprecated) Name of the CodeBuild project. Default: - Automatically generated

Stability

deprecated

Methods

bind(scope, stage, *, bucket, role)

(deprecated) Exists to implement IAction.

Parameters
Stability

deprecated

Return type

ActionConfig

on_state_change(name, target=None, *, description=None, enabled=None, event_bus=None, event_pattern=None, rule_name=None, schedule=None, targets=None)

(deprecated) Exists to implement IAction.

Parameters
  • name (str) –

  • target (Optional[IRuleTarget]) –

  • description (Optional[str]) – A description of the rule’s purpose. Default: - No description.

  • enabled (Optional[bool]) – Indicates whether the rule is enabled. Default: true

  • event_bus (Optional[IEventBus]) – The event bus to associate with this rule. Default: - The default event bus.

  • event_pattern (Union[EventPattern, Dict[str, Any], None]) – Describes which events EventBridge routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. Default: - None.

  • rule_name (Optional[str]) – A name for the rule. Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

  • schedule (Optional[Schedule]) – The schedule or rate (frequency) that determines when EventBridge runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon EventBridge User Guide. Default: - None.

  • targets (Optional[Sequence[IRuleTarget]]) – Targets to invoke when this rule matches an event. Input will be the full matched event. If you wish to specify custom target input, use addTarget(target[, inputOptions]). Default: - No targets.

Stability

deprecated

Return type

Rule

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

action_properties

(deprecated) Exists to implement IAction.

Stability

deprecated

Return type

ActionProperties

node

The construct tree node associated with this construct.

Return type

ConstructNode

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool