azurermSubnetNatGatewayAssociation
Associates a NAT Gateway with a Subnet within a Virtual Network.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "example-nat-gateway-rg",
}
);
const azurermVirtualNetworkExample = new azurerm.virtualNetwork.VirtualNetwork(
this,
"example_1",
{
address_space: ["10.0.0.0/16"],
location: azurermResourceGroupExample.location,
name: "example-network",
resource_group_name: azurermResourceGroupExample.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermVirtualNetworkExample.overrideLogicalId("example");
const azurermNatGatewayExample = new azurerm.natGateway.NatGateway(
this,
"example_2",
{
location: azurermResourceGroupExample.location,
name: "example-natgateway",
resource_group_name: azurermResourceGroupExample.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermNatGatewayExample.overrideLogicalId("example");
const azurermSubnetExample = new azurerm.subnet.Subnet(this, "example_3", {
address_prefixes: ["10.0.2.0/24"],
name: "example-subnet",
resource_group_name: azurermResourceGroupExample.name,
virtual_network_name: azurermVirtualNetworkExample.name,
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSubnetExample.overrideLogicalId("example");
const azurermSubnetNatGatewayAssociationExample =
new azurerm.subnetNatGatewayAssociation.SubnetNatGatewayAssociation(
this,
"example_4",
{
nat_gateway_id: azurermNatGatewayExample.id,
subnet_id: azurermSubnetExample.id,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSubnetNatGatewayAssociationExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
natGatewayId
- (Required) The ID of the NAT Gateway which should be associated with the Subnet. Changing this forces a new resource to be created. -
subnetId
- (Required) The ID of the Subnet. Changing this forces a new resource to be created.
Attributes Reference
The following attributes are exported:
id
- The ID of the Subnet.
Timeouts
The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 30 minutes) Used when creating the Subnet NAT Gateway Association.update
- (Defaults to 30 minutes) Used when updating the Subnet NAT Gateway Association.read
- (Defaults to 5 minutes) Used when retrieving the Subnet NAT Gateway Association.delete
- (Defaults to 30 minutes) Used when deleting the Subnet NAT Gateway Association.
Import
Subnet NAT Gateway Associations can be imported using the resourceId
of the Subnet, e.g.