Skip to content

Latest commit

 

History

History
96 lines (58 loc) · 5.26 KB

API.md

File metadata and controls

96 lines (58 loc) · 5.26 KB
Raw

API Reference

Classes

Name Description
CodePipelineAnchoreInlineScanAction No description

Structs

Name Description
CodePipelineAnchoreInlineScanActionProps No description

class CodePipelineAnchoreInlineScanAction

Implements: IAction Extends: Action

Initializer

new CodePipelineAnchoreInlineScanAction(props: CodePipelineAnchoreInlineScanActionProps)
  • props (CodePipelineAnchoreInlineScanActionProps) No description
    • actionName (string) The physical, human-readable name of the Action.
    • runOrder (number) The runOrder property for this Action. Default: 1
    • 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
    • role (IRole) The Role in which context's this Action will be executing in. Default: a new Role will be generated
    • input (Artifact) The source to use as input for this action.
    • computeType (ComputeType) The type of compute to use for backup the repositories. Default: taken from {@link LinuxBuildImage.STANDARD_4_0#defaultComputeType}
    • customAnchoreImage (string) This will override the image name from Dockerhub. Optional
    • ecrLogin (boolean) No description Default: false
    • policyBundlePath (string) Path to local Anchore policy bundle. Default: ./policy_bundle.json
    • projectRole (IRole) No description Optional
    • timeout (number) Specify timeout for image scanning in seconds. Default: 300
    • version (string) Version of anchore ci-tools. Default: v0.8.2

Methods

protected bound(scope, _stage, options)

(experimental) The method called when an Action is attached to a Pipeline.

This method is guaranteed to be called only once for each Action instance.

protected bound(scope: Construct, _stage: IStage, options: ActionBindOptions): ActionConfig

Returns:

struct CodePipelineAnchoreInlineScanActionProps

Name Type Description
actionName string The physical, human-readable name of the Action.
input Artifact The source to use as input for this action.
computeType? ComputeType The type of compute to use for backup the repositories.
Default: taken from {@link LinuxBuildImage.STANDARD_4_0#defaultComputeType}
customAnchoreImage? string This will override the image name from Dockerhub.
Optional
ecrLogin? boolean Default: false
policyBundlePath? string Path to local Anchore policy bundle.
Default: ./policy_bundle.json
projectRole? IRole Optional
role? IRole The Role in which context's this Action will be executing in.
Default: a new Role will be generated
runOrder? number The runOrder property for this Action.
Default: 1
timeout? number Specify timeout for image scanning in seconds.
Default: 300
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
version? string Version of anchore ci-tools.
Default: v0.8.2