com.amazonaws.services.networkfirewall.model

Class UpdateFirewallPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.networkfirewall.model.UpdateFirewallPolicyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateFirewallPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateFirewallPolicyRequest()

Method Summary

Modifier and Type	Method and Description
UpdateFirewallPolicyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() A description of the firewall policy.
Boolean	getDryRun() Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
EncryptionConfiguration	getEncryptionConfiguration() A complex type that contains settings for encryption of your firewall policy resources.
FirewallPolicy	getFirewallPolicy() The updated firewall policy to use for the firewall.
String	getFirewallPolicyArn() The Amazon Resource Name (ARN) of the firewall policy.
String	getFirewallPolicyName() The descriptive name of the firewall policy.
String	getUpdateToken() A token used for optimistic locking.
int	hashCode()
Boolean	isDryRun() Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
void	setDescription(String description) A description of the firewall policy.
void	setDryRun(Boolean dryRun) Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
void	setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration) A complex type that contains settings for encryption of your firewall policy resources.
void	setFirewallPolicy(FirewallPolicy firewallPolicy) The updated firewall policy to use for the firewall.
void	setFirewallPolicyArn(String firewallPolicyArn) The Amazon Resource Name (ARN) of the firewall policy.
void	setFirewallPolicyName(String firewallPolicyName) The descriptive name of the firewall policy.
void	setUpdateToken(String updateToken) A token used for optimistic locking.
String	toString() Returns a string representation of this object.
UpdateFirewallPolicyRequest	withDescription(String description) A description of the firewall policy.
UpdateFirewallPolicyRequest	withDryRun(Boolean dryRun) Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
UpdateFirewallPolicyRequest	withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration) A complex type that contains settings for encryption of your firewall policy resources.
UpdateFirewallPolicyRequest	withFirewallPolicy(FirewallPolicy firewallPolicy) The updated firewall policy to use for the firewall.
UpdateFirewallPolicyRequest	withFirewallPolicyArn(String firewallPolicyArn) The Amazon Resource Name (ARN) of the firewall policy.
UpdateFirewallPolicyRequest	withFirewallPolicyName(String firewallPolicyName) The descriptive name of the firewall policy.
UpdateFirewallPolicyRequest	withUpdateToken(String updateToken) A token used for optimistic locking.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateFirewallPolicyRequest

public UpdateFirewallPolicyRequest()

Method Detail

setUpdateToken

public void setUpdateToken(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.

Parameters:

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.

getUpdateToken

public String getUpdateToken()

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.

withUpdateToken

public UpdateFirewallPolicyRequest withUpdateToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setFirewallPolicyArn

public void setFirewallPolicyArn(String firewallPolicyArn)

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

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

Parameters:

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

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

getFirewallPolicyArn

public String getFirewallPolicyArn()

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.

withFirewallPolicyArn

public UpdateFirewallPolicyRequest withFirewallPolicyArn(String firewallPolicyArn)

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

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

Parameters:

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

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.

setFirewallPolicyName

public void setFirewallPolicyName(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.

Parameters:

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.

getFirewallPolicyName

public String getFirewallPolicyName()

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.

withFirewallPolicyName

public UpdateFirewallPolicyRequest withFirewallPolicyName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setFirewallPolicy

public void setFirewallPolicy(FirewallPolicy firewallPolicy)

The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

Parameters:

firewallPolicy - The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

getFirewallPolicy

public FirewallPolicy getFirewallPolicy()

The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

Returns:

The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

withFirewallPolicy

public UpdateFirewallPolicyRequest withFirewallPolicy(FirewallPolicy firewallPolicy)

The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

Parameters:

firewallPolicy - The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A description of the firewall policy.

Parameters:

description - A description of the firewall policy.

getDescription

public String getDescription()

A description of the firewall policy.

Returns:

A description of the firewall policy.

withDescription

public UpdateFirewallPolicyRequest withDescription(String description)

A description of the firewall policy.

Parameters:

description - A description of the firewall policy.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDryRun

public void setDryRun(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.

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.

getDryRun

public Boolean getDryRun()

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.

withDryRun

public UpdateFirewallPolicyRequest withDryRun(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.

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.

isDryRun

public Boolean isDryRun()

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.

setEncryptionConfiguration

public void setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

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

Parameters:

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

getEncryptionConfiguration

public EncryptionConfiguration getEncryptionConfiguration()

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.

withEncryptionConfiguration

public UpdateFirewallPolicyRequest withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateFirewallPolicyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()