Class: Aws::NetworkFirewall::Types::Attachment

Inherits:

Struct

• Object
• Struct
• Aws::NetworkFirewall::Types::Attachment

Includes:

Structure

Defined in:

lib/aws-sdk-networkfirewall/types.rb

Overview

The definition and status of the firewall endpoint for a single subnet. In each configured subnet, Network Firewall instantiates a firewall endpoint to handle network traffic.

This data type is used for any firewall endpoint type:

• For ‘Firewall.SubnetMappings`, this `Attachment` is part of the `FirewallStatus` sync states information. You define firewall subnets using `CreateFirewall` and `AssociateSubnets`.

• For ‘VpcEndpointAssociation`, this `Attachment` is part of the `VpcEndpointAssociationStatus` sync states information. You define these subnets using `CreateVpcEndpointAssociation`.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #endpoint_id ⇒ String

  The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet.

• #status ⇒ String

  The current status of the firewall endpoint instantiation in the subnet.

• #status_message ⇒ String

  If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it.

• #subnet_id ⇒ String

  The unique identifier of the subnet that you’ve specified to be used for a firewall endpoint.

Instance Attribute Details

#endpoint_id ⇒ String

The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.

Returns:

• (String)

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

class Attachment < Struct.new(
  :subnet_id,
  :endpoint_id,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the firewall endpoint instantiation in the subnet.

When this value is ‘READY`, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example `CREATING` or `DELETING`.

Returns:

• (String)

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

class Attachment < Struct.new(
  :subnet_id,
  :endpoint_id,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A ‘FAILED` status indicates a non-recoverable state, and a `ERROR` status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see [Troubleshooting firewall endpoint failures] in the *Network Firewall Developer Guide*.

[1]: docs.aws.amazon.com/network-firewall/latest/developerguide/firewall-troubleshooting-endpoint-failures.html

Returns:

• (String)

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

class Attachment < Struct.new(
  :subnet_id,
  :endpoint_id,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_id ⇒ String

The unique identifier of the subnet that you’ve specified to be used for a firewall endpoint.

Returns:

• (String)

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

class Attachment < Struct.new(
  :subnet_id,
  :endpoint_id,
  :status,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end