class UpdatePipelineAction (construct) ⚠️

Language	Type name
.NET	Amazon.CDK.Pipelines.UpdatePipelineAction
Java	software.amazon.awscdk.pipelines.UpdatePipelineAction
Python	aws_cdk.pipelines.UpdatePipelineAction
TypeScript (source)	@aws-cdk/pipelines » UpdatePipelineAction

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Implements IConstruct, IConstruct, IDependable, IAction

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codebuild from '@aws-cdk/aws-codebuild';
import * as codepipeline from '@aws-cdk/aws-codepipeline';
import * as pipelines from '@aws-cdk/pipelines';

declare const artifact: codepipeline.Artifact;
declare const buildSpec: codebuild.BuildSpec;
declare const dockerCredential: pipelines.DockerCredential;
const updatePipelineAction = new pipelines.UpdatePipelineAction(this, 'MyUpdatePipelineAction', {
  cloudAssemblyInput: artifact,
  pipelineStackHierarchicalId: 'pipelineStackHierarchicalId',

  // the properties below are optional
  buildSpec: buildSpec,
  cdkCliVersion: 'cdkCliVersion',
  dockerCredentials: [dockerCredential],
  pipelineStackName: 'pipelineStackName',
  privileged: false,
  projectName: 'projectName',
});

Initializer

new UpdatePipelineAction(scope: Construct, id: string, props: UpdatePipelineActionProps)

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Parameters

• scope Construct
• id string
• props UpdatePipelineActionProps

Construct Props

Name	Type	Description
cloudAssemblyInput⚠️	Artifact	The CodePipeline artifact that holds the Cloud Assembly.
pipelineStackHierarchicalId⚠️	string	Hierarchical id of the pipeline stack.
buildSpec?⚠️	BuildSpec	Custom BuildSpec that is merged with generated one.
cdkCliVersion?⚠️	string	Version of CDK CLI to 'npm install'.
dockerCredentials?⚠️	DockerCredential[]	Docker registries and associated credentials necessary during the pipeline self-update stage.
pipelineStackName?⚠️	string	Name of the pipeline stack.
privileged?⚠️	boolean	Whether the build step should run in privileged mode.
projectName?⚠️	string	Name of the CodeBuild project.

---

cloudAssemblyInput⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: Artifact

The CodePipeline artifact that holds the Cloud Assembly.

---

pipelineStackHierarchicalId⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: string

Hierarchical id of the pipeline stack.

---

buildSpec?⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: BuildSpec (optional, default: none)

Custom BuildSpec that is merged with generated one.

---

cdkCliVersion?⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: string (optional, default: Latest version)

Version of CDK CLI to 'npm install'.

---

dockerCredentials?⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: DockerCredential[] (optional, default: [])

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

---

pipelineStackName?⚠️

⚠️ Deprecated: - Use pipelineStackHierarchicalId instead.

Type: string (optional, default: none)

Name of the pipeline stack.

---

privileged?⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: boolean (optional, default: false)

Whether the build step should run in privileged mode.

---

projectName?⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: string (optional, default: Automatically generated)

Name of the CodeBuild project.

Properties

Name	Type	Description
actionProperties⚠️	ActionProperties	Exists to implement IAction.
node⚠️	ConstructNode	The construct tree node associated with this construct.

---

actionProperties⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: ActionProperties

Exists to implement IAction.

---

node⚠️

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Type: ConstructNode

The construct tree node associated with this construct.

Methods

Name	Description
bind(scope, stage, options)⚠️	Exists to implement IAction.
onStateChange(name, target?, options?)⚠️	Exists to implement IAction.
toString()⚠️	Returns a string representation of this construct.

---

bind(scope, stage, options)⚠️

public bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Parameters

• scope Construct
• stage IStage
• options ActionBindOptions

Returns

• ActionConfig

Exists to implement IAction.

---

onStateChange(name, target?, options?)⚠️

public onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Rule

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Parameters

• name string
• target IRuleTarget
• options RuleProps

Returns

• Rule

Exists to implement IAction.

---

toString()⚠️

public toString(): string

⚠️ Deprecated: This class is part of the old API. Use the API based on the CodePipeline class instead

Returns

• string

Returns a string representation of this construct.