pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/SubnetArgs

SubnetArgs

data class SubnetArgs(val assignIpv6AddressOnCreation: Output<Boolean>? = null, val availabilityZone: Output<String>? = null, val availabilityZoneId: Output<String>? = null, val cidrBlock: Output<String>? = null, val customerOwnedIpv4Pool: Output<String>? = null, val enableDns64: Output<Boolean>? = null, val enableLniAtDeviceIndex: Output<Int>? = null, val enableResourceNameDnsARecordOnLaunch: Output<Boolean>? = null, val enableResourceNameDnsAaaaRecordOnLaunch: Output<Boolean>? = null, val ipv6CidrBlock: Output<String>? = null, val ipv6Native: Output<Boolean>? = null, val mapCustomerOwnedIpOnLaunch: Output<Boolean>? = null, val mapPublicIpOnLaunch: Output<Boolean>? = null, val outpostArn: Output<String>? = null, val privateDnsHostnameTypeOnLaunch: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val vpcId: Output<String>? = null) : ConvertibleToJava<SubnetArgs>

Provides an VPC subnet resource.

NOTE: Due to AWS Lambda improved VPC networking changes that began deploying in September 2019, subnets associated with Lambda Functions can take up to 45 minutes to successfully delete.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const main = new aws.ec2.Subnet("main", {
    vpcId: mainAwsVpc.id,
    cidrBlock: "10.0.1.0/24",
    tags: {
        Name: "Main",
    },
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
main = aws.ec2.Subnet("main",
    vpc_id=main_aws_vpc["id"],
    cidr_block="10.0.1.0/24",
    tags={
        "Name": "Main",
    })
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var main = new Aws.Ec2.Subnet("main", new()
    {
        VpcId = mainAwsVpc.Id,
        CidrBlock = "10.0.1.0/24",
        Tags =
        {
            { "Name", "Main" },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewSubnet(ctx, "main", &ec2.SubnetArgs{
			VpcId:     pulumi.Any(mainAwsVpc.Id),
			CidrBlock: pulumi.String("10.0.1.0/24"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Main"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Subnet;
import com.pulumi.aws.ec2.SubnetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var main = new Subnet("main", SubnetArgs.builder()
            .vpcId(mainAwsVpc.id())
            .cidrBlock("10.0.1.0/24")
            .tags(Map.of("Name", "Main"))
            .build());
    }
}
Content copied to clipboard
resources:
  main:
    type: aws:ec2:Subnet
    properties:
      vpcId: ${mainAwsVpc.id}
      cidrBlock: 10.0.1.0/24
      tags:
        Name: Main
Content copied to clipboard

Subnets In Secondary VPC CIDR Blocks

When managing subnets in one of a VPC's secondary CIDR blocks created using a aws.ec2.VpcIpv4CidrBlockAssociation resource, it is recommended to reference that resource's vpc_id attribute to ensure correct dependency ordering.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const secondaryCidr = new aws.ec2.VpcIpv4CidrBlockAssociation("secondary_cidr", {
    vpcId: main.id,
    cidrBlock: "172.20.0.0/16",
});
const inSecondaryCidr = new aws.ec2.Subnet("in_secondary_cidr", {
    vpcId: secondaryCidr.vpcId,
    cidrBlock: "172.20.0.0/24",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
secondary_cidr = aws.ec2.VpcIpv4CidrBlockAssociation("secondary_cidr",
    vpc_id=main["id"],
    cidr_block="172.20.0.0/16")
in_secondary_cidr = aws.ec2.Subnet("in_secondary_cidr",
    vpc_id=secondary_cidr.vpc_id,
    cidr_block="172.20.0.0/24")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var secondaryCidr = new Aws.Ec2.VpcIpv4CidrBlockAssociation("secondary_cidr", new()
    {
        VpcId = main.Id,
        CidrBlock = "172.20.0.0/16",
    });
    var inSecondaryCidr = new Aws.Ec2.Subnet("in_secondary_cidr", new()
    {
        VpcId = secondaryCidr.VpcId,
        CidrBlock = "172.20.0.0/24",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		secondaryCidr, err := ec2.NewVpcIpv4CidrBlockAssociation(ctx, "secondary_cidr", &ec2.VpcIpv4CidrBlockAssociationArgs{
			VpcId:     pulumi.Any(main.Id),
			CidrBlock: pulumi.String("172.20.0.0/16"),
		})
		if err != nil {
			return err
		}
		_, err = ec2.NewSubnet(ctx, "in_secondary_cidr", &ec2.SubnetArgs{
			VpcId:     secondaryCidr.VpcId,
			CidrBlock: pulumi.String("172.20.0.0/24"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.VpcIpv4CidrBlockAssociation;
import com.pulumi.aws.ec2.VpcIpv4CidrBlockAssociationArgs;
import com.pulumi.aws.ec2.Subnet;
import com.pulumi.aws.ec2.SubnetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var secondaryCidr = new VpcIpv4CidrBlockAssociation("secondaryCidr", VpcIpv4CidrBlockAssociationArgs.builder()
            .vpcId(main.id())
            .cidrBlock("172.20.0.0/16")
            .build());
        var inSecondaryCidr = new Subnet("inSecondaryCidr", SubnetArgs.builder()
            .vpcId(secondaryCidr.vpcId())
            .cidrBlock("172.20.0.0/24")
            .build());
    }
}
Content copied to clipboard
resources:
  secondaryCidr:
    type: aws:ec2:VpcIpv4CidrBlockAssociation
    name: secondary_cidr
    properties:
      vpcId: ${main.id}
      cidrBlock: 172.20.0.0/16
  inSecondaryCidr:
    type: aws:ec2:Subnet
    name: in_secondary_cidr
    properties:
      vpcId: ${secondaryCidr.vpcId}
      cidrBlock: 172.20.0.0/24
Content copied to clipboard

Import

Using pulumi import, import subnets using the subnet id. For example:

$ pulumi import aws:ec2/subnet:Subnet public_subnet subnet-9d4a7b6c
Content copied to clipboard

Constructors

Link copied to clipboard
fun SubnetArgs(assignIpv6AddressOnCreation: Output<Boolean>? = null, availabilityZone: Output<String>? = null, availabilityZoneId: Output<String>? = null, cidrBlock: Output<String>? = null, customerOwnedIpv4Pool: Output<String>? = null, enableDns64: Output<Boolean>? = null, enableLniAtDeviceIndex: Output<Int>? = null, enableResourceNameDnsARecordOnLaunch: Output<Boolean>? = null, enableResourceNameDnsAaaaRecordOnLaunch: Output<Boolean>? = null, ipv6CidrBlock: Output<String>? = null, ipv6Native: Output<Boolean>? = null, mapCustomerOwnedIpOnLaunch: Output<Boolean>? = null, mapPublicIpOnLaunch: Output<Boolean>? = null, outpostArn: Output<String>? = null, privateDnsHostnameTypeOnLaunch: Output<String>? = null, tags: Output<Map<String, String>>? = null, vpcId: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): SubnetArgs

Properties

Link copied to clipboard
val assignIpv6AddressOnCreation: Output<Boolean>? = null

Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. Default is false

Link copied to clipboard
val availabilityZone: Output<String>? = null

AZ for the subnet.

Link copied to clipboard
val availabilityZoneId: Output<String>? = null

AZ ID of the subnet. This argument is not supported in all regions or partitions. If necessary, use availability_zone instead.

Link copied to clipboard
val cidrBlock: Output<String>? = null

The IPv4 CIDR block for the subnet.

Link copied to clipboard
val customerOwnedIpv4Pool: Output<String>? = null

The customer owned IPv4 address pool. Typically used with the map_customer_owned_ip_on_launch argument. The outpost_arn argument must be specified when configured.

Link copied to clipboard
val enableDns64: Output<Boolean>? = null

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. Default: false.

Link copied to clipboard
val enableLniAtDeviceIndex: Output<Int>? = null

Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). A local network interface cannot be the primary network interface (eth0).

Link copied to clipboard
val enableResourceNameDnsAaaaRecordOnLaunch: Output<Boolean>? = null

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. Default: false.

Link copied to clipboard
val enableResourceNameDnsARecordOnLaunch: Output<Boolean>? = null

Indicates whether to respond to DNS queries for instance hostnames with DNS A records. Default: false.

Link copied to clipboard
val ipv6CidrBlock: Output<String>? = null

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.

Link copied to clipboard
val ipv6Native: Output<Boolean>? = null

Indicates whether to create an IPv6-only subnet. Default: false.

Link copied to clipboard
val mapCustomerOwnedIpOnLaunch: Output<Boolean>? = null

Specify true to indicate that network interfaces created in the subnet should be assigned a customer owned IP address. The customer_owned_ipv4_pool and outpost_arn arguments must be specified when set to true. Default is false.

Link copied to clipboard
val mapPublicIpOnLaunch: Output<Boolean>? = null

Specify true to indicate that instances launched into the subnet should be assigned a public IP address. Default is false.

Link copied to clipboard
val outpostArn: Output<String>? = null

The Amazon Resource Name (ARN) of the Outpost.

Link copied to clipboard
val privateDnsHostnameTypeOnLaunch: Output<String>? = null

The type of hostnames to assign to instances in the subnet at launch. For IPv6-only subnets, an instance DNS name must be based on the instance ID. For dual-stack and IPv4-only subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. Valid values: ip-name, resource-name.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val vpcId: Output<String>? = null

The VPC ID.