ProxySettings
The proxy settings of a proxy mode firewall: the ports and protocols on which the firewall's proxy listens for traffic, and optionally your own domain name and certificate.
Contents
- ListenerProperties
-
The listeners of the firewall's proxy. Specify at least one listener, and at most one HTTP listener and one HTTPS listener. Each listener needs a port from 1 to 65535, and the two listeners must use different ports.
If you don't specify listeners when you create the firewall, the firewall listens for HTTP on port 3128 and HTTPS on port 8443.
Type: Array of ListenerProperty objects
Required: Yes
- CertificateArn
-
The Amazon Resource Name (ARN) of the certificate that the firewall's HTTPS proxy listener presents to clients. The certificate must be an Amazon Certificate Manager (ACM) certificate in the same account and Region as the firewall. Its subject alternative names must cover
DomainName, either exactly or with a wildcard that matches exactly one label. For example,*.example.comcoversproxy.example.com. If you don't specify this, Network Firewall uses a certificate that it manages for a domain name that it generates.You manage and renew the certificate in ACM, and Network Firewall uses renewed certificates automatically. While the firewall uses the certificate, you can't delete it from ACM. Your clients must trust the certificate's certificate authority.
If you specify
CertificateArn, you must also specifyDomainName. You can set them only when you create the firewall. When you callUpdateProxySettings, specify the same values.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^arn:aws.*Required: No
- DomainName
-
The domain name that your clients use to reach the firewall's proxy. The name must have at least two labels and at most 253 characters. It can't contain a wildcard or use the
proxy-id.nfw.region.amazonaws.comformat, and the certificate inCertificateArnmust cover it. If you don't specify this, Network Firewall generates a domain name.Network Firewall creates the Route 53 private hosted zones that resolve this name to the firewall endpoints, so you don't need to configure DNS. A VPC can have only one private hosted zone with a given name. If a VPC that the firewall serves already has one with this name, Network Firewall can't set up the Availability Zones in that VPC.
If you specify
DomainName, you must also specifyCertificateArn. You can set them only when you create the firewall. When you callUpdateProxySettings, specify the same values.Type: String
Length Constraints: Minimum length of 1. Maximum length of 253.
Pattern:
^[A-Za-z0-9][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: