Interface DescribeRuleGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeRuleGroupRequest.Builder,DescribeRuleGroupRequest>, NetworkFirewallRequest.Builder, SdkBuilder<DescribeRuleGroupRequest.Builder,DescribeRuleGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeRuleGroupRequest
@Mutable @NotThreadSafe public static interface DescribeRuleGroupRequest.Builder extends NetworkFirewallRequest.Builder, SdkPojo, CopyableBuilder<DescribeRuleGroupRequest.Builder,DescribeRuleGroupRequest>

  • Method Details

    • ruleGroupName

      DescribeRuleGroupRequest.Builder ruleGroupName(String ruleGroupName)

      The descriptive name of the rule group. You can't change the name of a rule group after you create it.

      You must specify the ARN or the name, and you can specify both.

      Parameters:
      ruleGroupName - The descriptive name of the rule group. You can't change the name of a rule group after you create it.

      You must specify the ARN or the name, and you can specify both.

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

    • ruleGroupArn

      DescribeRuleGroupRequest.Builder ruleGroupArn(String ruleGroupArn)

      The Amazon Resource Name (ARN) of the rule group.

      You must specify the ARN or the name, and you can specify both.

      Parameters:
      ruleGroupArn - The Amazon Resource Name (ARN) of the rule group.

      You must specify the ARN or the name, and you can specify both.

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

    • type

      DescribeRuleGroupRequest.Builder type(String type)

      Indicates the type of the rule group. Valid values are:

      • STATELESS - Stateless rules, for use in a Classic Network Firewall policy.

      • STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.

      • FIREWALL - Firewall engine rules, for use in a Next Generation policy.

      • IPS - IPS engine rules, for use in a Next Generation policy.

      This setting is required for requests that do not include the RuleGroupARN.

      Parameters:
      type - Indicates the type of the rule group. Valid values are:

      • STATELESS - Stateless rules, for use in a Classic Network Firewall policy.

      • STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.

      • FIREWALL - Firewall engine rules, for use in a Next Generation policy.

      • IPS - IPS engine rules, for use in a Next Generation policy.

      This setting is required for requests that do not include the RuleGroupARN.

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

    • type

      DescribeRuleGroupRequest.Builder type(RuleGroupType type)

      Indicates the type of the rule group. Valid values are:

      • STATELESS - Stateless rules, for use in a Classic Network Firewall policy.

      • STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.

      • FIREWALL - Firewall engine rules, for use in a Next Generation policy.

      • IPS - IPS engine rules, for use in a Next Generation policy.

      This setting is required for requests that do not include the RuleGroupARN.

      Parameters:
      type - Indicates the type of the rule group. Valid values are:

      • STATELESS - Stateless rules, for use in a Classic Network Firewall policy.

      • STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.

      • FIREWALL - Firewall engine rules, for use in a Next Generation policy.

      • IPS - IPS engine rules, for use in a Next Generation policy.

      This setting is required for requests that do not include the RuleGroupARN.

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

    • analyzeRuleGroup

      DescribeRuleGroupRequest.Builder analyzeRuleGroup(Boolean analyzeRuleGroup)

      Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis.

      Parameters:
      analyzeRuleGroup - Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleOutputFormat

      DescribeRuleGroupRequest.Builder ruleOutputFormat(String ruleOutputFormat)

      For a firewall engine rule group, the format in which to return the rules. Specify one of the following values:

      • FIREWALL_RULES - Returns the rules as structured FirewallRule objects.

      • RULES_STRING - Returns the rules as a Suricata-compatible firewall-mode rule string.

      If you don't specify a format, Network Firewall returns the rules in the format you provided them in. This setting applies only to FIREWALL and IPS rule groups; IPS engine rule groups support only RULES_STRING.

      Parameters:
      ruleOutputFormat - For a firewall engine rule group, the format in which to return the rules. Specify one of the following values:

      • FIREWALL_RULES - Returns the rules as structured FirewallRule objects.

      • RULES_STRING - Returns the rules as a Suricata-compatible firewall-mode rule string.

      If you don't specify a format, Network Firewall returns the rules in the format you provided them in. This setting applies only to FIREWALL and IPS rule groups; IPS engine rule groups support only RULES_STRING.

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

    • ruleOutputFormat

      DescribeRuleGroupRequest.Builder ruleOutputFormat(RuleOutputFormat ruleOutputFormat)

      For a firewall engine rule group, the format in which to return the rules. Specify one of the following values:

      • FIREWALL_RULES - Returns the rules as structured FirewallRule objects.

      • RULES_STRING - Returns the rules as a Suricata-compatible firewall-mode rule string.

      If you don't specify a format, Network Firewall returns the rules in the format you provided them in. This setting applies only to FIREWALL and IPS rule groups; IPS engine rule groups support only RULES_STRING.

      Parameters:
      ruleOutputFormat - For a firewall engine rule group, the format in which to return the rules. Specify one of the following values:

      • FIREWALL_RULES - Returns the rules as structured FirewallRule objects.

      • RULES_STRING - Returns the rules as a Suricata-compatible firewall-mode rule string.

      If you don't specify a format, Network Firewall returns the rules in the format you provided them in. This setting applies only to FIREWALL and IPS rule groups; IPS engine rule groups support only RULES_STRING.

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

    • overrideConfiguration

      DescribeRuleGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeRuleGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.