AWS CDK Reference

Appearance

v2.274.0

InspectorEcrImageScanAction Class ​

CodePipeline invoke action that uses AWS InspectorScan for ECR images.

Source
aws-codepipeline-actions/lib/inspector/ecr-image-scan-action.ts
Type last changed
v2.188.0 · 4 Apr 2025

Example ​

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

declare const pipeline: codepipeline.Pipeline;
declare const repository: ecr.IRepository;

const scanOutput = new codepipeline.Artifact();
const scanAction = new codepipeline_actions.InspectorEcrImageScanAction({
  actionName: 'InspectorEcrImageScanAction',
  output: scanOutput,
  repository: repository,
});

pipeline.addStage({
  stageName: 'Scan',
  actions: [scanAction],
});
python
import aws_cdk.aws_ecr as ecr

# pipeline: codepipeline.Pipeline
# repository: ecr.IRepository


scan_output = codepipeline.Artifact()
scan_action = codepipeline_actions.InspectorEcrImageScanAction(
    action_name="InspectorEcrImageScanAction",
    output=scan_output,
    repository=repository
)

pipeline.add_stage(
    stage_name="Scan",
    actions=[scan_action]
)
java
import software.amazon.awscdk.services.ecr.*;

Pipeline pipeline;
IRepository repository;


Artifact scanOutput = new Artifact();
InspectorEcrImageScanAction scanAction = InspectorEcrImageScanAction.Builder.create()
        .actionName("InspectorEcrImageScanAction")
        .output(scanOutput)
        .repository(repository)
        .build();

pipeline.addStage(StageOptions.builder()
        .stageName("Scan")
        .actions(List.of(scanAction))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.ECR;

Pipeline pipeline;
IRepository repository;


var scanOutput = new Artifact();
var scanAction = new InspectorEcrImageScanAction(new InspectorEcrImageScanActionProps {
    ActionName = "InspectorEcrImageScanAction",
    Output = scanOutput,
    Repository = repository
});

pipeline.AddStage(new StageOptions {
    StageName = "Scan",
    Actions = new [] { scanAction }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import ecr "github.com/aws/aws-cdk-go/awscdk"

var pipeline Pipeline
var repository IRepository


scanOutput := codepipeline.NewArtifact()
scanAction := codepipeline_actions.NewInspectorEcrImageScanAction(&InspectorEcrImageScanActionProps{
	ActionName: jsii.String("InspectorEcrImageScanAction"),
	Output: scanOutput,
	Repository: repository,
})

pipeline.AddStage(&StageOptions{
	StageName: jsii.String("Scan"),
	Actions: []IAction{
		scanAction,
	},
})

Initializer ​

ts
new InspectorEcrImageScanAction(props: InspectorEcrImageScanActionProps)
python
InspectorEcrImageScanAction(props: InspectorEcrImageScanActionProps)
java
new InspectorEcrImageScanAction(InspectorEcrImageScanActionProps props)
csharp
new InspectorEcrImageScanAction(InspectorEcrImageScanActionProps props)
go
NewInspectorEcrImageScanAction(Props InspectorEcrImageScanActionProps)

Properties ​

actionPropertiesActionPropertiesaction_propertiesActionPropertiesactionPropertiesActionPropertiesActionPropertiesActionPropertiesActionPropertiesActionPropertiesrequired#
The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind callback.

variablesInspectorScanVariablesvariablesInspectorScanVariablesvariablesInspectorScanVariablesVariablesInspectorScanVariablesVariablesInspectorScanVariablesrequired#
The variables emitted by this action.

Methods ​

bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfigdef bind(self, scope: Construct, stage: IStage, options: ActionBindOptions) -> ActionConfigpublic ActionConfig bind(Construct scope, IStage stage, ActionBindOptions options)public ActionConfig Bind(Construct scope, IStage stage, ActionBindOptions options)func Bind(Scope Construct, Stage IStage, Options ActionBindOptions) ActionConfig#
The callback invoked when this Action is added to a Pipeline.
onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Ruledef on_state_change(self, name: str, target: typing.Optional[IRuleTarget] = None, options: typing.Optional[RuleProps] = None) -> Rulepublic Rule onStateChange(String name, IRuleTarget target, RuleProps options)public Rule OnStateChange(string name, IRuleTarget? target = null, RuleProps? options = null)func OnStateChange(Name *string, Target IRuleTarget, Options RuleProps) Rule#
Creates an Event that will be triggered whenever the state of this Action changes.