Interface DescribeRuleGroupMetadataRequest.Builder

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

  • Method Details

    • ruleGroupName

      DescribeRuleGroupMetadataRequest.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

      DescribeRuleGroupMetadataRequest.Builder ruleGroupArn(String ruleGroupArn)

      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:
      ruleGroupArn - 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.

    • type

      DescribeRuleGroupMetadataRequest.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

      DescribeRuleGroupMetadataRequest.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:

    • overrideConfiguration

      DescribeRuleGroupMetadataRequest.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

      DescribeRuleGroupMetadataRequest.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.