NetworkFirewall / Client / associate_subnets

associate_subnets#

NetworkFirewall.Client.associate_subnets(**kwargs)#

Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.

This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall’s protections, you must also modify the VPC’s route tables for each subnet’s Availability Zone, to redirect the traffic that’s coming into and going out of the zone through the firewall endpoint.

See also: AWS API Documentation

Request Syntax

response = client.associate_subnets(
    UpdateToken='string',
    FirewallArn='string',
    FirewallName='string',
    SubnetMappings=[
        {
            'SubnetId': 'string',
            'IPAddressType': 'DUALSTACK'|'IPV4'
        },
    ]
)

Parameters:

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.

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.
SubnetMappings (list) –
[REQUIRED]

The IDs of the subnets that you want to associate with the firewall.
- (dict) –
  
  The ID for a subnet that you want to associate with the firewall. This is used with CreateFirewall and AssociateSubnets. 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.

Return type:

dict

Returns:

Response Syntax

{
    'FirewallArn': 'string',
    'FirewallName': 'string',
    'SubnetMappings': [
        {
            'SubnetId': 'string',
            'IPAddressType': 'DUALSTACK'|'IPV4'
        },
    ],
    '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.
- SubnetMappings (list) –
  
  The IDs of the subnets that are associated with the firewall.
  - (dict) –
    
    The ID for a subnet that you want to associate with the firewall. This is used with CreateFirewall and AssociateSubnets. 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.
- 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.

Exceptions

NetworkFirewall.Client.exceptions.InvalidRequestException
NetworkFirewall.Client.exceptions.InternalServerError
NetworkFirewall.Client.exceptions.ResourceNotFoundException
NetworkFirewall.Client.exceptions.ThrottlingException
NetworkFirewall.Client.exceptions.InvalidTokenException
NetworkFirewall.Client.exceptions.InvalidOperationException
NetworkFirewall.Client.exceptions.InsufficientCapacityException