aws-cdk-lib.aws_codepipeline_actions.EcrSourceActionProps

interface EcrSourceActionProps

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.Actions.EcrSourceActionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#EcrSourceActionProps
Javasoftware.amazon.awscdk.services.codepipeline.actions.EcrSourceActionProps
Pythonaws_cdk.aws_codepipeline_actions.EcrSourceActionProps
TypeScript (source)aws-cdk-lib » aws_codepipeline_actions » EcrSourceActionProps

Construction properties of EcrSourceAction.

Example

import * as ecr from 'aws-cdk-lib/aws-ecr';

declare const ecrRepository: ecr.Repository;
const pipeline = new codepipeline.Pipeline(this, 'MyPipeline');
const sourceOutput = new codepipeline.Artifact();
const sourceAction = new codepipeline_actions.EcrSourceAction({
  actionName: 'ECR',
  repository: ecrRepository,
  imageTag: 'some-tag', // optional, default: 'latest'
  output: sourceOutput,
});
pipeline.addStage({
  stageName: 'Source',
  actions: [sourceAction],
});

Properties

NameTypeDescription
actionNamestringThe physical, human-readable name of the Action.
outputArtifact
repositoryIRepositoryThe repository that will be watched for changes.
imageTag?stringThe image tag that will be checked for changes.
role?IRoleThe Role in which context's this Action will be executing in.
runOrder?numberThe runOrder property for this Action.
variablesNamespace?stringThe name of the namespace to use for variables emitted by this action.

actionName

Type: string

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.


output

Type: Artifact


repository

Type: IRepository

The repository that will be watched for changes.


imageTag?

Type: string (optional, default: 'latest')

The image tag that will be checked for changes.

It is not possible to trigger on changes to more than one tag.


role?

Type: IRole (optional, default: a new Role will be generated)

The Role in which context's this Action will be executing in.

The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.


runOrder?

Type: number (optional, default: 1)

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html


variablesNamespace?

Type: string (optional, default: a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set)

The name of the namespace to use for variables emitted by this action.