Class: Aws::NetworkFirewall::Types::DescribeFirewallResponse

Inherits:

Struct

• Object
• Struct
• Aws::NetworkFirewall::Types::DescribeFirewallResponse

Includes:

Structure

Defined in:

lib/aws-sdk-networkfirewall/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #firewall ⇒ Types::Firewall

  The configuration settings for the firewall.

• #firewall_status ⇒ Types::FirewallStatus

  Detailed information about the current status of a Firewall.

• #update_token ⇒ String

  An optional token that you can use for optimistic locking.

Instance Attribute Details

#firewall ⇒ Types::Firewall

The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

Returns:

• (Types::Firewall)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 1263

class DescribeFirewallResponse < Struct.new(
  :update_token,
  :firewall,
  :firewall_status)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_status ⇒ Types::FirewallStatus

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

Returns:

• (Types::FirewallStatus)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 1263

class DescribeFirewallResponse < Struct.new(
  :update_token,
  :firewall,
  :firewall_status)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-networkfirewall/types.rb', line 1263

class DescribeFirewallResponse < Struct.new(
  :update_token,
  :firewall,
  :firewall_status)
  SENSITIVE = []
  include Aws::Structure
end