create-route-server-endpoint¶
Description¶
Creates a new endpoint for a route server in a specified subnet.
A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide .
See also: AWS API Documentation
Synopsis¶
create-route-server-endpoint
--route-server-id <value>
--subnet-id <value>
[--client-token <value>]
[--dry-run | --no-dry-run]
[--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]
[--cli-error-format <value>]
Options¶
--route-server-id (string) [required]
The ID of the route server for which to create an endpoint.
--subnet-id (string) [required]
The ID of the subnet in which to create the route server endpoint.
--client-token (string)
Unique, case-sensitive identifier to ensure idempotency of the request.
--dry-run | --no-dry-run (boolean)
A check for 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 isDryRunOperation. Otherwise, it isUnauthorizedOperation.
--tag-specifications (list)
The tags to apply to the route server endpoint during creation.
(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
TheValid Valueslists 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-reservationclient-vpn-endpointcustomer-gatewaycarrier-gatewaycoip-pooldeclarative-policies-reportdedicated-hostdhcp-optionsegress-only-internet-gatewayelastic-ipelastic-gpuexport-image-taskexport-instance-taskfleetfpga-imagehost-reservationimageimage-usage-reportimport-image-taskimport-snapshot-taskinstanceinstance-event-windowinternet-gatewayipamipam-poolipam-scopeipv4pool-ec2ipv6pool-ec2key-pairlaunch-templatelocal-gatewaylocal-gateway-route-tablelocal-gateway-virtual-interfacelocal-gateway-virtual-interface-grouplocal-gateway-route-table-vpc-associationlocal-gateway-route-table-virtual-interface-group-associationnatgatewaynetwork-aclnetwork-interfacenetwork-insights-analysisnetwork-insights-pathnetwork-insights-access-scopenetwork-insights-access-scope-analysisoutpost-lagplacement-groupprefix-listreplace-root-volume-taskreserved-instancesroute-tablesecurity-groupsecurity-group-ruleservice-link-virtual-interfacesnapshotspot-fleet-requestspot-instances-requestsubnetsubnet-cidr-reservationtraffic-mirror-filtertraffic-mirror-sessiontraffic-mirror-targettransit-gatewaytransit-gateway-attachmenttransit-gateway-connect-peertransit-gateway-multicast-domaintransit-gateway-policy-tabletransit-gateway-metering-policytransit-gateway-route-tabletransit-gateway-route-table-announcementvolumevpcvpc-endpointvpc-endpoint-connectionvpc-endpoint-servicevpc-endpoint-service-permissionvpc-peering-connectionvpn-connectionvpn-gatewayvpc-flow-logcapacity-reservation-fleettraffic-mirror-filter-rulevpc-endpoint-connection-device-typeverified-access-instanceverified-access-groupverified-access-endpointverified-access-policyverified-access-trust-providervpn-connection-device-typevpc-block-public-access-exclusionvpc-encryption-controlroute-serverroute-server-endpointroute-server-peeripam-resource-discoveryipam-resource-discovery-associationinstance-connect-endpointverified-access-endpoint-targetipam-external-resource-verification-tokencapacity-blockmac-modification-taskipam-prefix-list-resolveripam-policyipam-prefix-list-resolver-targetipam-internet-registry-associationsecondary-interfacesecondary-networksecondary-subnetcapacity-manager-data-exportvpn-concentratoripam-pool-allocationcapacity-reservation-cancellation-quoteapplication-status-checkcapacity-reservation-modification-quoteTags -> (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"|"ipam-internet-registry-association"|"secondary-interface"|"secondary-network"|"secondary-subnet"|"capacity-manager-data-export"|"vpn-concentrator"|"ipam-pool-allocation"|"capacity-reservation-cancellation-quote"|"application-status-check"|"capacity-reservation-modification-quote",
"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.