public static interface UpdateRuleGroupRequest.Builder extends NetworkFirewallRequest.Builder, SdkPojo, CopyableBuilder<UpdateRuleGroupRequest.Builder,UpdateRuleGroupRequest>
| Modifier and Type | Method and Description |
|---|---|
UpdateRuleGroupRequest.Builder |
description(String description)
A description of the rule group.
|
UpdateRuleGroupRequest.Builder |
dryRun(Boolean dryRun)
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the
request.
|
default UpdateRuleGroupRequest.Builder |
encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)
A complex type that contains settings for encryption of your rule group resources.
|
UpdateRuleGroupRequest.Builder |
encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
A complex type that contains settings for encryption of your rule group resources.
|
UpdateRuleGroupRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
UpdateRuleGroupRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default UpdateRuleGroupRequest.Builder |
ruleGroup(Consumer<RuleGroup.Builder> ruleGroup)
An object that defines the rule group rules.
|
UpdateRuleGroupRequest.Builder |
ruleGroup(RuleGroup ruleGroup)
An object that defines the rule group rules.
|
UpdateRuleGroupRequest.Builder |
ruleGroupArn(String ruleGroupArn)
The Amazon Resource Name (ARN) of the rule group.
|
UpdateRuleGroupRequest.Builder |
ruleGroupName(String ruleGroupName)
The descriptive name of the rule group.
|
UpdateRuleGroupRequest.Builder |
rules(String rules)
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line.
|
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.
|
UpdateRuleGroupRequest.Builder |
sourceMetadata(SourceMetadata sourceMetadata)
A complex type that contains metadata about the rule group that your own rule group is copied from.
|
UpdateRuleGroupRequest.Builder |
type(RuleGroupType type)
Indicates whether the rule group is stateless or stateful.
|
UpdateRuleGroupRequest.Builder |
type(String type)
Indicates whether the rule group is stateless or stateful.
|
UpdateRuleGroupRequest.Builder |
updateToken(String updateToken)
A token used for optimistic locking.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildUpdateRuleGroupRequest.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.
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.
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.
ruleGroupArn - The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
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.
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.
UpdateRuleGroupRequest.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.
ruleGroup - An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
default UpdateRuleGroupRequest.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.
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).
ruleGroup - a consumer that will call methods on RuleGroup.BuilderruleGroup(RuleGroup)UpdateRuleGroupRequest.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.
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.
UpdateRuleGroupRequest.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.
This setting is required for requests that do not include the RuleGroupARN.
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.
RuleGroupType,
RuleGroupTypeUpdateRuleGroupRequest.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.
This setting is required for requests that do not include the RuleGroupARN.
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.
RuleGroupType,
RuleGroupTypeUpdateRuleGroupRequest.Builder description(String description)
A description of the rule group.
description - A description of the rule group.UpdateRuleGroupRequest.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.
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.
UpdateRuleGroupRequest.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
A complex type that contains settings for encryption of your rule group resources.
encryptionConfiguration - A complex type that contains settings for encryption of your rule group resources.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 theEncryptionConfiguration.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).
encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.BuilderencryptionConfiguration(EncryptionConfiguration)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.
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.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 theSourceMetadata.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).
sourceMetadata - a consumer that will call methods on SourceMetadata.BuildersourceMetadata(SourceMetadata)UpdateRuleGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderUpdateRuleGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.