java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest
    - - software.amazon.awssdk.services.networkfirewall.model.UpdateRuleGroupRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateRuleGroupRequest.Builder,UpdateRuleGroupRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateRuleGroupRequest
extends NetworkFirewallRequest
implements ToCopyableBuilder<UpdateRuleGroupRequest.Builder,UpdateRuleGroupRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateRuleGroupRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`analyzeRuleGroup()`	Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing.
`static UpdateRuleGroupRequest.Builder`	`builder()`
`String`	`description()`	A description of the rule group.
`Boolean`	`dryRun()`	Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
`EncryptionConfiguration`	`encryptionConfiguration()`	A complex type that contains settings for encryption of your rule group resources.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`RuleGroup`	`ruleGroup()`	An object that defines the rule group rules.
`String`	`ruleGroupArn()`	The Amazon Resource Name (ARN) of the rule group.
`String`	`ruleGroupName()`	The descriptive name of the rule group.
`String`	`rules()`	A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateRuleGroupRequest.Builder>`	`serializableBuilderClass()`
`SourceMetadata`	`sourceMetadata()`	A complex type that contains metadata about the rule group that your own rule group is copied from.
`UpdateRuleGroupRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`RuleGroupType`	`type()`	Indicates whether the rule group is stateless or stateful.
`String`	`typeAsString()`	Indicates whether the rule group is stateless or stateful.
`String`	`updateToken()`	A token used for optimistic locking.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - updateToken
```
public final 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.
    
    Returns:
    
    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.
  - ruleGroupArn
```
public final String ruleGroupArn()
```
    The Amazon Resource Name (ARN) of the rule group.
    
    You must specify the ARN or the name, and you can specify both.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the rule group.
    
    You must specify the ARN or the name, and you can specify both.
  - ruleGroupName
```
public final 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.
    
    Returns:
    
    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.
  - ruleGroup
```
public final 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.
    
    Returns:
    
    An object that defines the rule group rules.
    
    You must provide either this rule group setting or a Rules setting, but not both.
  - rules
```
public final 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.
    
    Returns:
    
    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.
  - type
```
public final 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.
    
    This setting is required for requests that do not include the RuleGroupARN.
    
    If the service returns an enum value that is not available in the current SDK version, type will return RuleGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    RuleGroupType
  - typeAsString
```
public final String typeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, type will return RuleGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    RuleGroupType
  - description
```
public final String description()
```
    A description of the rule group.
    
    Returns:
    
    A description of the rule group.
  - dryRun
```
public final 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.
    
    Returns:
    
    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.
  - encryptionConfiguration
```
public final EncryptionConfiguration encryptionConfiguration()
```
    A complex type that contains settings for encryption of your rule group resources.
    
    Returns:
    
    A complex type that contains settings for encryption of your rule group resources.
  - sourceMetadata
```
public final 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.
    
    Returns:
    
    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.
  - analyzeRuleGroup
```
public final 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.
    
    Returns:
    
    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.
  - toBuilder
```
public UpdateRuleGroupRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateRuleGroupRequest.Builder,UpdateRuleGroupRequest>
    
    Specified by:
    
    toBuilder in class NetworkFirewallRequest
  - builder
```
public static UpdateRuleGroupRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateRuleGroupRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateRuleGroupRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

updateToken

ruleGroupArn

ruleGroupName

ruleGroup

rules

type

typeAsString

description

dryRun

encryptionConfiguration

sourceMetadata

analyzeRuleGroup

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields