Class: AWSCDK::SecurityHub::CfnAutomationRuleV2Props

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
security_hub/cfn_automation_rule_v2_props.rb

Overview

Properties for defining a CfnAutomationRuleV2.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(actions:, criteria:, description:, rule_name:, rule_order:, rule_status: nil, tags: nil) ⇒ CfnAutomationRuleV2Props

Returns a new instance of CfnAutomationRuleV2Props.

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'security_hub/cfn_automation_rule_v2_props.rb', line 16

def initialize(actions:, criteria:, description:, rule_name:, rule_order:, rule_status: nil, tags: nil)
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjdXJpdHlodWIuQ2ZuQXV0b21hdGlvblJ1bGVWMi5BdXRvbWF0aW9uUnVsZXNBY3Rpb25WMlByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "actions")
  @criteria = criteria.is_a?(Hash) ? ::AWSCDK::SecurityHub::CfnAutomationRuleV2::CriteriaProperty.new(**criteria.transform_keys(&:to_sym)) : criteria
  Jsii::Type.check_type(@criteria, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZWN1cml0eWh1Yi5DZm5BdXRvbWF0aW9uUnVsZVYyLkNyaXRlcmlhUHJvcGVydHkifV19fQ==")), "criteria")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description")
  @rule_name = rule_name
  Jsii::Type.check_type(@rule_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ruleName")
  @rule_order = rule_order
  Jsii::Type.check_type(@rule_order, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ruleOrder")
  @rule_status = rule_status
  Jsii::Type.check_type(@rule_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ruleStatus") unless @rule_status.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#actions ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::SecurityHub::CfnAutomationRuleV2::AutomationRulesActionV2Property> (readonly)

A list of actions to be performed when the rule criteria is met.

Returns:

See Also:



37
38
39
 
# File 'security_hub/cfn_automation_rule_v2_props.rb', line 37

def actions
  @actions
end

#criteria ⇒ AWSCDK::IResolvable, AWSCDK::SecurityHub::CfnAutomationRuleV2::CriteriaProperty (readonly)

The filtering type and configuration of the automation rule.

Returns:

See Also:



42
43
44
 
# File 'security_hub/cfn_automation_rule_v2_props.rb', line 42

def criteria
  @criteria
end

#description ⇒ String (readonly)

A description of the V2 automation rule.

Returns:

  • (String)

See Also:



47
48
49
 
# File 'security_hub/cfn_automation_rule_v2_props.rb', line 47

def description
  @description
end

#rule_name ⇒ String (readonly)

The name of the V2 automation rule.

Returns:

  • (String)

See Also:



52
53
54
 
# File 'security_hub/cfn_automation_rule_v2_props.rb', line 52

def rule_name
  @rule_name
end

#rule_order ⇒ Numeric (readonly)

The value for the rule priority.

Returns:

  • (Numeric)

See Also:



57
58
59
 
# File 'security_hub/cfn_automation_rule_v2_props.rb', line 57

def rule_order
  @rule_order
end

#rule_status ⇒ String? (readonly)

The status of the V2 automation rule.

Returns:

  • (String, nil)

See Also:



62
63
64
 
# File 'security_hub/cfn_automation_rule_v2_props.rb', line 62

def rule_status
  @rule_status
end

#tags ⇒ Hash{String => String}? (readonly)

A list of key-value pairs associated with the V2 automation rule.

Returns:

  • (Hash{String => String}, nil)

See Also:



67
68
69
 
# File 'security_hub/cfn_automation_rule_v2_props.rb', line 67

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'security_hub/cfn_automation_rule_v2_props.rb', line 69

def self.jsii_properties
  {
    :actions => "actions",
    :criteria => "criteria",
    :description => "description",
    :rule_name => "ruleName",
    :rule_order => "ruleOrder",
    :rule_status => "ruleStatus",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'security_hub/cfn_automation_rule_v2_props.rb', line 81

def to_jsii
  result = {}
  result.merge!({
    "actions" => @actions,
    "criteria" => @criteria,
    "description" => @description,
    "ruleName" => @rule_name,
    "ruleOrder" => @rule_order,
    "ruleStatus" => @rule_status,
    "tags" => @tags,
  })
  result.compact
end