Class: Aws::NetworkFirewall::Types::UpdateFirewallDescriptionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb

Overview

Note:

When making an API call, you may pass UpdateFirewallDescriptionRequest data as a hash:

{
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  description: "Description",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.

Returns:

  • (String)


4626
4627
4628
4629
4630
4631
4632
4633
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4626

class UpdateFirewallDescriptionRequest < Struct.new(
  :update_token,
  :firewall_arn,
  :firewall_name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_arnString

The Amazon Resource Name (ARN) of the firewall.

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

Returns:

  • (String)


4626
4627
4628
4629
4630
4631
4632
4633
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4626

class UpdateFirewallDescriptionRequest < Struct.new(
  :update_token,
  :firewall_arn,
  :firewall_name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_nameString

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:

  • (String)


4626
4627
4628
4629
4630
4631
4632
4633
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4626

class UpdateFirewallDescriptionRequest < Struct.new(
  :update_token,
  :firewall_arn,
  :firewall_name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#update_tokenString

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:

  • (String)


4626
4627
4628
4629
4630
4631
4632
4633
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 4626

class UpdateFirewallDescriptionRequest < Struct.new(
  :update_token,
  :firewall_arn,
  :firewall_name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end