Interface CreateRuleGroupRequest.Builder

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

  • Method Details

    • ruleGroupName

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

      Parameters:
      ruleGroupName - The descriptive name of the rule group. You can't change the name of a rule group after you create it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleGroup

      CreateRuleGroupRequest.Builder ruleGroup(RuleGroup ruleGroup)

      An object that defines the rule group rules.

      You must provide either this rule group setting or a Rules setting, but not both.

      Parameters:
      ruleGroup - An object that defines the rule group rules.

      You must provide either this rule group setting or a Rules setting, but not both.

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

    • ruleGroup

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

      An object that defines the rule group rules.

      You must provide either this rule group setting or a Rules setting, but not both.

      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:

    • rules

      CreateRuleGroupRequest.Builder rules(String rules)

      A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

      You must provide either this rules setting or a populated RuleGroup setting, but not both.

      You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

      Parameters:
      rules - A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

      You must provide either this rules setting or a populated RuleGroup setting, but not both.

      You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

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

    • type

      CreateRuleGroupRequest.Builder type(String type)

      Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

      Parameters:
      type - Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreateRuleGroupRequest.Builder type(RuleGroupType type)

      Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

      Parameters:
      type - Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateRuleGroupRequest.Builder description(String description)

      A description of the rule group.

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

    • capacity

      CreateRuleGroupRequest.Builder capacity(Integer capacity)

      The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

      You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

      You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.

      Capacity for a stateless rule group

      For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.

      To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:

      • A match setting with no criteria specified has a value of 1.

      • A match setting with Any specified has a value of 1.

      • All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.

      A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.

      Capacity for a stateful rule group

      For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.

      Parameters:
      capacity - The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

      You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

      You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.

      Capacity for a stateless rule group

      For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.

      To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:

      • A match setting with no criteria specified has a value of 1.

      • A match setting with Any specified has a value of 1.

      • All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.

      A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.

      Capacity for a stateful rule group

      For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.

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

    • tags

      CreateRuleGroupRequest.Builder tags(Collection<Tag> tags)

      The key:value pairs to associate with the resource.

      Parameters:
      tags - The key:value pairs to associate with the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateRuleGroupRequest.Builder tags(Tag... tags)

      The key:value pairs to associate with the resource.

      Parameters:
      tags - The key:value pairs to associate with the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateRuleGroupRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The key:value pairs to associate with the resource.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • dryRun

      CreateRuleGroupRequest.Builder dryRun(Boolean dryRun)

      Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

      If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

      If set to FALSE, Network Firewall makes the requested changes to your resources.

      Parameters:
      dryRun - Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

      If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

      If set to FALSE, Network Firewall makes the requested changes to your resources.

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

    • encryptionConfiguration

      CreateRuleGroupRequest.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

      A complex type that contains settings for encryption of your rule group resources.

      Parameters:
      encryptionConfiguration - A complex type that contains settings for encryption of your rule group resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfiguration

      default CreateRuleGroupRequest.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

      A complex type that contains settings for encryption of your rule group resources.

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

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

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

    • sourceMetadata

      CreateRuleGroupRequest.Builder sourceMetadata(SourceMetadata sourceMetadata)

      A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.

      Parameters:
      sourceMetadata - A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceMetadata

      default CreateRuleGroupRequest.Builder sourceMetadata(Consumer<SourceMetadata.Builder> sourceMetadata)

      A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.

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

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

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

    • analyzeRuleGroup

      CreateRuleGroupRequest.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 and then creates the rule group for you. To run the stateless rule group analyzer without creating the rule group, set DryRun to TRUE.

      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 and then creates the rule group for you. To run the stateless rule group analyzer without creating the rule group, set DryRun to TRUE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • summaryConfiguration

      CreateRuleGroupRequest.Builder summaryConfiguration(SummaryConfiguration summaryConfiguration)

      An object that contains a RuleOptions array of strings. You use RuleOptions to determine which of the following RuleSummary values are returned in response to DescribeRuleGroupSummary.

      • Metadata - returns

      • Msg

      • SID

      Parameters:
      summaryConfiguration - An object that contains a RuleOptions array of strings. You use RuleOptions to determine which of the following RuleSummary values are returned in response to DescribeRuleGroupSummary.

      • Metadata - returns

      • Msg

      • SID

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

    • summaryConfiguration

      default CreateRuleGroupRequest.Builder summaryConfiguration(Consumer<SummaryConfiguration.Builder> summaryConfiguration)

      An object that contains a RuleOptions array of strings. You use RuleOptions to determine which of the following RuleSummary values are returned in response to DescribeRuleGroupSummary.

      • Metadata - returns

      • Msg

      • SID

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

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

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

    • overrideConfiguration

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

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