software.amazon.awssdk.services.networkfirewall.model

Class UpdateFirewallPolicyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateFirewallPolicyRequest.Builder,UpdateFirewallPolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateFirewallPolicyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateFirewallPolicyRequest.Builder	builder()
String	description() A description of the firewall policy.
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 firewall policy resources.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FirewallPolicy	firewallPolicy() The updated firewall policy to use for the firewall.
String	firewallPolicyArn() The Amazon Resource Name (ARN) of the firewall policy.
String	firewallPolicyName() The descriptive name of the firewall policy.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateFirewallPolicyRequest.Builder>	serializableBuilderClass()
UpdateFirewallPolicyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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 firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with 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 firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

firewallPolicyArn

public final String firewallPolicyArn()

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

Returns:

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

firewallPolicyName

public final String firewallPolicyName()

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.

Returns:

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.

firewallPolicy

public final FirewallPolicy firewallPolicy()

The updated firewall policy to use for the firewall.

Returns:

The updated firewall policy to use for the firewall.

description

public final String description()

A description of the firewall policy.

Returns:

A description of the firewall policy.

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 firewall policy resources.

Returns:

A complex type that contains settings for encryption of your firewall policy resources.

toBuilder

public UpdateFirewallPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateFirewallPolicyRequest.Builder,UpdateFirewallPolicyRequest>

Specified by:

toBuilder in class NetworkFirewallRequest

builder

public static UpdateFirewallPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateFirewallPolicyRequest.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