2026/11/20 - AWS Network Firewall - 18 updated api methods
Changes Adds read-only support for internet gateway firewalls, which are created and managed by AWS Network Security Manager. Adds FirewallType to firewall operations and IgwFirewallConfiguration to Firewall.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Associates the specified Availability Zones with a transit gateway-attached firewall. For each Availability Zone, Network Firewall creates a firewall endpoint to process traffic. You can specify one or more Availability Zones where you want to deploy the firewall.
After adding Availability Zones, you must update your transit gateway route tables to direct traffic through the new firewall endpoints. Use DescribeFirewall to monitor the status of the new endpoints.
See also: AWS API Documentation
Request Syntax
client.associate_availability_zones(
UpdateToken='string',
FirewallArn='string',
FirewallName='string',
AvailabilityZoneMappings=[
{
'AvailabilityZone': 'string'
},
],
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
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.
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
list
[REQUIRED]
Required. The Availability Zones where you want to create firewall endpoints. You must specify at least one Availability Zone.
(dict) --
Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.
To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.
AvailabilityZone (string) -- [REQUIRED]
The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Response Syntax
{
'FirewallArn': 'string',
'FirewallName': 'string',
'AvailabilityZoneMappings': [
{
'AvailabilityZone': 'string'
},
],
'UpdateToken': 'string'
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
AvailabilityZoneMappings (list) --
The Availability Zones where Network Firewall created firewall endpoints. Each mapping specifies an Availability Zone where the firewall processes traffic.
(dict) --
Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.
To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.
AvailabilityZone (string) --
The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.
UpdateToken (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.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Associates a FirewallPolicy to a Firewall.
A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
See also: AWS API Documentation
Request Syntax
client.associate_firewall_policy(
UpdateToken='string',
FirewallArn='string',
FirewallName='string',
FirewallPolicyArn='string',
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
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.
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the firewall policy.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Response Syntax
{
'FirewallArn': 'string',
'FirewallName': 'string',
'FirewallPolicyArn': 'string',
'UpdateToken': 'string'
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallPolicyArn (string) --
The Amazon Resource Name (ARN) of the firewall policy.
UpdateToken (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.
{'IgwFirewallConfiguration': {'EnforcementMode': 'POLICY_CONTROLLED'}}
Response {'Firewall': {'IgwFirewallConfiguration': {'EnforcementMode': 'POLICY_CONTROLLED'}},
'FirewallStatus': {'Status': {'STANDBY'},
'SyncStates': {'AddressTranslations': {'PublicIPv4Addresses': ['string'],
'PublicIPv6Addresses': ['string']},
'Attachment': {'Status': {'STANDBY'}}}}}
Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.
After you create a firewall, you can provide additional settings, like the logging configuration.
To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.
To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.
To generate a report on the last 30 days of traffic monitored by a firewall, use StartAnalysisReport.
To create a proxy mode firewall, specify VpcEndpoint and NatGatewayCreateMappings instead of VpcId and SubnetMappings. A proxy mode firewall is an explicit forward proxy. Your clients send HTTP and HTTPS proxy requests to the firewall's proxy DNS name, which DescribeFirewall returns in each Availability Zone's Attachment. The firewall evaluates proxy traffic with the stateful rules in its firewall policy, and sends allowed traffic out through the NAT gateway in the same Availability Zone. Your clients don't need route table changes. In each Availability Zone, the firewall has one endpoint and one NAT gateway, which Network Firewall creates for you.
See also: AWS API Documentation
Request Syntax
client.create_firewall(
FirewallName='string',
FirewallPolicyArn='string',
VpcId='string',
SubnetMappings=[
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
],
DeleteProtection=True|False,
SubnetChangeProtection=True|False,
FirewallPolicyChangeProtection=True|False,
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
EncryptionConfiguration={
'KeyId': 'string',
'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
},
EnabledAnalysisTypes=[
'TLS_SNI'|'HTTP_HOST',
],
TransitGatewayId='string',
AvailabilityZoneMappings=[
{
'AvailabilityZone': 'string'
},
],
AvailabilityZoneChangeProtection=True|False,
IgwFirewallConfiguration={
'EnforcementMode': 'POLICY_CONTROLLED'
},
NatGatewayCreateMappings=[
{
'SubnetId': 'string',
'AllocationIds': [
'string',
],
'PrivateIps': [
'string',
]
},
],
ProxySettings={
'ListenerProperties': [
{
'Port': 123,
'Type': 'HTTP'|'HTTPS'
},
],
'CertificateArn': 'string',
'DomainName': 'string'
},
VpcEndpoint={
'VpcId': 'string',
'SubnetMappings': [
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
]
},
TransparentFilteringNatScope='NAT_ALL'|'NAT_NONE'
)
string
[REQUIRED]
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
string
The unique identifier of the VPC where Network Firewall should create the firewall.
You can't change this setting after you create the firewall.
list
The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) -- [REQUIRED]
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
boolean
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
boolean
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
boolean
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
string
A description of the firewall.
list
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
A complex type that contains settings for encryption of your firewall resources.
KeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) -- [REQUIRED]
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
list
An optional setting indicating the specific traffic analysis types to enable on the firewall.
(string) --
string
Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through Resource Access Manager.
For information about creating firewalls, see CreateFirewall. For specific guidance about transit gateway-attached firewalls, see Considerations for transit gateway-attached firewalls in the Network Firewall Developer Guide.
list
Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.
You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.
(dict) --
Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.
To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.
AvailabilityZone (string) -- [REQUIRED]
The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.
boolean
Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you cannot add or remove Availability Zones without first disabling this protection using UpdateAvailabilityZoneChangeProtection.
Default value: FALSE
dict
Settings that make this firewall an internet gateway firewall. An internet gateway firewall inspects all traffic between a VPC and its internet gateway, without changes to your subnets or route tables. Amazon Web Services Network Security Manager creates and manages internet gateway firewalls on your behalf, so you don't include this setting when you create a standard Network Firewall firewall.
When this setting is present, FirewallName must equal the VpcId, AvailabilityZoneMappings is required and must use Availability Zone IDs, and you can't specify SubnetMappings or a transit gateway.
EnforcementMode (string) -- [REQUIRED]
How the internet gateway firewall enforces its rules. The only supported value is POLICY_CONTROLLED, which means that the enforcement mode is set by the firewall policy that Amazon Web Services Network Security Manager associates with the firewall.
list
The NAT gateways that Network Firewall creates for a proxy mode firewall, one for each Availability Zone. When you specify this, you create a proxy mode firewall. Destinations see the IP address of the NAT gateway in the client's Availability Zone as the source of the traffic.
Specify one mapping for each Availability Zone in VpcEndpoint, and no other Availability Zones. Each NAT gateway subnet must be in the VpcEndpoint VPC and can't be one of the firewall endpoint subnets.
You need permission to call the Amazon EC2 CreateNatGateway action.
If Network Firewall can't set up an Availability Zone, for example because Amazon EC2 rejects the NAT gateway, it removes the Availability Zone from the firewall. It also deletes the NAT gateway that it created there. The Availability Zone's Attachment status is FAILED, and its status message explains why. You can add the Availability Zone again with AssociateSubnets. If no Availability Zone can be set up, the firewall status is FAILED.
(dict) --
A NAT gateway that Network Firewall creates for a proxy mode firewall in one Availability Zone. You use this in CreateFirewall and AssociateSubnets.
To create a public NAT gateway, specify AllocationIds, and one PrivateIps address for each Elastic IP address. To create a private NAT gateway, specify only PrivateIps. You must specify at least one of them. Each Elastic IP address and private IP address can appear only once in a request.
The NAT gateway is a resource in your account. To change its IP addresses, use Amazon EC2 NAT gateway actions.
SubnetId (string) -- [REQUIRED]
The ID of the subnet where Network Firewall creates the NAT gateway. The subnet must be in the firewall's VPC and can't be one of the firewall endpoint subnets. Each mapping must be in a different Availability Zone.
AllocationIds (list) --
The allocation IDs of the Elastic IP addresses for a public NAT gateway, from 1 to 8. For each allocation ID, specify one address in PrivateIps. If you don't specify this, Network Firewall creates a private NAT gateway.
(string) --
PrivateIps (list) --
The private IPv4 addresses of the NAT gateway. The addresses must be in the subnet that you specify and can't be the subnet's reserved addresses.
For a public NAT gateway, you must specify exactly one address for each Elastic IP address in AllocationIds, even if you specify only one. For a private NAT gateway, specify from 1 to 8 addresses. The first address is the primary address.
(string) --
dict
The proxy settings for 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. If you don't specify listeners, the firewall listens for HTTP on port 3128 and HTTPS on port 8443.
To change the listeners later, use UpdateProxySettings.
ListenerProperties (list) -- [REQUIRED]
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.
(dict) --
Open port for taking HTTP or HTTPS traffic.
Port (integer) --
Port for processing traffic.
Type (string) --
Selection of HTTP or HTTPS traffic.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate that the firewall's HTTPS proxy listener presents to clients. The certificate must be an 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.com covers proxy.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 specify DomainName. You can set them only when you create the firewall. When you call UpdateProxySettings, specify the same values.
DomainName (string) --
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.com format, and the certificate in CertificateArn must 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 specify CertificateArn. You can set them only when you create the firewall. When you call UpdateProxySettings, specify the same values.
dict
The VPC and subnets for the endpoints of a proxy mode firewall. Network Firewall creates a firewall endpoint in each subnet that you specify. It also creates the firewall's NAT gateways in this VPC, in the subnets that you specify in NatGatewayCreateMappings.
To create a proxy mode firewall, you must specify VpcEndpoint and NatGatewayCreateMappings, and you must not specify the top-level VpcId and SubnetMappings. Specify one subnet for each Availability Zone where you want to use the firewall.
VpcId (string) -- [REQUIRED]
The ID of the VPC where Network Firewall creates the endpoints and NAT gateways of a proxy mode firewall.
SubnetMappings (list) -- [REQUIRED]
The subnets where Network Firewall creates the firewall endpoints of a proxy mode firewall. Specify one subnet for each Availability Zone, and a NAT gateway mapping in each of those Availability Zones.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) -- [REQUIRED]
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
string
How a proxy mode firewall handles traffic that isn't sent to its proxy listener. If you don't specify a value, the firewall uses NAT_ALL. You can choose from the following values:
NAT_ALL - After inspection, the firewall sends this traffic out through its NAT gateway, which translates the source address.
NAT_NONE - After inspection, the firewall returns this traffic to the firewall endpoint without address translation.
You can specify this only for a proxy mode firewall, and you can't change it after you create the firewall.
dict
Response Syntax
{
'Firewall': {
'FirewallName': 'string',
'FirewallArn': 'string',
'FirewallPolicyArn': 'string',
'VpcId': 'string',
'SubnetMappings': [
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
],
'DeleteProtection': True|False,
'SubnetChangeProtection': True|False,
'FirewallPolicyChangeProtection': True|False,
'Description': 'string',
'FirewallId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'EncryptionConfiguration': {
'KeyId': 'string',
'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
},
'NumberOfAssociations': 123,
'EnabledAnalysisTypes': [
'TLS_SNI'|'HTTP_HOST',
],
'TransitGatewayId': 'string',
'TransitGatewayOwnerAccountId': 'string',
'AvailabilityZoneMappings': [
{
'AvailabilityZone': 'string'
},
],
'AvailabilityZoneChangeProtection': True|False,
'IgwFirewallConfiguration': {
'EnforcementMode': 'POLICY_CONTROLLED'
},
'NatGatewayCreateMappings': [
{
'SubnetId': 'string',
'AllocationIds': [
'string',
],
'PrivateIps': [
'string',
]
},
],
'ProxySettings': {
'ListenerProperties': [
{
'Port': 123,
'Type': 'HTTP'|'HTTPS'
},
],
'CertificateArn': 'string',
'DomainName': 'string'
},
'VpcEndpoint': {
'VpcId': 'string',
'SubnetMappings': [
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
]
},
'ContextStoreId': 'string',
'ContextStoreOwnerAccountId': 'string',
'TransparentFilteringNatScope': 'NAT_ALL'|'NAT_NONE'
},
'FirewallStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY'|'FAILED'|'STANDBY',
'ConfigurationSyncStateSummary': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
'SyncStates': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY'|'STANDBY',
'StatusMessage': 'string',
'DnsName': 'string'
},
'Config': {
'string': {
'SyncStatus': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED'|'NOT_SUBSCRIBED'|'DEPRECATED',
'UpdateToken': 'string'
}
},
'AddressTranslations': {
'PublicIPv6Addresses': [
'string',
],
'PublicIPv4Addresses': [
'string',
]
},
'NatGatewayAttachments': [
{
'NatGatewayId': 'string',
'Status': 'CREATING'|'READY'|'UPDATING'|'FAILED'|'DELETING',
'StatusMessage': 'string',
'DnsName': 'string'
},
]
}
},
'CapacityUsageSummary': {
'CIDRs': {
'AvailableCIDRCount': 123,
'UtilizedCIDRCount': 123,
'IPSetReferences': {
'string': {
'ResolvedCIDRCount': 123
}
}
}
},
'TransitGatewayAttachmentSyncState': {
'AttachmentId': 'string',
'TransitGatewayAttachmentStatus': 'CREATING'|'DELETING'|'DELETED'|'FAILED'|'ERROR'|'READY'|'PENDING_ACCEPTANCE'|'REJECTING'|'REJECTED',
'StatusMessage': 'string'
},
'ContextStoreSyncState': {
'SyncStatus': 'SYNCING'|'PARTIALLY_RESOLVED'|'FULLY_RESOLVED'|'SYNC_FAILED'|'UNRESOLVED',
'StatusMessage': 'string'
}
}
}
Response Structure
(dict) --
Firewall (dict) --
The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn (string) --
The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
VpcId (string) --
The unique identifier of the VPC where the firewall is in use.
SubnetMappings (list) --
The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.
These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.
In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
DeleteProtection (boolean) --
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
SubnetChangeProtection (boolean) --
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
FirewallPolicyChangeProtection (boolean) --
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
Description (string) --
A description of the firewall.
FirewallId (string) --
The unique identifier for the firewall.
Tags (list) --
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration (dict) --
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
KeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) --
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
NumberOfAssociations (integer) --
The number of VpcEndpointAssociation resources that use this firewall.
EnabledAnalysisTypes (list) --
An optional setting indicating the specific traffic analysis types to enable on the firewall.
(string) --
TransitGatewayId (string) --
The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.
TransitGatewayOwnerAccountId (string) --
The Amazon Web Services account ID that owns the transit gateway. This may be different from the firewall owner's account ID when using a shared transit gateway.
AvailabilityZoneMappings (list) --
The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.
(dict) --
Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.
To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.
AvailabilityZone (string) --
The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.
AvailabilityZoneChangeProtection (boolean) --
A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you must first disable this protection before adding or removing Availability Zones.
IgwFirewallConfiguration (dict) --
Contains the settings that configure an internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC. Network Firewall returns this setting only for an internet gateway firewall. For a standard firewall, this setting isn't present.
EnforcementMode (string) --
How the internet gateway firewall enforces its rules. The only supported value is POLICY_CONTROLLED, which means that the enforcement mode is set by the firewall policy that Amazon Web Services Network Security Manager associates with the firewall.
NatGatewayCreateMappings (list) --
The NAT gateways that you specified for Network Firewall to create for a proxy mode firewall. To get the IDs and status of the NAT gateways that are attached to the firewall, see NatGatewayAttachments in the firewall's SyncStates.
(dict) --
A NAT gateway that Network Firewall creates for a proxy mode firewall in one Availability Zone. You use this in CreateFirewall and AssociateSubnets.
To create a public NAT gateway, specify AllocationIds, and one PrivateIps address for each Elastic IP address. To create a private NAT gateway, specify only PrivateIps. You must specify at least one of them. Each Elastic IP address and private IP address can appear only once in a request.
The NAT gateway is a resource in your account. To change its IP addresses, use Amazon EC2 NAT gateway actions.
SubnetId (string) --
The ID of the subnet where Network Firewall creates the NAT gateway. The subnet must be in the firewall's VPC and can't be one of the firewall endpoint subnets. Each mapping must be in a different Availability Zone.
AllocationIds (list) --
The allocation IDs of the Elastic IP addresses for a public NAT gateway, from 1 to 8. For each allocation ID, specify one address in PrivateIps. If you don't specify this, Network Firewall creates a private NAT gateway.
(string) --
PrivateIps (list) --
The private IPv4 addresses of the NAT gateway. The addresses must be in the subnet that you specify and can't be the subnet's reserved addresses.
For a public NAT gateway, you must specify exactly one address for each Elastic IP address in AllocationIds, even if you specify only one. For a private NAT gateway, specify from 1 to 8 addresses. The first address is the primary address.
(string) --
ProxySettings (dict) --
The proxy settings of a proxy mode firewall: its listeners and, if you specified them, your own CertificateArn and DomainName.
ListenerProperties (list) --
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.
(dict) --
Open port for taking HTTP or HTTPS traffic.
Port (integer) --
Port for processing traffic.
Type (string) --
Selection of HTTP or HTTPS traffic.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate that the firewall's HTTPS proxy listener presents to clients. The certificate must be an 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.com covers proxy.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 specify DomainName. You can set them only when you create the firewall. When you call UpdateProxySettings, specify the same values.
DomainName (string) --
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.com format, and the certificate in CertificateArn must 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 specify CertificateArn. You can set them only when you create the firewall. When you call UpdateProxySettings, specify the same values.
VpcEndpoint (dict) --
The VPC and subnets for the endpoints of a proxy mode firewall.
VpcId (string) --
The ID of the VPC where Network Firewall creates the endpoints and NAT gateways of a proxy mode firewall.
SubnetMappings (list) --
The subnets where Network Firewall creates the firewall endpoints of a proxy mode firewall. Specify one subnet for each Availability Zone, and a NAT gateway mapping in each of those Availability Zones.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
ContextStoreId (string) --
The unique identifier of the context store that the firewall uses to resolve context sets in its rule groups. Network Firewall discovers the context store from the transit gateway association in Network Manager. This field is only present for transit gateway-attached firewalls whose transit gateway is associated with a context store.
ContextStoreOwnerAccountId (string) --
The Amazon Web Services account ID that owns the context store. This may be different from the firewall owner's account ID.
TransparentFilteringNatScope (string) --
How a proxy mode firewall handles traffic that isn't sent to its proxy listener. NAT_ALL sends this traffic out through the firewall's NAT gateway after inspection. NAT_NONE returns it to the firewall endpoint without address translation.
FirewallStatus (dict) --
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.
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.
Status (string) --
The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
For an internet gateway firewall, this setting is STANDBY while no Availability Zone in the VPC has resources that need the firewall. Network Firewall provisions the firewall in an Availability Zone when the first resource is launched there.
ConfigurationSyncStateSummary (string) --
The configuration sync state for the firewall. This summarizes the Config settings in the SyncStates for this firewall status object.
When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere.
This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic.
SyncStates (dict) --
Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall.
These objects provide detailed information for the settings ConfigurationSyncStateSummary and Status.
(string) --
(dict) --
The status of the firewall endpoint and firewall policy configuration for a single VPC subnet. This is part of the FirewallStatus.
For each VPC subnet that you associate with a firewall, Network Firewall does the following:
Instantiates a firewall endpoint in the subnet, ready to take traffic.
Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
Attachment (dict) --
The configuration and status for a single firewall subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (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.
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.
For an internet gateway firewall, STANDBY indicates an Availability Zone that has no resources yet. Network Firewall provisions the endpoint there when the first resource is launched in that Availability Zone.
StatusMessage (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.
DnsName (string) --
The proxy DNS name of a proxy mode firewall. Your clients send proxy requests to the firewall at this name. It's your ProxySettings DomainName if you specified one, or a name that Network Firewall generates in the format proxy-id.nfw.region.amazonaws.com.
The firewall has one proxy DNS name for every Availability Zone and VPC that it serves. In each Availability Zone, the name resolves to the firewall endpoint in that Availability Zone, so traffic stays in your client's Availability Zone. Your clients must use the VPC's Route 53 Resolver.
Config (dict) --
The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic.
(string) --
(dict) --
Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.
SyncStatus (string) --
Indicates whether this object is in sync with the version indicated in the update token.
UpdateToken (string) --
The current version of the object that is either in sync or pending synchronization.
AddressTranslations (dict) --
The public IP addresses that an internet gateway firewall uses for network address translation in this Availability Zone. Network Firewall allocates these addresses in your account and adds or removes addresses automatically based on traffic. This setting is only present for an internet gateway firewall.
PublicIPv6Addresses (list) --
The public IPv6 addresses that the internet gateway firewall uses for network address translation in this Availability Zone.
(string) --
PublicIPv4Addresses (list) --
The public IPv4 addresses that the internet gateway firewall uses for network address translation in this Availability Zone.
(string) --
NatGatewayAttachments (list) --
The NAT gateway that's attached to a proxy mode firewall in the Availability Zone, and the status of the attachment. To get NAT gateway details, such as IP addresses, use the Amazon EC2 DescribeNatGateways action.
A proxy mode firewall is READY when at least one Availability Zone's firewall endpoint and NAT gateway attachment are READY.
(dict) --
The NAT gateway that's attached to a proxy mode firewall in an Availability Zone, and the status of the attachment. Traffic that the firewall allows in the Availability Zone leaves through this NAT gateway.
NatGatewayId (string) --
The ID of the NAT gateway.
Status (string) --
The status of the NAT gateway attachment. READY means that the NAT gateway is attached and the firewall can send traffic through it. Other values are CREATING, UPDATING, DELETING, and FAILED.
StatusMessage (string) --
The reason that Network Firewall couldn't create or attach the NAT gateway, if it couldn't.
DnsName (string) --
The proxy DNS name of the firewall in this Availability Zone. This is the same as the DnsName of the firewall's Attachment.
CapacityUsageSummary (dict) --
Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
CIDRs (dict) --
Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
AvailableCIDRCount (integer) --
The number of CIDR blocks available for use by the IP set references in a firewall.
UtilizedCIDRCount (integer) --
The number of CIDR blocks used by the IP set references in a firewall.
IPSetReferences (dict) --
The list of the IP set references used by a firewall.
(string) --
(dict) --
General information about the IP set.
ResolvedCIDRCount (integer) --
Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.
TransitGatewayAttachmentSyncState (dict) --
The synchronization state of the transit gateway attachment. This indicates whether the firewall's transit gateway configuration is properly synchronized and operational. Use this to verify that your transit gateway configuration changes have been applied.
AttachmentId (string) --
The unique identifier of the transit gateway attachment.
TransitGatewayAttachmentStatus (string) --
The current status of the transit gateway attachment.
Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
StatusMessage (string) --
A message providing additional information about the current status, particularly useful when the transit gateway attachment is in a non- READY state.
Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
For information about troubleshooting endpoint failures, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
ContextStoreSyncState (dict) --
The synchronization state of the context sets in the firewall's rule groups with the firewall's context store. This field is only present when the firewall has a context store and its rule groups reference context sets.
SyncStatus (string) --
The synchronization status of the firewall's context sets. Valid values:
SYNCING - The firewall is applying the latest context store data.
FULLY_RESOLVED - All resource identifiers in the firewall's context sets resolve to resources in the context store.
PARTIALLY_RESOLVED - Some resource identifiers in the firewall's context sets don't resolve to resources in the context store.
SYNC_FAILED - The firewall couldn't sync with the context store. For details, see StatusMessage.
StatusMessage (string) --
A message that provides additional information about the synchronization status, particularly when the status is not FULLY_RESOLVED.
{'VpcEndpointAssociationStatus': {'AssociationSyncState': {'Attachment': {'Status': {'STANDBY'}}},
'Status': {'STANDBY'}}}
Creates a firewall endpoint for an Network Firewall firewall. This type of firewall endpoint is independent of the firewall endpoints that you specify in the Firewall itself, and you define it in addition to those endpoints after the firewall has been created. You can define a VPC endpoint association using a different VPC than the one you used in the firewall specifications.
See also: AWS API Documentation
Request Syntax
client.create_vpc_endpoint_association(
FirewallArn='string',
VpcId='string',
SubnetMapping={
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the firewall.
string
[REQUIRED]
The unique identifier of the VPC where you want to create a firewall endpoint.
dict
[REQUIRED]
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) -- [REQUIRED]
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
string
A description of the VPC endpoint association.
list
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'VpcEndpointAssociation': {
'VpcEndpointAssociationId': 'string',
'VpcEndpointAssociationArn': 'string',
'FirewallArn': 'string',
'VpcId': 'string',
'SubnetMapping': {
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'VpcEndpointAssociationStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY'|'FAILED'|'STANDBY',
'AssociationSyncState': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY'|'STANDBY',
'StatusMessage': 'string',
'DnsName': 'string'
}
}
}
}
}
Response Structure
(dict) --
VpcEndpointAssociation (dict) --
The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.
VpcEndpointAssociationId (string) --
The unique identifier of the VPC endpoint association.
VpcEndpointAssociationArn (string) --
The Amazon Resource Name (ARN) of a VPC endpoint association.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
VpcId (string) --
The unique identifier of the VPC for the endpoint association.
SubnetMapping (dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
Description (string) --
A description of the VPC endpoint association.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
VpcEndpointAssociationStatus (dict) --
Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.
Status (string) --
The readiness of the configured firewall endpoint to handle network traffic.
AssociationSyncState (dict) --
The list of the Availability Zone sync states for all subnets that are defined by the firewall.
(string) --
(dict) --
The status of the firewall endpoint defined by a VpcEndpointAssociation.
Attachment (dict) --
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.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (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.
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.
For an internet gateway firewall, STANDBY indicates an Availability Zone that has no resources yet. Network Firewall provisions the endpoint there when the first resource is launched in that Availability Zone.
StatusMessage (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.
DnsName (string) --
The proxy DNS name of a proxy mode firewall. Your clients send proxy requests to the firewall at this name. It's your ProxySettings DomainName if you specified one, or a name that Network Firewall generates in the format proxy-id.nfw.region.amazonaws.com.
The firewall has one proxy DNS name for every Availability Zone and VPC that it serves. In each Availability Zone, the name resolves to the firewall endpoint in that Availability Zone, so traffic stays in your client's Availability Zone. Your clients must use the VPC's Route 53 Resolver.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Response {'Firewall': {'IgwFirewallConfiguration': {'EnforcementMode': 'POLICY_CONTROLLED'}},
'FirewallStatus': {'Status': {'STANDBY'},
'SyncStates': {'AddressTranslations': {'PublicIPv4Addresses': ['string'],
'PublicIPv6Addresses': ['string']},
'Attachment': {'Status': {'STANDBY'}}}}}
Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's DeleteProtection flag to be FALSE. You can't revert this operation.
You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.
To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.
Deleting a proxy mode firewall detaches its NAT gateways. To also delete the NAT gateways that Network Firewall created for the firewall, specify DeleteAssociatedNatGateways.
See also: AWS API Documentation
Request Syntax
client.delete_firewall(
FirewallName='string',
FirewallArn='string',
FirewallType='FIREWALL'|'IGW_FIREWALL',
DeleteAssociatedNatGateways=True|False
)
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
boolean
Specifies whether to delete the NAT gateways that Network Firewall created for a proxy mode firewall when you delete the firewall. You can choose from the following values:
FALSE - Network Firewall detaches the NAT gateways from the firewall and keeps them. This is the default.
TRUE - Network Firewall also deletes the NAT gateways. The firewall status stays DELETING until they're deleted. You need permission to call the Amazon EC2 DeleteNatGateway action.
You can't specify TRUE for a firewall that isn't a proxy mode firewall.
dict
Response Syntax
{
'Firewall': {
'FirewallName': 'string',
'FirewallArn': 'string',
'FirewallPolicyArn': 'string',
'VpcId': 'string',
'SubnetMappings': [
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
],
'DeleteProtection': True|False,
'SubnetChangeProtection': True|False,
'FirewallPolicyChangeProtection': True|False,
'Description': 'string',
'FirewallId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'EncryptionConfiguration': {
'KeyId': 'string',
'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
},
'NumberOfAssociations': 123,
'EnabledAnalysisTypes': [
'TLS_SNI'|'HTTP_HOST',
],
'TransitGatewayId': 'string',
'TransitGatewayOwnerAccountId': 'string',
'AvailabilityZoneMappings': [
{
'AvailabilityZone': 'string'
},
],
'AvailabilityZoneChangeProtection': True|False,
'IgwFirewallConfiguration': {
'EnforcementMode': 'POLICY_CONTROLLED'
},
'NatGatewayCreateMappings': [
{
'SubnetId': 'string',
'AllocationIds': [
'string',
],
'PrivateIps': [
'string',
]
},
],
'ProxySettings': {
'ListenerProperties': [
{
'Port': 123,
'Type': 'HTTP'|'HTTPS'
},
],
'CertificateArn': 'string',
'DomainName': 'string'
},
'VpcEndpoint': {
'VpcId': 'string',
'SubnetMappings': [
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
]
},
'ContextStoreId': 'string',
'ContextStoreOwnerAccountId': 'string',
'TransparentFilteringNatScope': 'NAT_ALL'|'NAT_NONE'
},
'FirewallStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY'|'FAILED'|'STANDBY',
'ConfigurationSyncStateSummary': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
'SyncStates': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY'|'STANDBY',
'StatusMessage': 'string',
'DnsName': 'string'
},
'Config': {
'string': {
'SyncStatus': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED'|'NOT_SUBSCRIBED'|'DEPRECATED',
'UpdateToken': 'string'
}
},
'AddressTranslations': {
'PublicIPv6Addresses': [
'string',
],
'PublicIPv4Addresses': [
'string',
]
},
'NatGatewayAttachments': [
{
'NatGatewayId': 'string',
'Status': 'CREATING'|'READY'|'UPDATING'|'FAILED'|'DELETING',
'StatusMessage': 'string',
'DnsName': 'string'
},
]
}
},
'CapacityUsageSummary': {
'CIDRs': {
'AvailableCIDRCount': 123,
'UtilizedCIDRCount': 123,
'IPSetReferences': {
'string': {
'ResolvedCIDRCount': 123
}
}
}
},
'TransitGatewayAttachmentSyncState': {
'AttachmentId': 'string',
'TransitGatewayAttachmentStatus': 'CREATING'|'DELETING'|'DELETED'|'FAILED'|'ERROR'|'READY'|'PENDING_ACCEPTANCE'|'REJECTING'|'REJECTED',
'StatusMessage': 'string'
},
'ContextStoreSyncState': {
'SyncStatus': 'SYNCING'|'PARTIALLY_RESOLVED'|'FULLY_RESOLVED'|'SYNC_FAILED'|'UNRESOLVED',
'StatusMessage': 'string'
}
}
}
Response Structure
(dict) --
Firewall (dict) --
A firewall defines the behavior of a firewall, the main VPC where the firewall is used, the Availability Zones where the firewall can be used, and one subnet to use for a firewall endpoint within each of the Availability Zones. The Availability Zones are defined implicitly in the subnet specifications.
In addition to the firewall endpoints that you define in this Firewall specification, you can create firewall endpoints in VpcEndpointAssociation resources for any VPC, in any Availability Zone where the firewall is already in use.
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both the firewall and firewall status by calling DescribeFirewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn (string) --
The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
VpcId (string) --
The unique identifier of the VPC where the firewall is in use.
SubnetMappings (list) --
The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.
These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.
In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
DeleteProtection (boolean) --
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
SubnetChangeProtection (boolean) --
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
FirewallPolicyChangeProtection (boolean) --
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
Description (string) --
A description of the firewall.
FirewallId (string) --
The unique identifier for the firewall.
Tags (list) --
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration (dict) --
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
KeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) --
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
NumberOfAssociations (integer) --
The number of VpcEndpointAssociation resources that use this firewall.
EnabledAnalysisTypes (list) --
An optional setting indicating the specific traffic analysis types to enable on the firewall.
(string) --
TransitGatewayId (string) --
The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.
TransitGatewayOwnerAccountId (string) --
The Amazon Web Services account ID that owns the transit gateway. This may be different from the firewall owner's account ID when using a shared transit gateway.
AvailabilityZoneMappings (list) --
The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.
(dict) --
Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.
To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.
AvailabilityZone (string) --
The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.
AvailabilityZoneChangeProtection (boolean) --
A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you must first disable this protection before adding or removing Availability Zones.
IgwFirewallConfiguration (dict) --
Contains the settings that configure an internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC. Network Firewall returns this setting only for an internet gateway firewall. For a standard firewall, this setting isn't present.
EnforcementMode (string) --
How the internet gateway firewall enforces its rules. The only supported value is POLICY_CONTROLLED, which means that the enforcement mode is set by the firewall policy that Amazon Web Services Network Security Manager associates with the firewall.
NatGatewayCreateMappings (list) --
The NAT gateways that you specified for Network Firewall to create for a proxy mode firewall. To get the IDs and status of the NAT gateways that are attached to the firewall, see NatGatewayAttachments in the firewall's SyncStates.
(dict) --
A NAT gateway that Network Firewall creates for a proxy mode firewall in one Availability Zone. You use this in CreateFirewall and AssociateSubnets.
To create a public NAT gateway, specify AllocationIds, and one PrivateIps address for each Elastic IP address. To create a private NAT gateway, specify only PrivateIps. You must specify at least one of them. Each Elastic IP address and private IP address can appear only once in a request.
The NAT gateway is a resource in your account. To change its IP addresses, use Amazon EC2 NAT gateway actions.
SubnetId (string) --
The ID of the subnet where Network Firewall creates the NAT gateway. The subnet must be in the firewall's VPC and can't be one of the firewall endpoint subnets. Each mapping must be in a different Availability Zone.
AllocationIds (list) --
The allocation IDs of the Elastic IP addresses for a public NAT gateway, from 1 to 8. For each allocation ID, specify one address in PrivateIps. If you don't specify this, Network Firewall creates a private NAT gateway.
(string) --
PrivateIps (list) --
The private IPv4 addresses of the NAT gateway. The addresses must be in the subnet that you specify and can't be the subnet's reserved addresses.
For a public NAT gateway, you must specify exactly one address for each Elastic IP address in AllocationIds, even if you specify only one. For a private NAT gateway, specify from 1 to 8 addresses. The first address is the primary address.
(string) --
ProxySettings (dict) --
The proxy settings of a proxy mode firewall: its listeners and, if you specified them, your own CertificateArn and DomainName.
ListenerProperties (list) --
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.
(dict) --
Open port for taking HTTP or HTTPS traffic.
Port (integer) --
Port for processing traffic.
Type (string) --
Selection of HTTP or HTTPS traffic.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate that the firewall's HTTPS proxy listener presents to clients. The certificate must be an 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.com covers proxy.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 specify DomainName. You can set them only when you create the firewall. When you call UpdateProxySettings, specify the same values.
DomainName (string) --
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.com format, and the certificate in CertificateArn must 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 specify CertificateArn. You can set them only when you create the firewall. When you call UpdateProxySettings, specify the same values.
VpcEndpoint (dict) --
The VPC and subnets for the endpoints of a proxy mode firewall.
VpcId (string) --
The ID of the VPC where Network Firewall creates the endpoints and NAT gateways of a proxy mode firewall.
SubnetMappings (list) --
The subnets where Network Firewall creates the firewall endpoints of a proxy mode firewall. Specify one subnet for each Availability Zone, and a NAT gateway mapping in each of those Availability Zones.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
ContextStoreId (string) --
The unique identifier of the context store that the firewall uses to resolve context sets in its rule groups. Network Firewall discovers the context store from the transit gateway association in Network Manager. This field is only present for transit gateway-attached firewalls whose transit gateway is associated with a context store.
ContextStoreOwnerAccountId (string) --
The Amazon Web Services account ID that owns the context store. This may be different from the firewall owner's account ID.
TransparentFilteringNatScope (string) --
How a proxy mode firewall handles traffic that isn't sent to its proxy listener. NAT_ALL sends this traffic out through the firewall's NAT gateway after inspection. NAT_NONE returns it to the firewall endpoint without address translation.
FirewallStatus (dict) --
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.
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.
Status (string) --
The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
For an internet gateway firewall, this setting is STANDBY while no Availability Zone in the VPC has resources that need the firewall. Network Firewall provisions the firewall in an Availability Zone when the first resource is launched there.
ConfigurationSyncStateSummary (string) --
The configuration sync state for the firewall. This summarizes the Config settings in the SyncStates for this firewall status object.
When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere.
This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic.
SyncStates (dict) --
Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall.
These objects provide detailed information for the settings ConfigurationSyncStateSummary and Status.
(string) --
(dict) --
The status of the firewall endpoint and firewall policy configuration for a single VPC subnet. This is part of the FirewallStatus.
For each VPC subnet that you associate with a firewall, Network Firewall does the following:
Instantiates a firewall endpoint in the subnet, ready to take traffic.
Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
Attachment (dict) --
The configuration and status for a single firewall subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (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.
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.
For an internet gateway firewall, STANDBY indicates an Availability Zone that has no resources yet. Network Firewall provisions the endpoint there when the first resource is launched in that Availability Zone.
StatusMessage (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.
DnsName (string) --
The proxy DNS name of a proxy mode firewall. Your clients send proxy requests to the firewall at this name. It's your ProxySettings DomainName if you specified one, or a name that Network Firewall generates in the format proxy-id.nfw.region.amazonaws.com.
The firewall has one proxy DNS name for every Availability Zone and VPC that it serves. In each Availability Zone, the name resolves to the firewall endpoint in that Availability Zone, so traffic stays in your client's Availability Zone. Your clients must use the VPC's Route 53 Resolver.
Config (dict) --
The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic.
(string) --
(dict) --
Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.
SyncStatus (string) --
Indicates whether this object is in sync with the version indicated in the update token.
UpdateToken (string) --
The current version of the object that is either in sync or pending synchronization.
AddressTranslations (dict) --
The public IP addresses that an internet gateway firewall uses for network address translation in this Availability Zone. Network Firewall allocates these addresses in your account and adds or removes addresses automatically based on traffic. This setting is only present for an internet gateway firewall.
PublicIPv6Addresses (list) --
The public IPv6 addresses that the internet gateway firewall uses for network address translation in this Availability Zone.
(string) --
PublicIPv4Addresses (list) --
The public IPv4 addresses that the internet gateway firewall uses for network address translation in this Availability Zone.
(string) --
NatGatewayAttachments (list) --
The NAT gateway that's attached to a proxy mode firewall in the Availability Zone, and the status of the attachment. To get NAT gateway details, such as IP addresses, use the Amazon EC2 DescribeNatGateways action.
A proxy mode firewall is READY when at least one Availability Zone's firewall endpoint and NAT gateway attachment are READY.
(dict) --
The NAT gateway that's attached to a proxy mode firewall in an Availability Zone, and the status of the attachment. Traffic that the firewall allows in the Availability Zone leaves through this NAT gateway.
NatGatewayId (string) --
The ID of the NAT gateway.
Status (string) --
The status of the NAT gateway attachment. READY means that the NAT gateway is attached and the firewall can send traffic through it. Other values are CREATING, UPDATING, DELETING, and FAILED.
StatusMessage (string) --
The reason that Network Firewall couldn't create or attach the NAT gateway, if it couldn't.
DnsName (string) --
The proxy DNS name of the firewall in this Availability Zone. This is the same as the DnsName of the firewall's Attachment.
CapacityUsageSummary (dict) --
Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
CIDRs (dict) --
Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
AvailableCIDRCount (integer) --
The number of CIDR blocks available for use by the IP set references in a firewall.
UtilizedCIDRCount (integer) --
The number of CIDR blocks used by the IP set references in a firewall.
IPSetReferences (dict) --
The list of the IP set references used by a firewall.
(string) --
(dict) --
General information about the IP set.
ResolvedCIDRCount (integer) --
Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.
TransitGatewayAttachmentSyncState (dict) --
The synchronization state of the transit gateway attachment. This indicates whether the firewall's transit gateway configuration is properly synchronized and operational. Use this to verify that your transit gateway configuration changes have been applied.
AttachmentId (string) --
The unique identifier of the transit gateway attachment.
TransitGatewayAttachmentStatus (string) --
The current status of the transit gateway attachment.
Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
StatusMessage (string) --
A message providing additional information about the current status, particularly useful when the transit gateway attachment is in a non- READY state.
Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
For information about troubleshooting endpoint failures, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
ContextStoreSyncState (dict) --
The synchronization state of the context sets in the firewall's rule groups with the firewall's context store. This field is only present when the firewall has a context store and its rule groups reference context sets.
SyncStatus (string) --
The synchronization status of the firewall's context sets. Valid values:
SYNCING - The firewall is applying the latest context store data.
FULLY_RESOLVED - All resource identifiers in the firewall's context sets resolve to resources in the context store.
PARTIALLY_RESOLVED - Some resource identifiers in the firewall's context sets don't resolve to resources in the context store.
SYNC_FAILED - The firewall couldn't sync with the context store. For details, see StatusMessage.
StatusMessage (string) --
A message that provides additional information about the synchronization status, particularly when the status is not FULLY_RESOLVED.
{'VpcEndpointAssociationStatus': {'AssociationSyncState': {'Attachment': {'Status': {'STANDBY'}}},
'Status': {'STANDBY'}}}
Deletes the specified VpcEndpointAssociation.
You can check whether an endpoint association is in use by reviewing the route tables for the Availability Zones where you have the endpoint subnet mapping. You can retrieve the subnet mapping by calling DescribeVpcEndpointAssociation. You define and update the route tables through Amazon VPC. As needed, update the route tables for the Availability Zone to remove the firewall endpoint for the association. When the route tables no longer use the firewall endpoint, you can remove the endpoint association safely.
See also: AWS API Documentation
Request Syntax
client.delete_vpc_endpoint_association(
VpcEndpointAssociationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of a VPC endpoint association.
dict
Response Syntax
{
'VpcEndpointAssociation': {
'VpcEndpointAssociationId': 'string',
'VpcEndpointAssociationArn': 'string',
'FirewallArn': 'string',
'VpcId': 'string',
'SubnetMapping': {
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'VpcEndpointAssociationStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY'|'FAILED'|'STANDBY',
'AssociationSyncState': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY'|'STANDBY',
'StatusMessage': 'string',
'DnsName': 'string'
}
}
}
}
}
Response Structure
(dict) --
VpcEndpointAssociation (dict) --
The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.
VpcEndpointAssociationId (string) --
The unique identifier of the VPC endpoint association.
VpcEndpointAssociationArn (string) --
The Amazon Resource Name (ARN) of a VPC endpoint association.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
VpcId (string) --
The unique identifier of the VPC for the endpoint association.
SubnetMapping (dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
Description (string) --
A description of the VPC endpoint association.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
VpcEndpointAssociationStatus (dict) --
Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.
Status (string) --
The readiness of the configured firewall endpoint to handle network traffic.
AssociationSyncState (dict) --
The list of the Availability Zone sync states for all subnets that are defined by the firewall.
(string) --
(dict) --
The status of the firewall endpoint defined by a VpcEndpointAssociation.
Attachment (dict) --
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.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (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.
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.
For an internet gateway firewall, STANDBY indicates an Availability Zone that has no resources yet. Network Firewall provisions the endpoint there when the first resource is launched in that Availability Zone.
StatusMessage (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.
DnsName (string) --
The proxy DNS name of a proxy mode firewall. Your clients send proxy requests to the firewall at this name. It's your ProxySettings DomainName if you specified one, or a name that Network Firewall generates in the format proxy-id.nfw.region.amazonaws.com.
The firewall has one proxy DNS name for every Availability Zone and VPC that it serves. In each Availability Zone, the name resolves to the firewall endpoint in that Availability Zone, so traffic stays in your client's Availability Zone. Your clients must use the VPC's Route 53 Resolver.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Response {'Firewall': {'IgwFirewallConfiguration': {'EnforcementMode': 'POLICY_CONTROLLED'}},
'FirewallStatus': {'Status': {'STANDBY'},
'SyncStates': {'AddressTranslations': {'PublicIPv4Addresses': ['string'],
'PublicIPv6Addresses': ['string']},
'Attachment': {'Status': {'STANDBY'}}}}}
Returns the data objects for the specified firewall.
See also: AWS API Documentation
Request Syntax
client.describe_firewall(
FirewallName='string',
FirewallArn='string',
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Response Syntax
{
'UpdateToken': 'string',
'Firewall': {
'FirewallName': 'string',
'FirewallArn': 'string',
'FirewallPolicyArn': 'string',
'VpcId': 'string',
'SubnetMappings': [
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
],
'DeleteProtection': True|False,
'SubnetChangeProtection': True|False,
'FirewallPolicyChangeProtection': True|False,
'Description': 'string',
'FirewallId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'EncryptionConfiguration': {
'KeyId': 'string',
'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
},
'NumberOfAssociations': 123,
'EnabledAnalysisTypes': [
'TLS_SNI'|'HTTP_HOST',
],
'TransitGatewayId': 'string',
'TransitGatewayOwnerAccountId': 'string',
'AvailabilityZoneMappings': [
{
'AvailabilityZone': 'string'
},
],
'AvailabilityZoneChangeProtection': True|False,
'IgwFirewallConfiguration': {
'EnforcementMode': 'POLICY_CONTROLLED'
},
'NatGatewayCreateMappings': [
{
'SubnetId': 'string',
'AllocationIds': [
'string',
],
'PrivateIps': [
'string',
]
},
],
'ProxySettings': {
'ListenerProperties': [
{
'Port': 123,
'Type': 'HTTP'|'HTTPS'
},
],
'CertificateArn': 'string',
'DomainName': 'string'
},
'VpcEndpoint': {
'VpcId': 'string',
'SubnetMappings': [
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
]
},
'ContextStoreId': 'string',
'ContextStoreOwnerAccountId': 'string',
'TransparentFilteringNatScope': 'NAT_ALL'|'NAT_NONE'
},
'FirewallStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY'|'FAILED'|'STANDBY',
'ConfigurationSyncStateSummary': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
'SyncStates': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY'|'STANDBY',
'StatusMessage': 'string',
'DnsName': 'string'
},
'Config': {
'string': {
'SyncStatus': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED'|'NOT_SUBSCRIBED'|'DEPRECATED',
'UpdateToken': 'string'
}
},
'AddressTranslations': {
'PublicIPv6Addresses': [
'string',
],
'PublicIPv4Addresses': [
'string',
]
},
'NatGatewayAttachments': [
{
'NatGatewayId': 'string',
'Status': 'CREATING'|'READY'|'UPDATING'|'FAILED'|'DELETING',
'StatusMessage': 'string',
'DnsName': 'string'
},
]
}
},
'CapacityUsageSummary': {
'CIDRs': {
'AvailableCIDRCount': 123,
'UtilizedCIDRCount': 123,
'IPSetReferences': {
'string': {
'ResolvedCIDRCount': 123
}
}
}
},
'TransitGatewayAttachmentSyncState': {
'AttachmentId': 'string',
'TransitGatewayAttachmentStatus': 'CREATING'|'DELETING'|'DELETED'|'FAILED'|'ERROR'|'READY'|'PENDING_ACCEPTANCE'|'REJECTING'|'REJECTED',
'StatusMessage': 'string'
},
'ContextStoreSyncState': {
'SyncStatus': 'SYNCING'|'PARTIALLY_RESOLVED'|'FULLY_RESOLVED'|'SYNC_FAILED'|'UNRESOLVED',
'StatusMessage': 'string'
}
}
}
Response Structure
(dict) --
UpdateToken (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.
Firewall (dict) --
The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn (string) --
The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
VpcId (string) --
The unique identifier of the VPC where the firewall is in use.
SubnetMappings (list) --
The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.
These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.
In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
DeleteProtection (boolean) --
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
SubnetChangeProtection (boolean) --
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
FirewallPolicyChangeProtection (boolean) --
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
Description (string) --
A description of the firewall.
FirewallId (string) --
The unique identifier for the firewall.
Tags (list) --
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration (dict) --
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
KeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) --
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
NumberOfAssociations (integer) --
The number of VpcEndpointAssociation resources that use this firewall.
EnabledAnalysisTypes (list) --
An optional setting indicating the specific traffic analysis types to enable on the firewall.
(string) --
TransitGatewayId (string) --
The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.
TransitGatewayOwnerAccountId (string) --
The Amazon Web Services account ID that owns the transit gateway. This may be different from the firewall owner's account ID when using a shared transit gateway.
AvailabilityZoneMappings (list) --
The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.
(dict) --
Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.
To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.
AvailabilityZone (string) --
The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.
AvailabilityZoneChangeProtection (boolean) --
A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you must first disable this protection before adding or removing Availability Zones.
IgwFirewallConfiguration (dict) --
Contains the settings that configure an internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC. Network Firewall returns this setting only for an internet gateway firewall. For a standard firewall, this setting isn't present.
EnforcementMode (string) --
How the internet gateway firewall enforces its rules. The only supported value is POLICY_CONTROLLED, which means that the enforcement mode is set by the firewall policy that Amazon Web Services Network Security Manager associates with the firewall.
NatGatewayCreateMappings (list) --
The NAT gateways that you specified for Network Firewall to create for a proxy mode firewall. To get the IDs and status of the NAT gateways that are attached to the firewall, see NatGatewayAttachments in the firewall's SyncStates.
(dict) --
A NAT gateway that Network Firewall creates for a proxy mode firewall in one Availability Zone. You use this in CreateFirewall and AssociateSubnets.
To create a public NAT gateway, specify AllocationIds, and one PrivateIps address for each Elastic IP address. To create a private NAT gateway, specify only PrivateIps. You must specify at least one of them. Each Elastic IP address and private IP address can appear only once in a request.
The NAT gateway is a resource in your account. To change its IP addresses, use Amazon EC2 NAT gateway actions.
SubnetId (string) --
The ID of the subnet where Network Firewall creates the NAT gateway. The subnet must be in the firewall's VPC and can't be one of the firewall endpoint subnets. Each mapping must be in a different Availability Zone.
AllocationIds (list) --
The allocation IDs of the Elastic IP addresses for a public NAT gateway, from 1 to 8. For each allocation ID, specify one address in PrivateIps. If you don't specify this, Network Firewall creates a private NAT gateway.
(string) --
PrivateIps (list) --
The private IPv4 addresses of the NAT gateway. The addresses must be in the subnet that you specify and can't be the subnet's reserved addresses.
For a public NAT gateway, you must specify exactly one address for each Elastic IP address in AllocationIds, even if you specify only one. For a private NAT gateway, specify from 1 to 8 addresses. The first address is the primary address.
(string) --
ProxySettings (dict) --
The proxy settings of a proxy mode firewall: its listeners and, if you specified them, your own CertificateArn and DomainName.
ListenerProperties (list) --
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.
(dict) --
Open port for taking HTTP or HTTPS traffic.
Port (integer) --
Port for processing traffic.
Type (string) --
Selection of HTTP or HTTPS traffic.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate that the firewall's HTTPS proxy listener presents to clients. The certificate must be an 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.com covers proxy.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 specify DomainName. You can set them only when you create the firewall. When you call UpdateProxySettings, specify the same values.
DomainName (string) --
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.com format, and the certificate in CertificateArn must 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 specify CertificateArn. You can set them only when you create the firewall. When you call UpdateProxySettings, specify the same values.
VpcEndpoint (dict) --
The VPC and subnets for the endpoints of a proxy mode firewall.
VpcId (string) --
The ID of the VPC where Network Firewall creates the endpoints and NAT gateways of a proxy mode firewall.
SubnetMappings (list) --
The subnets where Network Firewall creates the firewall endpoints of a proxy mode firewall. Specify one subnet for each Availability Zone, and a NAT gateway mapping in each of those Availability Zones.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
ContextStoreId (string) --
The unique identifier of the context store that the firewall uses to resolve context sets in its rule groups. Network Firewall discovers the context store from the transit gateway association in Network Manager. This field is only present for transit gateway-attached firewalls whose transit gateway is associated with a context store.
ContextStoreOwnerAccountId (string) --
The Amazon Web Services account ID that owns the context store. This may be different from the firewall owner's account ID.
TransparentFilteringNatScope (string) --
How a proxy mode firewall handles traffic that isn't sent to its proxy listener. NAT_ALL sends this traffic out through the firewall's NAT gateway after inspection. NAT_NONE returns it to the firewall endpoint without address translation.
FirewallStatus (dict) --
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.
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.
Status (string) --
The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
For an internet gateway firewall, this setting is STANDBY while no Availability Zone in the VPC has resources that need the firewall. Network Firewall provisions the firewall in an Availability Zone when the first resource is launched there.
ConfigurationSyncStateSummary (string) --
The configuration sync state for the firewall. This summarizes the Config settings in the SyncStates for this firewall status object.
When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere.
This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic.
SyncStates (dict) --
Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall.
These objects provide detailed information for the settings ConfigurationSyncStateSummary and Status.
(string) --
(dict) --
The status of the firewall endpoint and firewall policy configuration for a single VPC subnet. This is part of the FirewallStatus.
For each VPC subnet that you associate with a firewall, Network Firewall does the following:
Instantiates a firewall endpoint in the subnet, ready to take traffic.
Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
Attachment (dict) --
The configuration and status for a single firewall subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (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.
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.
For an internet gateway firewall, STANDBY indicates an Availability Zone that has no resources yet. Network Firewall provisions the endpoint there when the first resource is launched in that Availability Zone.
StatusMessage (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.
DnsName (string) --
The proxy DNS name of a proxy mode firewall. Your clients send proxy requests to the firewall at this name. It's your ProxySettings DomainName if you specified one, or a name that Network Firewall generates in the format proxy-id.nfw.region.amazonaws.com.
The firewall has one proxy DNS name for every Availability Zone and VPC that it serves. In each Availability Zone, the name resolves to the firewall endpoint in that Availability Zone, so traffic stays in your client's Availability Zone. Your clients must use the VPC's Route 53 Resolver.
Config (dict) --
The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic.
(string) --
(dict) --
Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.
SyncStatus (string) --
Indicates whether this object is in sync with the version indicated in the update token.
UpdateToken (string) --
The current version of the object that is either in sync or pending synchronization.
AddressTranslations (dict) --
The public IP addresses that an internet gateway firewall uses for network address translation in this Availability Zone. Network Firewall allocates these addresses in your account and adds or removes addresses automatically based on traffic. This setting is only present for an internet gateway firewall.
PublicIPv6Addresses (list) --
The public IPv6 addresses that the internet gateway firewall uses for network address translation in this Availability Zone.
(string) --
PublicIPv4Addresses (list) --
The public IPv4 addresses that the internet gateway firewall uses for network address translation in this Availability Zone.
(string) --
NatGatewayAttachments (list) --
The NAT gateway that's attached to a proxy mode firewall in the Availability Zone, and the status of the attachment. To get NAT gateway details, such as IP addresses, use the Amazon EC2 DescribeNatGateways action.
A proxy mode firewall is READY when at least one Availability Zone's firewall endpoint and NAT gateway attachment are READY.
(dict) --
The NAT gateway that's attached to a proxy mode firewall in an Availability Zone, and the status of the attachment. Traffic that the firewall allows in the Availability Zone leaves through this NAT gateway.
NatGatewayId (string) --
The ID of the NAT gateway.
Status (string) --
The status of the NAT gateway attachment. READY means that the NAT gateway is attached and the firewall can send traffic through it. Other values are CREATING, UPDATING, DELETING, and FAILED.
StatusMessage (string) --
The reason that Network Firewall couldn't create or attach the NAT gateway, if it couldn't.
DnsName (string) --
The proxy DNS name of the firewall in this Availability Zone. This is the same as the DnsName of the firewall's Attachment.
CapacityUsageSummary (dict) --
Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
CIDRs (dict) --
Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
AvailableCIDRCount (integer) --
The number of CIDR blocks available for use by the IP set references in a firewall.
UtilizedCIDRCount (integer) --
The number of CIDR blocks used by the IP set references in a firewall.
IPSetReferences (dict) --
The list of the IP set references used by a firewall.
(string) --
(dict) --
General information about the IP set.
ResolvedCIDRCount (integer) --
Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.
TransitGatewayAttachmentSyncState (dict) --
The synchronization state of the transit gateway attachment. This indicates whether the firewall's transit gateway configuration is properly synchronized and operational. Use this to verify that your transit gateway configuration changes have been applied.
AttachmentId (string) --
The unique identifier of the transit gateway attachment.
TransitGatewayAttachmentStatus (string) --
The current status of the transit gateway attachment.
Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
StatusMessage (string) --
A message providing additional information about the current status, particularly useful when the transit gateway attachment is in a non- READY state.
Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
For information about troubleshooting endpoint failures, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
ContextStoreSyncState (dict) --
The synchronization state of the context sets in the firewall's rule groups with the firewall's context store. This field is only present when the firewall has a context store and its rule groups reference context sets.
SyncStatus (string) --
The synchronization status of the firewall's context sets. Valid values:
SYNCING - The firewall is applying the latest context store data.
FULLY_RESOLVED - All resource identifiers in the firewall's context sets resolve to resources in the context store.
PARTIALLY_RESOLVED - Some resource identifiers in the firewall's context sets don't resolve to resources in the context store.
SYNC_FAILED - The firewall couldn't sync with the context store. For details, see StatusMessage.
StatusMessage (string) --
A message that provides additional information about the synchronization status, particularly when the status is not FULLY_RESOLVED.
{'Status': {'STANDBY'}}
Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.
See also: AWS API Documentation
Request Syntax
client.describe_firewall_metadata(
FirewallArn='string'
)
string
The Amazon Resource Name (ARN) of the firewall.
dict
Response Syntax
{
'FirewallArn': 'string',
'FirewallPolicyArn': 'string',
'Description': 'string',
'Status': 'PROVISIONING'|'DELETING'|'READY'|'FAILED'|'STANDBY',
'SupportedAvailabilityZones': {
'string': {
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
}
},
'TransitGatewayAttachmentId': 'string'
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn (string) --
The Amazon Resource Name (ARN) of the firewall policy.
Description (string) --
A description of the firewall.
Status (string) --
The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
For an internet gateway firewall, this setting is STANDBY while no Availability Zone in the VPC has resources that need the firewall. Network Firewall provisions the firewall in an Availability Zone when the first resource is launched there.
SupportedAvailabilityZones (dict) --
The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined.
(string) --
(dict) --
High-level information about an Availability Zone where the firewall has an endpoint defined.
IPAddressType (string) --
The IP address type of the Firewall subnet in the Availability Zone. You can't change the IP address type after you create the subnet.
TransitGatewayAttachmentId (string) --
The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Returns the logging configuration for the specified firewall.
See also: AWS API Documentation
Request Syntax
client.describe_logging_configuration(
FirewallArn='string',
FirewallName='string',
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Response Syntax
{
'FirewallArn': 'string',
'LoggingConfiguration': {
'LogDestinationConfigs': [
{
'LogType': 'ALERT'|'FLOW'|'TLS',
'LogDestinationType': 'S3'|'CloudWatchLogs'|'KinesisDataFirehose',
'LogDestination': {
'string': 'string'
}
},
]
},
'EnableMonitoringDashboard': True|False
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
LoggingConfiguration (dict) --
Defines how Network Firewall performs logging for a Firewall.
LogDestinationConfigs (list) --
Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.
(dict) --
Defines where Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
Network Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log types.
LogType (string) --
The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.
ALERT - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.
FLOW - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.
TLS - Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
LogDestinationType (string) --
The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
LogDestination (dict) --
The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
For an Amazon S3 bucket, provide the name of the bucket, with key bucketName, and optionally provide a prefix, with key prefix. The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts: "LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }
For a CloudWatch log group, provide the name of the CloudWatch log group, with key logGroup. The following example specifies a log group named alert-log-group: "LogDestination": { "logGroup": "alert-log-group" }
For a Firehose delivery stream, provide the name of the delivery stream, with key deliveryStream. The following example specifies a delivery stream named alert-delivery-stream: "LogDestination": { "deliveryStream": "alert-delivery-stream" }
(string) --
(string) --
EnableMonitoringDashboard (boolean) --
A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.
Returns TRUE when the firewall monitoring dashboard is enabled on the firewall. Returns FALSE when the firewall monitoring dashboard is not enabled on the firewall.
{'VpcEndpointAssociationStatus': {'AssociationSyncState': {'Attachment': {'Status': {'STANDBY'}}},
'Status': {'STANDBY'}}}
Returns the data object for the specified VPC endpoint association.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_endpoint_association(
VpcEndpointAssociationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of a VPC endpoint association.
dict
Response Syntax
{
'VpcEndpointAssociation': {
'VpcEndpointAssociationId': 'string',
'VpcEndpointAssociationArn': 'string',
'FirewallArn': 'string',
'VpcId': 'string',
'SubnetMapping': {
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'VpcEndpointAssociationStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY'|'FAILED'|'STANDBY',
'AssociationSyncState': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY'|'STANDBY',
'StatusMessage': 'string',
'DnsName': 'string'
}
}
}
}
}
Response Structure
(dict) --
VpcEndpointAssociation (dict) --
The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.
VpcEndpointAssociationId (string) --
The unique identifier of the VPC endpoint association.
VpcEndpointAssociationArn (string) --
The Amazon Resource Name (ARN) of a VPC endpoint association.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
VpcId (string) --
The unique identifier of the VPC for the endpoint association.
SubnetMapping (dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
Description (string) --
A description of the VPC endpoint association.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
VpcEndpointAssociationStatus (dict) --
Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.
Status (string) --
The readiness of the configured firewall endpoint to handle network traffic.
AssociationSyncState (dict) --
The list of the Availability Zone sync states for all subnets that are defined by the firewall.
(string) --
(dict) --
The status of the firewall endpoint defined by a VpcEndpointAssociation.
Attachment (dict) --
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.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (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.
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.
For an internet gateway firewall, STANDBY indicates an Availability Zone that has no resources yet. Network Firewall provisions the endpoint there when the first resource is launched in that Availability Zone.
StatusMessage (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.
DnsName (string) --
The proxy DNS name of a proxy mode firewall. Your clients send proxy requests to the firewall at this name. It's your ProxySettings DomainName if you specified one, or a name that Network Firewall generates in the format proxy-id.nfw.region.amazonaws.com.
The firewall has one proxy DNS name for every Availability Zone and VPC that it serves. In each Availability Zone, the name resolves to the firewall endpoint in that Availability Zone, so traffic stays in your client's Availability Zone. Your clients must use the VPC's Route 53 Resolver.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Removes the specified Availability Zone associations from a transit gateway-attached firewall. This removes the firewall endpoints from these Availability Zones and stops traffic filtering in those zones. Before removing an Availability Zone, ensure you've updated your transit gateway route tables to redirect traffic appropriately.
To verify the status of your Availability Zone changes, use DescribeFirewall.
See also: AWS API Documentation
Request Syntax
client.disassociate_availability_zones(
UpdateToken='string',
FirewallArn='string',
FirewallName='string',
AvailabilityZoneMappings=[
{
'AvailabilityZone': 'string'
},
],
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
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.
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
list
[REQUIRED]
Required. The Availability Zones to remove from the firewall's configuration.
(dict) --
Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.
To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.
AvailabilityZone (string) -- [REQUIRED]
The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Response Syntax
{
'FirewallArn': 'string',
'FirewallName': 'string',
'AvailabilityZoneMappings': [
{
'AvailabilityZone': 'string'
},
],
'UpdateToken': 'string'
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
AvailabilityZoneMappings (list) --
The remaining Availability Zones where the firewall has endpoints after the disassociation.
(dict) --
Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.
To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.
AvailabilityZone (string) --
The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.
UpdateToken (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.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.
Depending on your setting for max results and the number of firewalls, a single call might not return the full list.
See also: AWS API Documentation
Request Syntax
client.list_firewalls(
NextToken='string',
VpcIds=[
'string',
],
MaxResults=123,
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
string
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
list
The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.
(string) --
integer
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
string
Specifies the firewall type to filter the results by. You can specify one of the following values:
IGW_FIREWALL - Returns only internet gateway firewalls, which Amazon Web Services Network Security Manager creates and manages for your VPCs.
FIREWALL - Returns only standard Network Firewall firewalls.
If you don't specify a type, the default is to return firewalls of both types.
dict
Response Syntax
{
'NextToken': 'string',
'Firewalls': [
{
'FirewallName': 'string',
'FirewallArn': 'string',
'TransitGatewayAttachmentId': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Firewalls (list) --
The firewall metadata objects for the VPCs that you specified. Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.
(dict) --
High-level information about a firewall, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a firewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
TransitGatewayAttachmentId (string) --
The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Enables specific types of firewall analysis on a specific firewall you define.
See also: AWS API Documentation
Request Syntax
client.update_firewall_analysis_settings(
EnabledAnalysisTypes=[
'TLS_SNI'|'HTTP_HOST',
],
FirewallArn='string',
FirewallName='string',
UpdateToken='string',
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
list
An optional setting indicating the specific traffic analysis types to enable on the firewall.
(string) --
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
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.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Response Syntax
{
'EnabledAnalysisTypes': [
'TLS_SNI'|'HTTP_HOST',
],
'FirewallArn': 'string',
'FirewallName': 'string',
'UpdateToken': 'string'
}
Response Structure
(dict) --
EnabledAnalysisTypes (list) --
An optional setting indicating the specific traffic analysis types to enable on the firewall.
(string) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
UpdateToken (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.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the firewall. If the flag is set to TRUE, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use.
See also: AWS API Documentation
Request Syntax
client.update_firewall_delete_protection(
UpdateToken='string',
FirewallArn='string',
FirewallName='string',
DeleteProtection=True|False,
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
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.
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
boolean
[REQUIRED]
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Response Syntax
{
'FirewallArn': 'string',
'FirewallName': 'string',
'DeleteProtection': True|False,
'UpdateToken': 'string'
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
DeleteProtection (boolean) --
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
UpdateToken (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.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
See also: AWS API Documentation
Request Syntax
client.update_firewall_description(
UpdateToken='string',
FirewallArn='string',
FirewallName='string',
Description='string',
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
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.
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
string
The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Response Syntax
{
'FirewallArn': 'string',
'FirewallName': 'string',
'Description': 'string',
'UpdateToken': 'string'
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
Description (string) --
A description of the firewall.
UpdateToken (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.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
A complex type that contains settings for encryption of your firewall resources.
See also: AWS API Documentation
Request Syntax
client.update_firewall_encryption_configuration(
UpdateToken='string',
FirewallArn='string',
FirewallName='string',
EncryptionConfiguration={
'KeyId': 'string',
'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
},
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
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.
string
The Amazon Resource Name (ARN) of the firewall.
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
dict
A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.
KeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) -- [REQUIRED]
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Response Syntax
{
'FirewallArn': 'string',
'FirewallName': 'string',
'UpdateToken': 'string',
'EncryptionConfiguration': {
'KeyId': 'string',
'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
}
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
UpdateToken (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.
EncryptionConfiguration (dict) --
A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.
KeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) --
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Modifies the flag, ChangeProtection, which indicates whether it is possible to change the firewall. If the flag is set to TRUE, the firewall is protected from changes. This setting helps protect against accidentally changing a firewall that's in use.
See also: AWS API Documentation
Request Syntax
client.update_firewall_policy_change_protection(
UpdateToken='string',
FirewallArn='string',
FirewallName='string',
FirewallPolicyChangeProtection=True|False,
FirewallType='FIREWALL'|'IGW_FIREWALL'
)
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.
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
boolean
[REQUIRED]
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Response Syntax
{
'UpdateToken': 'string',
'FirewallArn': 'string',
'FirewallName': 'string',
'FirewallPolicyChangeProtection': True|False
}
Response Structure
(dict) --
UpdateToken (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.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallPolicyChangeProtection (boolean) --
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
{'FirewallType': 'FIREWALL | IGW_FIREWALL'}
Sets the logging configuration for the specified firewall.
To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.
You can perform only one of the following actions in any call to UpdateLoggingConfiguration:
Create a new log destination object by adding a single LogDestinationConfig array element to LogDestinationConfigs.
Delete a log destination object by removing a single LogDestinationConfig array element from LogDestinationConfigs.
Change the LogDestination setting in a single LogDestinationConfig array element.
You can't change the LogDestinationType or LogType in a LogDestinationConfig. To change these settings, delete the existing LogDestinationConfig object and create a new one, using two separate calls to this update operation.
See also: AWS API Documentation
Request Syntax
client.update_logging_configuration(
FirewallArn='string',
FirewallName='string',
FirewallType='FIREWALL'|'IGW_FIREWALL',
LoggingConfiguration={
'LogDestinationConfigs': [
{
'LogType': 'ALERT'|'FLOW'|'TLS',
'LogDestinationType': 'S3'|'CloudWatchLogs'|'KinesisDataFirehose',
'LogDestination': {
'string': 'string'
}
},
]
},
EnableMonitoringDashboard=True|False
)
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
string
The type of firewall that the request targets. Network Firewall supports the following firewall types:
IGW_FIREWALL - An internet gateway firewall, which Amazon Web Services Network Security Manager creates and manages for a VPC.
FIREWALL - A standard Network Firewall firewall.
If you specify the firewall ARN, the type must match the resource type in the ARN. If you specify only the firewall name, Network Firewall uses this value to identify the firewall. If you don't specify a type, the default is FIREWALL.
dict
Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.
LogDestinationConfigs (list) -- [REQUIRED]
Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.
(dict) --
Defines where Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
Network Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log types.
LogType (string) -- [REQUIRED]
The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.
ALERT - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.
FLOW - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.
TLS - Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
LogDestinationType (string) -- [REQUIRED]
The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
LogDestination (dict) -- [REQUIRED]
The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
For an Amazon S3 bucket, provide the name of the bucket, with key bucketName, and optionally provide a prefix, with key prefix. The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts: "LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }
For a CloudWatch log group, provide the name of the CloudWatch log group, with key logGroup. The following example specifies a log group named alert-log-group: "LogDestination": { "logGroup": "alert-log-group" }
For a Firehose delivery stream, provide the name of the delivery stream, with key deliveryStream. The following example specifies a delivery stream named alert-delivery-stream: "LogDestination": { "deliveryStream": "alert-delivery-stream" }
(string) --
(string) --
boolean
A boolean that lets you enable or disable the detailed firewall monitoring dashboard on the firewall.
The monitoring dashboard provides comprehensive visibility into your firewall's flow logs and alert logs. After you enable detailed monitoring, you can access these dashboards directly from the Monitoring page of the Network Firewall console.
Specify TRUE to enable the the detailed monitoring dashboard on the firewall. Specify FALSE to disable the the detailed monitoring dashboard on the firewall.
dict
Response Syntax
{
'FirewallArn': 'string',
'FirewallName': 'string',
'LoggingConfiguration': {
'LogDestinationConfigs': [
{
'LogType': 'ALERT'|'FLOW'|'TLS',
'LogDestinationType': 'S3'|'CloudWatchLogs'|'KinesisDataFirehose',
'LogDestination': {
'string': 'string'
}
},
]
},
'EnableMonitoringDashboard': True|False
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
LoggingConfiguration (dict) --
Defines how Network Firewall performs logging for a Firewall.
LogDestinationConfigs (list) --
Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.
(dict) --
Defines where Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
Network Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log types.
LogType (string) --
The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.
ALERT - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.
FLOW - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.
TLS - Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
LogDestinationType (string) --
The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
LogDestination (dict) --
The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
For an Amazon S3 bucket, provide the name of the bucket, with key bucketName, and optionally provide a prefix, with key prefix. The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts: "LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }
For a CloudWatch log group, provide the name of the CloudWatch log group, with key logGroup. The following example specifies a log group named alert-log-group: "LogDestination": { "logGroup": "alert-log-group" }
For a Firehose delivery stream, provide the name of the delivery stream, with key deliveryStream. The following example specifies a delivery stream named alert-delivery-stream: "LogDestination": { "deliveryStream": "alert-delivery-stream" }
(string) --
(string) --
EnableMonitoringDashboard (boolean) --
A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.
Returns TRUE when the firewall monitoring dashboard is enabled on the firewall. Returns FALSE when the firewall monitoring dashboard is not enabled on the firewall.