View a markdown version of this page

NatGatewayAttachment - Amazon Network Firewall
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

NatGatewayAttachment

The definition and status of the attachment between a proxy mode firewall and a NAT gateway that proxies its traffic.

Contents

NatGatewayId

A unique identifier for the NAT gateway to use with proxy resources.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Status

The current status of the NAT gateway attachment.

When this value is READY, the attachment is available to proxy traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.

Type: String

Valid Values: CREATING | READY | UPDATING | FAILED | DELETING

Required: Yes

DnsName

The DNS name that resolves to the firewall's proxy for traffic sent through this NAT gateway attachment.

Type: String

Required: No

StatusMessage

If Network Firewall encounters an issue with the NAT gateway attachment, it populates this with an explanation of the problem.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9- ]+$

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: