UpdatePipelineActionProps

class aws_cdk.pipelines.UpdatePipelineActionProps(*, 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: object

(deprecated) Props for the UpdatePipelineAction.

Parameters
  • 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

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_props = pipelines.UpdatePipelineActionProps(
    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"
)

Attributes

build_spec

(deprecated) Custom BuildSpec that is merged with generated one.

Default
  • none

Stability

deprecated

Return type

Optional[BuildSpec]

cdk_cli_version

(deprecated) Version of CDK CLI to ‘npm install’.

Default
  • Latest version

Stability

deprecated

Return type

Optional[str]

cloud_assembly_input

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

Stability

deprecated

Return type

Artifact

docker_credentials

(deprecated) Docker registries and associated credentials necessary during the pipeline self-update stage.

Default

[]

Stability

deprecated

Return type

Optional[List[DockerCredential]]

pipeline_stack_hierarchical_id

(deprecated) Hierarchical id of the pipeline stack.

Stability

deprecated

Return type

str

pipeline_stack_name

(deprecated) Name of the pipeline stack.

Default
  • none

Deprecated
  • Use pipelineStackHierarchicalId instead.

Stability

deprecated

Return type

Optional[str]

privileged

(deprecated) Whether the build step should run in privileged mode.

Default
  • false

Stability

deprecated

Return type

Optional[bool]

project_name

(deprecated) Name of the CodeBuild project.

Default
  • Automatically generated

Stability

deprecated

Return type

Optional[str]