You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::NetworkFirewall::Types::UpdateFirewallDescriptionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::NetworkFirewall::Types::UpdateFirewallDescriptionRequest
- Defined in:
- (unknown)
Overview
When passing UpdateFirewallDescriptionRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
update_token: "UpdateToken",
firewall_arn: "ResourceArn",
firewall_name: "ResourceName",
description: "Description",
}
Instance Attribute Summary collapse
-
#description ⇒ String
The new description for the firewall.
-
#firewall_arn ⇒ String
The Amazon Resource Name (ARN) of the firewall.
-
#firewall_name ⇒ String
The descriptive name of the firewall.
-
#update_token ⇒ String
An optional token that you can use for optimistic locking.
Instance Attribute Details
#description ⇒ String
The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.
#firewall_arn ⇒ String
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
#firewall_name ⇒ String
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.
#update_token ⇒ String
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.