Package software.amazon.awssdk.services.securityhub.model

Interface AutomationRulesMetadata.Builder

    • Method Detail

      • ruleArn

        AutomationRulesMetadata.Builder ruleArn​(String ruleArn)

        The Amazon Resource Name (ARN) for the rule.

        Parameters:
        ruleArn - The Amazon Resource Name (ARN) for the rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ruleStatus

        AutomationRulesMetadata.Builder ruleStatus​(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 .

        Parameters:
        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 .
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RuleStatus, RuleStatus

      • ruleStatus

        AutomationRulesMetadata.Builder ruleStatus​(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 .

        Parameters:
        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 .
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RuleStatus, RuleStatus

      • ruleOrder

        AutomationRulesMetadata.Builder ruleOrder​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ruleName

        AutomationRulesMetadata.Builder ruleName​(String ruleName)

        The name of the rule.

        Parameters:
        ruleName - The name of the rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        AutomationRulesMetadata.Builder description​(String description)

        A description of the rule.

        Parameters:
        description - A description of the rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isTerminal

        AutomationRulesMetadata.Builder isTerminal​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdAt

        AutomationRulesMetadata.Builder createdAt​(Instant createdAt)

        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.

        Parameters:
        createdAt - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • updatedAt

        AutomationRulesMetadata.Builder updatedAt​(Instant updatedAt)

        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.

        Parameters:
        updatedAt - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdBy

        AutomationRulesMetadata.Builder createdBy​(String createdBy)

        The principal that created a rule.

        Parameters:
        createdBy - The principal that created a rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.