AWS CDK Reference

Appearance

v2.273.0

InspectorSourceCodeScanAction Class ​

CodePipeline invoke action that uses AWS InspectorScan for source code.

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

Example ​

ts
declare const pipeline: codepipeline.Pipeline;

const sourceOutput = new codepipeline.Artifact();
const sourceAction = new codepipeline_actions.CodeStarConnectionsSourceAction({
  actionName: 'CodeStarConnectionsSourceAction',
  output: sourceOutput,
  connectionArn: 'your-connection-arn',
  owner: 'your-owner',
  repo: 'your-repo',
});

const scanOutput = new codepipeline.Artifact();
const scanAction = new codepipeline_actions.InspectorSourceCodeScanAction({
  actionName: 'InspectorSourceCodeScanAction',
  input: sourceOutput,
  output: scanOutput,
});

pipeline.addStage({
  stageName: 'Source',
  actions: [sourceAction],
});
pipeline.addStage({
  stageName: 'Scan',
  actions: [scanAction],
});
python
# pipeline: codepipeline.Pipeline


source_output = codepipeline.Artifact()
source_action = codepipeline_actions.CodeStarConnectionsSourceAction(
    action_name="CodeStarConnectionsSourceAction",
    output=source_output,
    connection_arn="your-connection-arn",
    owner="your-owner",
    repo="your-repo"
)

scan_output = codepipeline.Artifact()
scan_action = codepipeline_actions.InspectorSourceCodeScanAction(
    action_name="InspectorSourceCodeScanAction",
    input=source_output,
    output=scan_output
)

pipeline.add_stage(
    stage_name="Source",
    actions=[source_action]
)
pipeline.add_stage(
    stage_name="Scan",
    actions=[scan_action]
)
java
Pipeline pipeline;


Artifact sourceOutput = new Artifact();
CodeStarConnectionsSourceAction sourceAction = CodeStarConnectionsSourceAction.Builder.create()
        .actionName("CodeStarConnectionsSourceAction")
        .output(sourceOutput)
        .connectionArn("your-connection-arn")
        .owner("your-owner")
        .repo("your-repo")
        .build();

Artifact scanOutput = new Artifact();
InspectorSourceCodeScanAction scanAction = InspectorSourceCodeScanAction.Builder.create()
        .actionName("InspectorSourceCodeScanAction")
        .input(sourceOutput)
        .output(scanOutput)
        .build();

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


var sourceOutput = new Artifact();
var sourceAction = new CodeStarConnectionsSourceAction(new CodeStarConnectionsSourceActionProps {
    ActionName = "CodeStarConnectionsSourceAction",
    Output = sourceOutput,
    ConnectionArn = "your-connection-arn",
    Owner = "your-owner",
    Repo = "your-repo"
});

var scanOutput = new Artifact();
var scanAction = new InspectorSourceCodeScanAction(new InspectorSourceCodeScanActionProps {
    ActionName = "InspectorSourceCodeScanAction",
    Input = sourceOutput,
    Output = scanOutput
});

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


sourceOutput := codepipeline.NewArtifact()
sourceAction := codepipeline_actions.NewCodeStarConnectionsSourceAction(&CodeStarConnectionsSourceActionProps{
	ActionName: jsii.String("CodeStarConnectionsSourceAction"),
	Output: sourceOutput,
	ConnectionArn: jsii.String("your-connection-arn"),
	Owner: jsii.String("your-owner"),
	Repo: jsii.String("your-repo"),
})

scanOutput := codepipeline.NewArtifact()
scanAction := codepipeline_actions.NewInspectorSourceCodeScanAction(&InspectorSourceCodeScanActionProps{
	ActionName: jsii.String("InspectorSourceCodeScanAction"),
	Input: sourceOutput,
	Output: scanOutput,
})

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

Initializer ​

ts
new InspectorSourceCodeScanAction(props: InspectorSourceCodeScanActionProps)
python
InspectorSourceCodeScanAction(props: InspectorSourceCodeScanActionProps)
java
new InspectorSourceCodeScanAction(InspectorSourceCodeScanActionProps props)
csharp
new InspectorSourceCodeScanAction(InspectorSourceCodeScanActionProps props)
go
NewInspectorSourceCodeScanAction(Props InspectorSourceCodeScanActionProps)

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.