[ aws . ec2 ]

create-secondary-subnet

Description

Creates a secondary subnet in a secondary network.

A secondary subnet CIDR block must not overlap with the CIDR block of an existing secondary subnet in the secondary network. After you create a secondary subnet, you can’t change its CIDR block.

The allowed size for a secondary subnet CIDR block is between /28 netmask (16 IP addresses) and /12 netmask (1,048,576 IP addresses). Amazon reserves the first four IP addresses and the last IP address in each secondary subnet for internal use.

See also: AWS API Documentation

Synopsis

  create-secondary-subnet
[--client-token <value>]
[--availability-zone <value>]
[--availability-zone-id <value>]
[--dry-run | --no-dry-run]
--ipv4-cidr-block <value>
--secondary-network-id <value>
[--tag-specifications <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency .

--availability-zone (string)

The Availability Zone for the secondary subnet. You cannot specify both AvailabilityZone and AvailabilityZoneId in the same request.

--availability-zone-id (string)

The ID of the Availability Zone for the secondary subnet. This option is preferred over AvailabilityZone as it provides a consistent identifier across Amazon Web Services accounts. You cannot specify both AvailabilityZone and AvailabilityZoneId in the same request.

--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 is UnauthorizedOperation .

--ipv4-cidr-block (string) [required]

The IPv4 CIDR block for the secondary subnet. The CIDR block size must be between /12 and /28.

--secondary-network-id (string) [required]

The ID of the secondary network in which to create the secondary subnet.

--tag-specifications (list)

The tags to assign to the secondary subnet.

(structure)

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.

ResourceType -> (string)

The type of resource to tag on creation.

Possible values:

• capacity-reservation
• client-vpn-endpoint
• customer-gateway
• carrier-gateway
• coip-pool
• declarative-policies-report
• dedicated-host
• dhcp-options
• egress-only-internet-gateway
• elastic-ip
• elastic-gpu
• export-image-task
• export-instance-task
• fleet
• fpga-image
• host-reservation
• image
• image-usage-report
• 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
• outpost-lag
• placement-group
• prefix-list
• replace-root-volume-task
• reserved-instances
• route-table
• security-group
• security-group-rule
• service-link-virtual-interface
• snapshot
• spot-fleet-request
• spot-instances-request
• subnet
• subnet-cidr-reservation
• traffic-mirror-filter
• traffic-mirror-session
• traffic-mirror-target
• transit-gateway
• transit-gateway-attachment
• transit-gateway-connect-peer
• transit-gateway-multicast-domain
• transit-gateway-policy-table
• transit-gateway-metering-policy
• transit-gateway-route-table
• transit-gateway-route-table-announcement
• volume
• vpc
• vpc-endpoint
• vpc-endpoint-connection
• vpc-endpoint-service
• vpc-endpoint-service-permission
• vpc-peering-connection
• vpn-connection
• vpn-gateway
• vpc-flow-log
• capacity-reservation-fleet
• traffic-mirror-filter-rule
• vpc-endpoint-connection-device-type
• verified-access-instance
• verified-access-group
• verified-access-endpoint
• verified-access-policy
• verified-access-trust-provider
• vpn-connection-device-type
• vpc-block-public-access-exclusion
• vpc-encryption-control
• route-server
• route-server-endpoint
• route-server-peer
• ipam-resource-discovery
• ipam-resource-discovery-association
• instance-connect-endpoint
• verified-access-endpoint-target
• ipam-external-resource-verification-token
• capacity-block
• mac-modification-task
• ipam-prefix-list-resolver
• ipam-policy
• ipam-prefix-list-resolver-target
• secondary-interface
• secondary-network
• secondary-subnet
• capacity-manager-data-export
• vpn-concentrator

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"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"image-usage-report"|"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"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-metering-policy"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"vpc-encryption-control"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"capacity-block"|"mac-modification-task"|"ipam-prefix-list-resolver"|"ipam-policy"|"ipam-prefix-list-resolver-target"|"secondary-interface"|"secondary-network"|"secondary-subnet"|"capacity-manager-data-export"|"vpn-concentrator",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

SecondarySubnet -> (structure)

Information about the secondary subnet.

SecondarySubnetId -> (string)

The ID of the secondary subnet.

SecondarySubnetArn -> (string)

The Amazon Resource Name (ARN) of the secondary subnet.

SecondaryNetworkId -> (string)

The ID of the secondary network.

SecondaryNetworkType -> (string)

The type of the secondary network.

Possible values:

• rdma

OwnerId -> (string)

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

AvailabilityZoneId -> (string)

The ID of the Availability Zone of the secondary subnet.

AvailabilityZone -> (string)

The Availability Zone of the secondary subnet.

Ipv4CidrBlockAssociations -> (list)

Information about the IPv4 CIDR blocks associated with the secondary subnet.

(structure)

Describes an IPv4 CIDR block associated with a secondary subnet.

AssociationId -> (string)

The association ID for the IPv4 CIDR block.

CidrBlock -> (string)

The IPv4 CIDR block.

State -> (string)

The state of the CIDR block association.

Possible values:

• associating
• associated
• association-failed
• disassociating
• disassociated
• disassociation-failed

StateReason -> (string)

The reason for the current state of the CIDR block association.

State -> (string)

The state of the secondary subnet.

Possible values:

• create-in-progress
• create-complete
• create-failed
• delete-in-progress
• delete-complete
• delete-failed

StateReason -> (string)

The reason for the current state of the secondary subnet.

Tags -> (list)

The tags assigned to the secondary subnet.

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

ClientToken -> (string)

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.