Interface UpdateFirewallDescriptionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<UpdateFirewallDescriptionRequest.Builder,,UpdateFirewallDescriptionRequest> NetworkFirewallRequest.Builder,SdkBuilder<UpdateFirewallDescriptionRequest.Builder,,UpdateFirewallDescriptionRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
UpdateFirewallDescriptionRequest
-
Method Summary
Modifier and TypeMethodDescriptiondescription(String description) The new description for the firewall.firewallArn(String firewallArn) The Amazon Resource Name (ARN) of the firewall.firewallName(String firewallName) The descriptive name of the firewall.firewallType(String firewallType) The type of firewall that the request targets.firewallType(FirewallType firewallType) The type of firewall that the request targets.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.updateToken(String updateToken) An optional token that you can use for optimistic locking.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
updateToken
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.- Parameters:
updateToken- An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new 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.
-
firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- Parameters:
firewallArn- The Amazon Resource Name (ARN) of the firewall.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.
-
firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
- Parameters:
firewallName- The descriptive name of the firewall. You can't change the name of a firewall 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.
-
description
The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.
- Parameters:
description- The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
firewallType
The type of firewall that the request targets. Network Firewall supports the following firewall types:
-
IGW_FIREWALL- An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC. -
FIREWALL- A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is
FIREWALL.- Parameters:
firewallType- The type of firewall that the request targets. Network Firewall supports the following firewall types:-
IGW_FIREWALL- An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC. -
FIREWALL- A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is
FIREWALL.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
firewallType
The type of firewall that the request targets. Network Firewall supports the following firewall types:
-
IGW_FIREWALL- An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC. -
FIREWALL- A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is
FIREWALL.- Parameters:
firewallType- The type of firewall that the request targets. Network Firewall supports the following firewall types:-
IGW_FIREWALL- An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC. -
FIREWALL- A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is
FIREWALL.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
overrideConfiguration
UpdateFirewallDescriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateFirewallDescriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-