@cloudcomponents/cdk-codepipeline-anchore-inline-scan-action
@cloudcomponents/cdk-codepipeline-anchore-inline-scan-action / CodePipelineAnchoreInlineScanAction
-
Action↳
CodePipelineAnchoreInlineScanAction
• new CodePipelineAnchoreInlineScanAction(props)
| Name | Type |
|---|---|
props |
CodePipelineAnchoreInlineScanActionProps |
Action.constructor
• Private Readonly props: CodePipelineAnchoreInlineScanActionProps
• Protected Readonly providedActionProperties: ActionProperties
This is a renamed version of the {@link IAction.actionProperties} property.
stability stable
Action.providedActionProperties
• Private get _pipeline(): any
any
Action._pipeline
• Private get _scope(): any
Retrieves the Construct scope of this Action. Only available after the Action has been added to a Stage, and that Stage to a Pipeline.
any
Action._scope
• Private get _stage(): any
any
Action._stage
• get actionProperties(): ActionProperties
The simple properties of the Action, like its Owner, name, etc.
Note that this accessor will be called before the bind callback.
stability stable
ActionProperties
Action.actionProperties
▸ bind(scope, stage, options): ActionConfig
The callback invoked when this Action is added to a Pipeline.
stability stable
| Name | Type |
|---|---|
scope |
Construct |
stage |
IStage |
options |
ActionBindOptions |
ActionConfig
Action.bind
▸ Protected bound(scope, _stage, options): ActionConfig
| Name | Type |
|---|---|
scope |
Construct |
_stage |
IStage |
options |
ActionBindOptions |
ActionConfig
Action.bound
▸ onStateChange(name, target?, options?): Rule
Creates an Event that will be triggered whenever the state of this Action changes.
stability stable
| Name | Type |
|---|---|
name |
string |
target? |
IRuleTarget |
options? |
RuleProps |
Rule
Action.onStateChange
▸ Protected variableExpression(variableName): string
stability stable
| Name | Type |
|---|---|
variableName |
string |
string
Action.variableExpression
@cloudcomponents/cdk-codepipeline-anchore-inline-scan-action / CodePipelineAnchoreInlineScanActionProps
-
CommonAwsActionProps↳
CodePipelineAnchoreInlineScanActionProps
- actionName
- computeType
- customAnchoreImage
- ecrLogin
- input
- policyBundlePath
- projectRole
- role
- runOrder
- timeout
- variablesNamespace
- version
• Readonly actionName: string
The physical, human-readable name of the Action.
Note that Action names must be unique within a single Stage.
stability stable
CommonAwsActionProps.actionName
• Optional Readonly computeType: ComputeType
The type of compute to use for backup the repositories. See the {@link ComputeType} enum for the possible values.
default taken from {@link LinuxBuildImage.STANDARD_4_0#defaultComputeType}
• Optional Readonly customAnchoreImage: string
This will override the image name from Dockerhub
• Optional Readonly ecrLogin: boolean
default false
• Readonly input: Artifact
The source to use as input for this action.
• Optional Readonly policyBundlePath: string
Path to local Anchore policy bundle
default ./policy_bundle.json
• Optional Readonly projectRole: IRole
• Optional Readonly role: IRole
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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.
default a new Role will be generated
stability stable
CommonAwsActionProps.role
• Optional Readonly runOrder: number
The runOrder property for this Action.
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
default 1
see https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
stability stable
CommonAwsActionProps.runOrder
• Optional Readonly timeout: number
Specify timeout for image scanning in seconds.
default 300
• Optional Readonly variablesNamespace: 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
stability stable
CommonAwsActionProps.variablesNamespace
• Optional Readonly version: string
Version of anchore ci-tools
default v0.8.2