Class: Aws::SecurityHub::Types::AutomationRulesMetadata
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecurityHub::Types::AutomationRulesMetadata
- Defined in:
- gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb
Overview
Metadata for automation rules in the calling account. The response
includes rules with a RuleStatus
of ENABLED
and DISABLED
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#created_at ⇒ Time
A timestamp that indicates when the rule was created.
-
#created_by ⇒ String
The principal that created a rule.
-
#description ⇒ String
A description of the rule.
-
#is_terminal ⇒ Boolean
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
-
#rule_arn ⇒ String
The Amazon Resource Name (ARN) for the rule.
-
#rule_name ⇒ String
The name of the rule.
-
#rule_order ⇒ Integer
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
-
#rule_status ⇒ String
Whether the rule is active after it is created.
-
#updated_at ⇒ Time
A timestamp that indicates when the rule was most recently updated.
Instance Attribute Details
#created_at ⇒ Time
A timestamp that indicates when the rule was created.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1260 class AutomationRulesMetadata < Struct.new( :rule_arn, :rule_status, :rule_order, :rule_name, :description, :is_terminal, :created_at, :updated_at, :created_by) SENSITIVE = [] include Aws::Structure end |
#created_by ⇒ String
The principal that created a rule.
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1260 class AutomationRulesMetadata < Struct.new( :rule_arn, :rule_status, :rule_order, :rule_name, :description, :is_terminal, :created_at, :updated_at, :created_by) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description of the rule.
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1260 class AutomationRulesMetadata < Struct.new( :rule_arn, :rule_status, :rule_order, :rule_name, :description, :is_terminal, :created_at, :updated_at, :created_by) SENSITIVE = [] include Aws::Structure end |
#is_terminal ⇒ Boolean
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1260 class AutomationRulesMetadata < Struct.new( :rule_arn, :rule_status, :rule_order, :rule_name, :description, :is_terminal, :created_at, :updated_at, :created_by) SENSITIVE = [] include Aws::Structure end |
#rule_arn ⇒ String
The Amazon Resource Name (ARN) for the rule.
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1260 class AutomationRulesMetadata < Struct.new( :rule_arn, :rule_status, :rule_order, :rule_name, :description, :is_terminal, :created_at, :updated_at, :created_by) SENSITIVE = [] include Aws::Structure end |
#rule_name ⇒ String
The name of the rule.
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1260 class AutomationRulesMetadata < Struct.new( :rule_arn, :rule_status, :rule_order, :rule_name, :description, :is_terminal, :created_at, :updated_at, :created_by) SENSITIVE = [] include Aws::Structure end |
#rule_order ⇒ Integer
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1260 class AutomationRulesMetadata < Struct.new( :rule_arn, :rule_status, :rule_order, :rule_name, :description, :is_terminal, :created_at, :updated_at, :created_by) SENSITIVE = [] include Aws::Structure end |
#rule_status ⇒ String
Whether the rule is active after it is created. If this parameter is
equal to ENABLED
, Security Hub starts applying the rule to
findings and finding updates after the rule is created. To change
the value of this parameter after creating a rule, use
BatchUpdateAutomationRules
.
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1260 class AutomationRulesMetadata < Struct.new( :rule_arn, :rule_status, :rule_order, :rule_name, :description, :is_terminal, :created_at, :updated_at, :created_by) SENSITIVE = [] include Aws::Structure end |
#updated_at ⇒ Time
A timestamp that indicates when the rule was most recently updated.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1260 class AutomationRulesMetadata < Struct.new( :rule_arn, :rule_status, :rule_order, :rule_name, :description, :is_terminal, :created_at, :updated_at, :created_by) SENSITIVE = [] include Aws::Structure end |