NetworkFirewall / Client / disassociate_availability_zones

disassociate_availability_zones

NetworkFirewall.Client.disassociate_availability_zones(**kwargs)

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.

Note

If AvailabilityZoneChangeProtection is enabled, you must first disable it using UpdateAvailabilityZoneChangeProtection.

To verify the status of your Availability Zone changes, use DescribeFirewall.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_availability_zones(
    UpdateToken='string',
    FirewallArn='string',
    FirewallName='string',
    AvailabilityZoneMappings=[
        {
            'AvailabilityZone': 'string'
        },
    ]
)
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.

  • AvailabilityZoneMappings (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.

Return type:

dict

Returns:

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.

Exceptions