Package software.amazon.awssdk.services.networkfirewall.model

Interface DescribeRuleGroupResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeRuleGroupResponse.Builder,DescribeRuleGroupResponse>, NetworkFirewallResponse.Builder, SdkBuilder<DescribeRuleGroupResponse.Builder,DescribeRuleGroupResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeRuleGroupResponse
public static interface DescribeRuleGroupResponse.Builder extends NetworkFirewallResponse.Builder, SdkPojo, CopyableBuilder<DescribeRuleGroupResponse.Builder,DescribeRuleGroupResponse>

  • Method Details

    • updateToken

      DescribeRuleGroupResponse.Builder updateToken(String updateToken)

      A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

      To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

      Parameters:
      updateToken - A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

      To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

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

    • ruleGroup

      DescribeRuleGroupResponse.Builder ruleGroup(RuleGroup ruleGroup)

      The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

      Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.

      To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.

      Parameters:
      ruleGroup - The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

      Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.

      To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.

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

    • ruleGroup

      default DescribeRuleGroupResponse.Builder ruleGroup(Consumer<RuleGroup.Builder> ruleGroup)

      The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

      Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.

      To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.

      This is a convenience method that creates an instance of the RuleGroup.Builder avoiding the need to create one manually via RuleGroup.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ruleGroup(RuleGroup).

      Parameters:
      ruleGroup - a consumer that will call methods on RuleGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ruleGroupResponse

      DescribeRuleGroupResponse.Builder ruleGroupResponse(RuleGroupResponse ruleGroupResponse)

      The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

      Parameters:
      ruleGroupResponse - The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleGroupResponse

      default DescribeRuleGroupResponse.Builder ruleGroupResponse(Consumer<RuleGroupResponse.Builder> ruleGroupResponse)

      The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

      This is a convenience method that creates an instance of the RuleGroupResponse.Builder avoiding the need to create one manually via RuleGroupResponse.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ruleGroupResponse(RuleGroupResponse).

      Parameters:
      ruleGroupResponse - a consumer that will call methods on RuleGroupResponse.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: