@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AutomationRulesMetadata extends Object implements Serializable, Cloneable, StructuredPojo
Metadata for automation rules in the calling account. The response includes rules with a RuleStatus
of
ENABLED
and DISABLED
.
Constructor and Description |
---|
AutomationRulesMetadata() |
Modifier and Type | Method and Description |
---|---|
AutomationRulesMetadata |
clone() |
boolean |
equals(Object obj) |
Date |
getCreatedAt()
A timestamp that indicates when the rule was created.
|
String |
getCreatedBy()
The principal that created a rule.
|
String |
getDescription()
A description of the rule.
|
Boolean |
getIsTerminal()
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
|
String |
getRuleArn()
The Amazon Resource Name (ARN) for the rule.
|
String |
getRuleName()
The name of the rule.
|
Integer |
getRuleOrder()
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
|
String |
getRuleStatus()
Whether the rule is active after it is created.
|
Date |
getUpdatedAt()
A timestamp that indicates when the rule was most recently updated.
|
int |
hashCode() |
Boolean |
isTerminal()
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCreatedAt(Date createdAt)
A timestamp that indicates when the rule was created.
|
void |
setCreatedBy(String createdBy)
The principal that created a rule.
|
void |
setDescription(String description)
A description of the rule.
|
void |
setIsTerminal(Boolean isTerminal)
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
|
void |
setRuleArn(String ruleArn)
The Amazon Resource Name (ARN) for the rule.
|
void |
setRuleName(String ruleName)
The name of the rule.
|
void |
setRuleOrder(Integer ruleOrder)
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
|
void |
setRuleStatus(String ruleStatus)
Whether the rule is active after it is created.
|
void |
setUpdatedAt(Date updatedAt)
A timestamp that indicates when the rule was most recently updated.
|
String |
toString()
Returns a string representation of this object.
|
AutomationRulesMetadata |
withCreatedAt(Date createdAt)
A timestamp that indicates when the rule was created.
|
AutomationRulesMetadata |
withCreatedBy(String createdBy)
The principal that created a rule.
|
AutomationRulesMetadata |
withDescription(String description)
A description of the rule.
|
AutomationRulesMetadata |
withIsTerminal(Boolean isTerminal)
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
|
AutomationRulesMetadata |
withRuleArn(String ruleArn)
The Amazon Resource Name (ARN) for the rule.
|
AutomationRulesMetadata |
withRuleName(String ruleName)
The name of the rule.
|
AutomationRulesMetadata |
withRuleOrder(Integer ruleOrder)
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
|
AutomationRulesMetadata |
withRuleStatus(RuleStatus ruleStatus)
Whether the rule is active after it is created.
|
AutomationRulesMetadata |
withRuleStatus(String ruleStatus)
Whether the rule is active after it is created.
|
AutomationRulesMetadata |
withUpdatedAt(Date updatedAt)
A timestamp that indicates when the rule was most recently updated.
|
public void setRuleArn(String ruleArn)
The Amazon Resource Name (ARN) for the rule.
ruleArn
- The Amazon Resource Name (ARN) for the rule.public String getRuleArn()
The Amazon Resource Name (ARN) for the rule.
public AutomationRulesMetadata withRuleArn(String ruleArn)
The Amazon Resource Name (ARN) for the rule.
ruleArn
- The Amazon Resource Name (ARN) for the rule.public void setRuleStatus(String ruleStatus)
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
.
ruleStatus
- 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
.RuleStatus
public String getRuleStatus()
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
.
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
.RuleStatus
public AutomationRulesMetadata withRuleStatus(String ruleStatus)
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
.
ruleStatus
- 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
.RuleStatus
public AutomationRulesMetadata withRuleStatus(RuleStatus ruleStatus)
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
.
ruleStatus
- 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
.RuleStatus
public void setRuleOrder(Integer ruleOrder)
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.
ruleOrder
- 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.public Integer getRuleOrder()
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.
public AutomationRulesMetadata withRuleOrder(Integer ruleOrder)
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.
ruleOrder
- 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.public void setRuleName(String ruleName)
The name of the rule.
ruleName
- The name of the rule.public String getRuleName()
The name of the rule.
public AutomationRulesMetadata withRuleName(String ruleName)
The name of the rule.
ruleName
- The name of the rule.public void setDescription(String description)
A description of the rule.
description
- A description of the rule.public String getDescription()
A description of the rule.
public AutomationRulesMetadata withDescription(String description)
A description of the rule.
description
- A description of the rule.public void setIsTerminal(Boolean isTerminal)
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.
isTerminal
- 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.public Boolean getIsTerminal()
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.
public AutomationRulesMetadata withIsTerminal(Boolean isTerminal)
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.
isTerminal
- 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.public Boolean isTerminal()
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.
public void setCreatedAt(Date createdAt)
A timestamp that indicates when the rule was created.
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9
digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example, 2024-01-04T15:25:10.123456789+17:59
)
createdAt
- A timestamp that indicates when the rule was created.
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a
maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,
2024-01-04T15:25:10.123456789+17:59
)
public Date getCreatedAt()
A timestamp that indicates when the rule was created.
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9
digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example, 2024-01-04T15:25:10.123456789+17:59
)
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a
maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,
2024-01-04T15:25:10.123456789+17:59
)
public AutomationRulesMetadata withCreatedAt(Date createdAt)
A timestamp that indicates when the rule was created.
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9
digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example, 2024-01-04T15:25:10.123456789+17:59
)
createdAt
- A timestamp that indicates when the rule was created.
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a
maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,
2024-01-04T15:25:10.123456789+17:59
)
public void setUpdatedAt(Date updatedAt)
A timestamp that indicates when the rule was most recently updated.
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9
digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example, 2024-01-04T15:25:10.123456789+17:59
)
updatedAt
- A timestamp that indicates when the rule was most recently updated.
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a
maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,
2024-01-04T15:25:10.123456789+17:59
)
public Date getUpdatedAt()
A timestamp that indicates when the rule was most recently updated.
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9
digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example, 2024-01-04T15:25:10.123456789+17:59
)
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a
maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,
2024-01-04T15:25:10.123456789+17:59
)
public AutomationRulesMetadata withUpdatedAt(Date updatedAt)
A timestamp that indicates when the rule was most recently updated.
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9
digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example, 2024-01-04T15:25:10.123456789+17:59
)
updatedAt
- A timestamp that indicates when the rule was most recently updated.
This field accepts only the specified formats. Timestamps can end with Z
or
("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a
maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
YYYY-MM-DDTHH:MM:SSZ
(for example, 2019-01-31T23:00:00Z
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example, 2019-01-31T23:00:00.123456789Z
)
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example, 2024-01-04T15:25:10+17:59
)
YYYY-MM-DDTHH:MM:SS-HHMM
(for example, 2024-01-04T15:25:10-1759
)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,
2024-01-04T15:25:10.123456789+17:59
)
public void setCreatedBy(String createdBy)
The principal that created a rule.
createdBy
- The principal that created a rule.public String getCreatedBy()
The principal that created a rule.
public AutomationRulesMetadata withCreatedBy(String createdBy)
The principal that created a rule.
createdBy
- The principal that created a rule.public String toString()
toString
in class Object
Object.toString()
public AutomationRulesMetadata clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.