Skip to content
v2.274.0

InspectorSourceCodeScanActionProps Struct ​

Construction properties of the InspectorSourceCodeScanAction.

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],
});

Properties ​

actionNamestringaction_namestractionNameStringActionNamestringActionName*stringrequired#
The physical, human-readable name of the Action.

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

criticalThresholdoptionalnumbercritical_thresholdoptionalint | floatcriticalThresholdoptionalNumberCriticalThresholdoptionaldoubleCriticalThresholdoptional*float64#
The number of critical severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

Default: no threshold

highThresholdoptionalnumberhigh_thresholdoptionalint | floathighThresholdoptionalNumberHighThresholdoptionaldoubleHighThresholdoptional*float64#
The number of high severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

Default: no threshold

inputArtifactinputArtifactinputArtifactInputArtifactInputArtifactrequired#
The source code to scan for vulnerabilities.
lowThresholdoptionalnumberlow_thresholdoptionalint | floatlowThresholdoptionalNumberLowThresholdoptionaldoubleLowThresholdoptional*float64#
The number of low severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

Default: no threshold

mediumThresholdoptionalnumbermedium_thresholdoptionalint | floatmediumThresholdoptionalNumberMediumThresholdoptionaldoubleMediumThresholdoptional*float64#
The number of medium severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

Default: no threshold

outputArtifactoutputArtifactoutputArtifactOutputArtifactOutputArtifactrequired#
Vulnerability details of your source in the form of a Software Bill of Materials (SBOM) file.
roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole#
The Role in which context's this Action will be executing in.

Default: a new Role will be generated

notes

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.

runOrderoptionalnumberrun_orderoptionalint | floatrunOrderoptionalNumberRunOrderoptionaldoubleRunOrderoptional*float64= 1#
The runOrder property for this Action.

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

variablesNamespaceoptionalstringvariables_namespaceoptionalstrvariablesNamespaceoptionalStringVariablesNamespaceoptionalstringVariablesNamespaceoptional*string#
The name of the namespace to use for variables emitted by this action.

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