create_subnet¶
Operation¶
create_subnet
async
¶
create_subnet(request: CreateSubnetInput | CreateSubnetInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateSubnetOutput
create_subnet(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateSubnetInputDict]) -> CreateSubnetOutput
Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you can't change its CIDR block.
The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for your use.
If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block with a subnet when you create it.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information, see Subnets in the Amazon VPC User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateSubnetOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
CreateSubnetInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateSubnetInput structure.
Attributes¶
availability_zone
class-attribute
instance-attribute
¶
availability_zone: str | None = ...
The Availability Zone or Local Zone for the subnet.
Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID,
for example us-west-2-lax-1a. For information about the Regions that
support Local Zones, see Available Local
Zones.
To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.
availability_zone_id
class-attribute
instance-attribute
¶
availability_zone_id: str | None = ...
The AZ ID or the Local Zone ID of the subnet.
cidr_block
class-attribute
instance-attribute
¶
cidr_block: str | None = ...
The IPv4 network range for the subnet, in CIDR notation. For example,
10.0.0.0/24. We modify the specified CIDR block to its canonical form;
for example, if you specify 100.68.0.18/18, we modify it to
100.68.0.0/18.
This parameter is not supported for an IPv6 only subnet.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
ipv4_ipam_pool_id
class-attribute
instance-attribute
¶
ipv4_ipam_pool_id: str | None = ...
An IPv4 IPAM pool ID for the subnet.
ipv4_netmask_length
class-attribute
instance-attribute
¶
ipv4_netmask_length: int | None = ...
An IPv4 netmask length for the subnet.
ipv6_cidr_block
class-attribute
instance-attribute
¶
ipv6_cidr_block: str | None = ...
The IPv6 network range for the subnet, in CIDR notation. This parameter is required for an IPv6 only subnet.
ipv6_ipam_pool_id
class-attribute
instance-attribute
¶
ipv6_ipam_pool_id: str | None = ...
An IPv6 IPAM pool ID for the subnet.
ipv6_native
class-attribute
instance-attribute
¶
ipv6_native: bool | None = ...
Indicates whether to create an IPv6 only subnet.
ipv6_netmask_length
class-attribute
instance-attribute
¶
ipv6_netmask_length: int | None = ...
An IPv6 netmask length for the subnet.
outpost_arn
class-attribute
instance-attribute
¶
outpost_arn: str | None = ...
The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to assign to the subnet.
Dictionaries¶
CreateSubnetInputDict
¶
Bases: TypedDict
Dictionary form of CreateSubnetInput.
Attributes¶
availability_zone
instance-attribute
¶
availability_zone: str | None
The Availability Zone or Local Zone for the subnet.
Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID,
for example us-west-2-lax-1a. For information about the Regions that
support Local Zones, see Available Local
Zones.
To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.
availability_zone_id
instance-attribute
¶
availability_zone_id: str | None
The AZ ID or the Local Zone ID of the subnet.
cidr_block
instance-attribute
¶
cidr_block: str | None
The IPv4 network range for the subnet, in CIDR notation. For example,
10.0.0.0/24. We modify the specified CIDR block to its canonical form;
for example, if you specify 100.68.0.18/18, we modify it to
100.68.0.0/18.
This parameter is not supported for an IPv6 only subnet.
dry_run
instance-attribute
¶
dry_run: bool | None
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.
ipv4_ipam_pool_id
instance-attribute
¶
ipv4_ipam_pool_id: str | None
An IPv4 IPAM pool ID for the subnet.
ipv4_netmask_length
instance-attribute
¶
ipv4_netmask_length: int | None
An IPv4 netmask length for the subnet.
ipv6_cidr_block
instance-attribute
¶
ipv6_cidr_block: str | None
The IPv6 network range for the subnet, in CIDR notation. This parameter is required for an IPv6 only subnet.
ipv6_ipam_pool_id
instance-attribute
¶
ipv6_ipam_pool_id: str | None
An IPv6 IPAM pool ID for the subnet.
ipv6_native
instance-attribute
¶
ipv6_native: bool | None
Indicates whether to create an IPv6 only subnet.
ipv6_netmask_length
instance-attribute
¶
ipv6_netmask_length: int | None
An IPv6 netmask length for the subnet.
outpost_arn
instance-attribute
¶
outpost_arn: str | None
The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
The tags to assign to the subnet.
Output¶
CreateSubnetOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateSubnetOutput structure.