Class: AWSCDK::CodePipelineActions::InspectorSourceCodeScanActionProps

Inherits:
InspectorScanActionBaseProps
  • Object
show all
Defined in:
code_pipeline_actions/inspector_source_code_scan_action_props.rb

Overview

Construction properties of the InspectorSourceCodeScanAction.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action_name:, run_order: nil, variables_namespace: nil, role: nil, output:, critical_threshold: nil, high_threshold: nil, low_threshold: nil, medium_threshold: nil, input:) ⇒ InspectorSourceCodeScanActionProps

Returns a new instance of InspectorSourceCodeScanActionProps.

Parameters:

  • action_name (String) —

    The physical, human-readable name of the Action.

  • run_order (Numeric, nil) (defaults to: nil) —

    The runOrder property for this Action.

  • variables_namespace (String, nil) (defaults to: nil) —

    The name of the namespace to use for variables emitted by this action.

  • role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    The Role in which context's this Action will be executing in.

  • output (AWSCDK::Codepipeline::Artifact) —

    Vulnerability details of your source in the form of a Software Bill of Materials (SBOM) file.

  • critical_threshold (Numeric, nil) (defaults to: nil) —

    The number of critical severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

  • high_threshold (Numeric, nil) (defaults to: nil) —

    The number of high severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

  • low_threshold (Numeric, nil) (defaults to: nil) —

    The number of low severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

  • medium_threshold (Numeric, nil) (defaults to: nil) —

    The number of medium severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

  • input (AWSCDK::Codepipeline::Artifact) —

    The source code to scan for vulnerabilities.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 17

def initialize(action_name:, run_order: nil, variables_namespace: nil, role: nil, output:, critical_threshold: nil, high_threshold: nil, low_threshold: nil, medium_threshold: nil, input:)
  @action_name = action_name
  Jsii::Type.check_type(@action_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actionName")
  @run_order = run_order
  Jsii::Type.check_type(@run_order, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "runOrder") unless @run_order.nil?
  @variables_namespace = variables_namespace
  Jsii::Type.check_type(@variables_namespace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "variablesNamespace") unless @variables_namespace.nil?
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role") unless @role.nil?
  @output = output
  Jsii::Type.check_type(@output, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFydGlmYWN0In0=")), "output")
  @critical_threshold = critical_threshold
  Jsii::Type.check_type(@critical_threshold, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "criticalThreshold") unless @critical_threshold.nil?
  @high_threshold = high_threshold
  Jsii::Type.check_type(@high_threshold, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "highThreshold") unless @high_threshold.nil?
  @low_threshold = low_threshold
  Jsii::Type.check_type(@low_threshold, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "lowThreshold") unless @low_threshold.nil?
  @medium_threshold = medium_threshold
  Jsii::Type.check_type(@medium_threshold, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "mediumThreshold") unless @medium_threshold.nil?
  @input = input
  Jsii::Type.check_type(@input, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFydGlmYWN0In0=")), "input")
end

Instance Attribute Details

#action_name ⇒ String (readonly)

The physical, human-readable name of the Action.

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

Returns:

  • (String) 


45
46
47
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 45

def action_name
  @action_name
end

#critical_threshold ⇒ Numeric? (readonly)

Note:

Default: - no threshold

The number of critical severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

Returns:

  • (Numeric, nil) 


78
79
80
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 78

def critical_threshold
  @critical_threshold
end

#high_threshold ⇒ Numeric? (readonly)

Note:

Default: - no threshold

The number of high severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

Returns:

  • (Numeric, nil) 


83
84
85
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 83

def high_threshold
  @high_threshold
end

#input ⇒ AWSCDK::Codepipeline::Artifact (readonly)

The source code to scan for vulnerabilities.

Returns:



97
98
99
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 97

def input
  @input
end

#low_threshold ⇒ Numeric? (readonly)

Note:

Default: - no threshold

The number of low severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

Returns:

  • (Numeric, nil) 


88
89
90
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 88

def low_threshold
  @low_threshold
end

#medium_threshold ⇒ Numeric? (readonly)

Note:

Default: - no threshold

The number of medium severity vulnerabilities found in your source beyond which CodePipeline should fail the action.

Returns:

  • (Numeric, nil) 


93
94
95
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 93

def medium_threshold
  @medium_threshold
end

#output ⇒ AWSCDK::Codepipeline::Artifact (readonly)

Vulnerability details of your source in the form of a Software Bill of Materials (SBOM) file.

Returns:



73
74
75
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 73

def output
  @output
end

#role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: a new Role will be generated

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 IAction.bind method in the ActionBindOptions.role property.

Returns:



69
70
71
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 69

def role
  @role
end

#run_order ⇒ Numeric? (readonly)

Note:

Default: 1

The runOrder property for this Action.

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

Returns:

  • (Numeric, nil)

See Also:



53
54
55
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 53

def run_order
  @run_order
end

#variables_namespace ⇒ String? (readonly)

Note:

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

The name of the namespace to use for variables emitted by this action.

Returns:

  • (String, nil) 


58
59
60
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 58

def variables_namespace
  @variables_namespace
end

Class Method Details

.jsii_properties ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 99

def self.jsii_properties
  {
    :action_name => "actionName",
    :run_order => "runOrder",
    :variables_namespace => "variablesNamespace",
    :role => "role",
    :output => "output",
    :critical_threshold => "criticalThreshold",
    :high_threshold => "highThreshold",
    :low_threshold => "lowThreshold",
    :medium_threshold => "mediumThreshold",
    :input => "input",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'code_pipeline_actions/inspector_source_code_scan_action_props.rb', line 114

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "actionName" => @action_name,
    "runOrder" => @run_order,
    "variablesNamespace" => @variables_namespace,
    "role" => @role,
    "output" => @output,
    "criticalThreshold" => @critical_threshold,
    "highThreshold" => @high_threshold,
    "lowThreshold" => @low_threshold,
    "mediumThreshold" => @medium_threshold,
    "input" => @input,
  })
  result.compact
end