AssociateSubnetsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NetworkFirewallClient, AssociateSubnetsCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import
// const { NetworkFirewallClient, AssociateSubnetsCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import
const client = new NetworkFirewallClient(config);
const input = { // AssociateSubnetsRequest
  UpdateToken: "STRING_VALUE",
  FirewallArn: "STRING_VALUE",
  FirewallName: "STRING_VALUE",
  SubnetMappings: [ // SubnetMappings // required
    { // SubnetMapping
      SubnetId: "STRING_VALUE", // required
      IPAddressType: "DUALSTACK" || "IPV4" || "IPV6",
    },
  ],
};
const command = new AssociateSubnetsCommand(input);
const response = await client.send(command);
// { // AssociateSubnetsResponse
//   FirewallArn: "STRING_VALUE",
//   FirewallName: "STRING_VALUE",
//   SubnetMappings: [ // SubnetMappings
//     { // SubnetMapping
//       SubnetId: "STRING_VALUE", // required
//       IPAddressType: "DUALSTACK" || "IPV4" || "IPV6",
//     },
//   ],
//   UpdateToken: "STRING_VALUE",
// };

AssociateSubnetsCommand Input

See AssociateSubnetsCommandInput for more details

Parameter
Type
Description
SubnetMappings
Required
SubnetMapping[] | undefined

The IDs of the subnets that you want to associate with the firewall.

FirewallArn
string | undefined

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

FirewallName
string | undefined

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 | undefined

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.

AssociateSubnetsCommand Output

See AssociateSubnetsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
FirewallArn
string | undefined

The Amazon Resource Name (ARN) of the firewall.

FirewallName
string | undefined

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

SubnetMappings
SubnetMapping[] | undefined

The IDs of the subnets that are associated with the firewall.

UpdateToken
string | undefined

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.

Throws

Name
Fault
Details
InsufficientCapacityException
server

Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

InternalServerError
server

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

InvalidOperationException
client

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

InvalidRequestException
client

The operation failed because of a problem with your request. Examples include:

  • You specified an unsupported parameter name or value.

  • You tried to update a property with a value that isn't among the available types.

  • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InvalidTokenException
client

The token you provided is stale or isn't valid for the operation.

ResourceNotFoundException
client

Unable to locate a resource using the parameters that you provided.

ThrottlingException
client

Unable to process the request due to throttling limitations.

NetworkFirewallServiceException
Base exception class for all service exceptions from NetworkFirewall service.