Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.NetworkFirewall.Types.Attachment

Description

Synopsis

data Attachment = Attachment' {
- endpointId :: Maybe Text
- status :: Maybe AttachmentStatus
- statusMessage :: Maybe Text
- subnetId :: Maybe Text
}
newAttachment :: Attachment
attachment_endpointId :: Lens' Attachment (Maybe Text)
attachment_status :: Lens' Attachment (Maybe AttachmentStatus)
attachment_statusMessage :: Lens' Attachment (Maybe Text)
attachment_subnetId :: Lens' Attachment (Maybe Text)

Documentation

data Attachment Source #

The configuration and status for a single subnet that you've specified for use by the Network Firewall firewall. This is part of the FirewallStatus.

See: newAttachment smart constructor.

Constructors

Attachment'

Fields

endpointId :: Maybe Text
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.
status :: Maybe AttachmentStatus
The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this value is READY, the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or DELETING.
statusMessage :: Maybe Text
If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the failure and how to resolve it. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
subnetId :: Maybe Text
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.

Instances

Instances details

FromJSON Attachment Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.Attachment Methods parseJSON :: Value -> Parser Attachment # parseJSONList :: Value -> Parser [Attachment] #
Generic Attachment Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.Attachment Associated Types type Rep Attachment :: Type -> Type # Methods from :: Attachment -> Rep Attachment x # to :: Rep Attachment x -> Attachment #
Read Attachment Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.Attachment Methods readsPrec :: Int -> ReadS Attachment # readList :: ReadS [Attachment] # readPrec :: ReadPrec Attachment # readListPrec :: ReadPrec [Attachment] #
Show Attachment Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.Attachment Methods showsPrec :: Int -> Attachment -> ShowS # show :: Attachment -> String # showList :: [Attachment] -> ShowS #
NFData Attachment Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.Attachment Methods rnf :: Attachment -> () #
Eq Attachment Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.Attachment Methods (==) :: Attachment -> Attachment -> Bool # (/=) :: Attachment -> Attachment -> Bool #
Hashable Attachment Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.Attachment Methods hashWithSalt :: Int -> Attachment -> Int # hash :: Attachment -> Int #
type Rep Attachment Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.Attachment type Rep Attachment = D1 ('MetaData "Attachment" "Amazonka.NetworkFirewall.Types.Attachment" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "Attachment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttachmentStatus))) :: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newAttachment :: Attachment Source #

Create a value of Attachment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointId:Attachment', attachment_endpointId - 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.

$sel:status:Attachment', attachment_status - The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this value is READY, the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or DELETING.

$sel:statusMessage:Attachment', attachment_statusMessage - If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the failure and how to resolve it. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.

$sel:subnetId:Attachment', attachment_subnetId - The unique identifier of the subnet that you've specified to be used for a firewall endpoint.

attachment_endpointId :: Lens' Attachment (Maybe Text) Source #

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.

attachment_status :: Lens' Attachment (Maybe AttachmentStatus) Source #

The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this value is READY, the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or DELETING.

attachment_statusMessage :: Lens' Attachment (Maybe Text) Source #

If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the failure and how to resolve it. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.

attachment_subnetId :: Lens' Attachment (Maybe Text) Source #

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