EC2 / Client / create_default_subnet

create_default_subnet

EC2.Client.create_default_subnet(**kwargs)

Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Create a default subnet in the Amazon VPC User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_default_subnet(
    AvailabilityZone='string',
    DryRun=True|False,
    Ipv6Native=True|False
)

Parameters:

• AvailabilityZone (string) –

  [REQUIRED]

  The Availability Zone in which to create the default subnet.

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

• Ipv6Native (boolean) – Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.

Return type:

dict

Returns:

Response Syntax

{
    'Subnet': {
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'AvailableIpAddressCount': 123,
        'CidrBlock': 'string',
        'DefaultForAz': True|False,
        'EnableLniAtDeviceIndex': 123,
        'MapPublicIpOnLaunch': True|False,
        'MapCustomerOwnedIpOnLaunch': True|False,
        'CustomerOwnedIpv4Pool': 'string',
        'State': 'pending'|'available'|'unavailable',
        'SubnetId': 'string',
        'VpcId': 'string',
        'OwnerId': 'string',
        'AssignIpv6AddressOnCreation': True|False,
        'Ipv6CidrBlockAssociationSet': [
            {
                'AssociationId': 'string',
                'Ipv6CidrBlock': 'string',
                'Ipv6CidrBlockState': {
                    'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
                    'StatusMessage': 'string'
                }
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SubnetArn': 'string',
        'OutpostArn': 'string',
        'EnableDns64': True|False,
        'Ipv6Native': True|False,
        'PrivateDnsNameOptionsOnLaunch': {
            'HostnameType': 'ip-name'|'resource-name',
            'EnableResourceNameDnsARecord': True|False,
            'EnableResourceNameDnsAAAARecord': True|False
        }
    }
}

Response Structure

• (dict) –

  • Subnet (dict) –

    Information about the subnet.

    • AvailabilityZone (string) –

      The Availability Zone of the subnet.

    • AvailabilityZoneId (string) –

      The AZ ID of the subnet.

    • AvailableIpAddressCount (integer) –

      The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

    • CidrBlock (string) –

      The IPv4 CIDR block assigned to the subnet.

    • DefaultForAz (boolean) –

      Indicates whether this is the default subnet for the Availability Zone.

    • EnableLniAtDeviceIndex (integer) –

      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).

    • MapPublicIpOnLaunch (boolean) –

      Indicates whether instances launched in this subnet receive a public IPv4 address.

      Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

    • MapCustomerOwnedIpOnLaunch (boolean) –

      Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

    • CustomerOwnedIpv4Pool (string) –

      The customer-owned IPv4 address pool associated with the subnet.

    • State (string) –

      The current state of the subnet.

    • SubnetId (string) –

      The ID of the subnet.

    • VpcId (string) –

      The ID of the VPC the subnet is in.

    • OwnerId (string) –

      The ID of the Amazon Web Services account that owns the subnet.

    • AssignIpv6AddressOnCreation (boolean) –

      Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

    • Ipv6CidrBlockAssociationSet (list) –

      Information about the IPv6 CIDR blocks associated with the subnet.

      • (dict) –

        Describes an association between a subnet and an IPv6 CIDR block.

        • AssociationId (string) –

          The ID of the association.

        • Ipv6CidrBlock (string) –

          The IPv6 CIDR block.

        • Ipv6CidrBlockState (dict) –

          The state of the CIDR block.

          • State (string) –

            The state of a CIDR block.

          • StatusMessage (string) –

            A message about the status of the CIDR block, if applicable.

    • Tags (list) –

      Any tags assigned to the subnet.

      • (dict) –

        Describes a tag.

        • Key (string) –

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value (string) –

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

    • SubnetArn (string) –

      The Amazon Resource Name (ARN) of the subnet.

    • OutpostArn (string) –

      The Amazon Resource Name (ARN) of the Outpost.

    • EnableDns64 (boolean) –

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

    • Ipv6Native (boolean) –

      Indicates whether this is an IPv6 only subnet.

    • PrivateDnsNameOptionsOnLaunch (dict) –

      The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.

      • HostnameType (string) –

        The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.

      • EnableResourceNameDnsARecord (boolean) –

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

      • EnableResourceNameDnsAAAARecord (boolean) –

        Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.