interface UpdatePipelineActionProps ⚠️

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

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

Props for the UpdatePipelineAction.

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 updatePipelineActionProps: pipelines.UpdatePipelineActionProps = {
  cloudAssemblyInput: artifact,
  pipelineStackHierarchicalId: 'pipelineStackHierarchicalId',

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

Properties

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.