create-subnet-cidr-reservation¶
Description¶
Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-subnet-cidr-reservation
[--tag-specifications <value>]
--subnet-id <value>
--cidr <value>
--reservation-type <value>
[--description <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--tag-specifications (list)
The tags to assign to the subnet CIDR reservation.
(structure)
The tags to apply to a resource when the resource is being created.
ResourceType -> (string)
The type of resource to tag on creation.
Tags -> (list)
The tags to apply to the resource.
(structure)
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.
Shorthand Syntax:
ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...
JSON Syntax:
[
{
"ResourceType": "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-service"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log",
"Tags": [
{
"Key": "string",
"Value": "string"
}
...
]
}
...
]
--subnet-id (string)
The ID of the subnet.
--cidr (string)
The IPv4 or IPV6 CIDR range to reserve.
--reservation-type (string)
The type of reservation.
The following are valid values:
prefix: The Amazon EC2 Prefix Delegation feature assigns the IP addresses to network interfaces that are associated with an instance. For information about Prefix Delegation, see Prefix Delegation for Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .
explicit: You manually assign the IP addresses to resources that reside in your subnet.Possible values:
prefix
explicit
--description (string)
The description to assign to the subnet CIDR reservation.
--dry-run | --no-dry-run (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 isUnauthorizedOperation.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To create a subnet CIDR reservation
The following create-subnet-cidr-reservation example creates a subnet CIDR reservation for the specified subnet and CIDR range.
aws ec2 create-subnet-cidr-reservation \
--subnet-id subnet-03c51e2eEXAMPLE \
--reservation-type prefix \
--cidr 10.1.0.20/26
Output:
{
"SubnetCidrReservation": {
"SubnetCidrReservationId": "scr-044f977c4eEXAMPLE",
"SubnetId": "subnet-03c51e2e6cEXAMPLE",
"Cidr": "10.1.0.16/28",
"ReservationType": "prefix",
"OwnerId": "123456789012"
}
}
For more information, see Subnet CIDR reservations in the Amazon VPC User Guide.
Output¶
SubnetCidrReservation -> (structure)
Information about the created subnet CIDR reservation.
SubnetCidrReservationId -> (string)
The ID of the subnet CIDR reservation.
SubnetId -> (string)
The ID of the subnet.
Cidr -> (string)
The CIDR that has been reserved.
ReservationType -> (string)
The type of reservation.
OwnerId -> (string)
The ID of the account that owns the subnet CIDR reservation.
Description -> (string)
The description assigned to the subnet CIDR reservation.
Tags -> (list)
The tags assigned to the subnet CIDR reservation.
(structure)
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.