Interface UpdateRuleGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateRuleGroupRequest.Builder,UpdateRuleGroupRequest>, NetworkFirewallRequest.Builder, SdkBuilder<UpdateRuleGroupRequest.Builder,UpdateRuleGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateRuleGroupRequest

public static interface UpdateRuleGroupRequest.Builder extends NetworkFirewallRequest.Builder, SdkPojo, CopyableBuilder<UpdateRuleGroupRequest.Builder,UpdateRuleGroupRequest>
  • Method Details

    • updateToken

      UpdateRuleGroupRequest.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.
    • ruleGroupArn

      UpdateRuleGroupRequest.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.
    • ruleGroupName

      UpdateRuleGroupRequest.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.
    • 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

      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

      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

      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.

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

      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.

      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

      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.

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

      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.

      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:
    • description

      UpdateRuleGroupRequest.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.
    • 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

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

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

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

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

      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.