2025/03/31 - Amazon Elastic Compute Cloud - 17 new11 updated api methods
Changes Release VPC Route Server, a new feature allowing dynamic routing in VPCs.
Gets information about the route propagations for the specified route server.
When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
See also: AWS API Documentation
Request Syntax
client.get_route_server_propagations(
RouteServerId='string',
RouteTableId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the route server for which to get propagation information.
string
The ID of the route table for which to get propagation information.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServerPropagations': [
{
'RouteServerId': 'string',
'RouteTableId': 'string',
'State': 'pending'|'available'|'deleting'
},
]
}
Response Structure
(dict) --
RouteServerPropagations (list) --
Information about the route propagations for the specified route server.
(dict) --
Describes the route propagation configuration between a route server and a route table.
When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.
RouteServerId (string) --
The ID of the route server configured for route propagation.
RouteTableId (string) --
The ID of the route table configured for route server propagation.
State (string) --
The current state of route propagation.
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. Create two endpoints per subnet for redundancy.
See also: AWS API Documentation
Request Syntax
client.create_route_server_endpoint(
RouteServerId='string',
SubnetId='string',
ClientToken='string',
DryRun=True|False,
TagSpecifications=[
{
'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'|'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'|'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-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'|'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',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
string
[REQUIRED]
The ID of the route server for which to create an endpoint.
string
[REQUIRED]
The ID of the subnet in which to create the route server endpoint.
string
Unique, case-sensitive identifier to ensure idempotency of the request.
This field is autopopulated if not provided.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The tags to apply to the route server endpoint during creation.
(dict) --
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.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(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.
dict
Response Syntax
{
'RouteServerEndpoint': {
'RouteServerId': 'string',
'RouteServerEndpointId': 'string',
'VpcId': 'string',
'SubnetId': 'string',
'EniId': 'string',
'EniAddress': 'string',
'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed'|'delete-failed',
'FailureReason': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
RouteServerEndpoint (dict) --
Information about the created route server endpoint.
RouteServerId (string) --
The ID of the route server associated with this endpoint.
RouteServerEndpointId (string) --
The unique identifier of the route server endpoint.
VpcId (string) --
The ID of the VPC containing the endpoint.
SubnetId (string) --
The ID of the subnet to place the route server endpoint into.
EniId (string) --
The ID of the Elastic network interface for the endpoint.
EniAddress (string) --
The IP address of the Elastic network interface for the endpoint.
State (string) --
The current state of the route server endpoint.
FailureReason (string) --
The reason for any failure in endpoint creation or operation.
Tags (list) --
Any tags assigned to the route server endpoint.
(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.
Creates a new route server to manage dynamic routing in a VPC.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.create_route_server(
AmazonSideAsn=123,
ClientToken='string',
DryRun=True|False,
PersistRoutes='enable'|'disable'|'reset',
PersistRoutesDuration=123,
SnsNotificationsEnabled=True|False,
TagSpecifications=[
{
'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'|'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'|'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-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'|'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',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
integer
[REQUIRED]
The private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
string
Unique, case-sensitive identifier to ensure idempotency of the request.
This field is autopopulated if not provided.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
Indicates whether routes should be persisted after all BGP sessions are terminated.
integer
The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is enabled.
If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
boolean
Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
list
The tags to apply to the route server during creation.
(dict) --
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.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(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.
dict
Response Syntax
{
'RouteServer': {
'RouteServerId': 'string',
'AmazonSideAsn': 123,
'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PersistRoutesState': 'enabling'|'enabled'|'resetting'|'disabling'|'disabled'|'modifying',
'PersistRoutesDuration': 123,
'SnsNotificationsEnabled': True|False,
'SnsTopicArn': 'string'
}
}
Response Structure
(dict) --
RouteServer (dict) --
Information about the created route server.
RouteServerId (string) --
The unique identifier of the route server.
AmazonSideAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
State (string) --
The current state of the route server.
Tags (list) --
Any tags assigned to the route server.
(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.
PersistRoutesState (string) --
The current state of route persistence for the route server.
PersistRoutesDuration (integer) --
The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'.
If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
SnsNotificationsEnabled (boolean) --
Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
SnsTopicArn (string) --
The ARN of the SNS topic where notifications are published.
Disassociates a route server from a VPC.
A route server association is the connection established between a route server and a VPC. This is a fundamental configuration step that enables the route server to work with appliances in your VPC.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.disassociate_route_server(
RouteServerId='string',
VpcId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the route server to disassociate.
string
[REQUIRED]
The ID of the VPC to disassociate from the route server.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServerAssociation': {
'RouteServerId': 'string',
'VpcId': 'string',
'State': 'associating'|'associated'|'disassociating'
}
}
Response Structure
(dict) --
RouteServerAssociation (dict) --
Information about the disassociated route server.
RouteServerId (string) --
The ID of the associated route server.
VpcId (string) --
The ID of the associated VPC.
State (string) --
The current state of the association.
Creates a new BGP peer for a specified route server endpoint.
A route server peer is a network appliance or function deployed in Amazon Web Services, such as firewall appliances and other network security functions, that meet these requirements:
Have an elastic network interface in the VPC
Support BGP (Border Gateway Protocol)
Can initiate BGP sessions
See also: AWS API Documentation
Request Syntax
client.create_route_server_peer(
RouteServerEndpointId='string',
PeerAddress='string',
BgpOptions={
'PeerAsn': 123,
'PeerLivenessDetection': 'bfd'|'bgp-keepalive'
},
DryRun=True|False,
TagSpecifications=[
{
'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'|'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'|'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-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'|'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',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
string
[REQUIRED]
The ID of the route server endpoint for which to create a peer.
string
[REQUIRED]
The IPv4 address of the peer.
dict
[REQUIRED]
The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
PeerAsn (integer) -- [REQUIRED]
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
PeerLivenessDetection (string) --
The requested liveness detection protocol for the BGP peer.
bgp-keepalive: The standard BGP keep alive mechanism ( RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure.
bfd: An additional Bidirectional Forwarding Detection (BFD) protocol ( RFC5880) that enables fast failover by using more sensitive liveness detection.
Defaults to bgp-keepalive.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The tags to apply to the route server peer during creation.
(dict) --
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.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(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.
dict
Response Syntax
{
'RouteServerPeer': {
'RouteServerPeerId': 'string',
'RouteServerEndpointId': 'string',
'RouteServerId': 'string',
'VpcId': 'string',
'SubnetId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed',
'FailureReason': 'string',
'EndpointEniId': 'string',
'EndpointEniAddress': 'string',
'PeerAddress': 'string',
'BgpOptions': {
'PeerAsn': 123,
'PeerLivenessDetection': 'bfd'|'bgp-keepalive'
},
'BgpStatus': {
'Status': 'up'|'down'
},
'BfdStatus': {
'Status': 'up'|'down'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
RouteServerPeer (dict) --
Information about the created route server peer.
RouteServerPeerId (string) --
The unique identifier of the route server peer.
RouteServerEndpointId (string) --
The ID of the route server endpoint associated with this peer.
RouteServerId (string) --
The ID of the route server associated with this peer.
VpcId (string) --
The ID of the VPC containing the route server peer.
SubnetId (string) --
The ID of the subnet containing the route server peer.
State (string) --
The current state of the route server peer.
FailureReason (string) --
The reason for any failure in peer creation or operation.
EndpointEniId (string) --
The ID of the Elastic network interface for the route server endpoint.
EndpointEniAddress (string) --
The IP address of the Elastic network interface for the route server endpoint.
PeerAddress (string) --
The IPv4 address of the peer.
BgpOptions (dict) --
The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
PeerAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
PeerLivenessDetection (string) --
The liveness detection protocol used for the BGP peer.
The requested liveness detection protocol for the BGP peer.
bgp-keepalive: The standard BGP keep alive mechanism ( RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure.
bfd: An additional Bidirectional Forwarding Detection (BFD) protocol ( RFC5880) that enables fast failover by using more sensitive liveness detection.
Defaults to bgp-keepalive.
BgpStatus (dict) --
The current status of the BGP session with this peer.
Status (string) --
The operational status of the BGP session. The status enables you to monitor session liveness if you lack monitoring on your router/appliance.
BfdStatus (dict) --
The current status of the BFD session with this peer.
Status (string) --
The operational status of the BFD session.
Tags (list) --
Any tags assigned to the route server peer.
(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.
Deletes the specified route server.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.delete_route_server(
RouteServerId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the route server to delete.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServer': {
'RouteServerId': 'string',
'AmazonSideAsn': 123,
'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PersistRoutesState': 'enabling'|'enabled'|'resetting'|'disabling'|'disabled'|'modifying',
'PersistRoutesDuration': 123,
'SnsNotificationsEnabled': True|False,
'SnsTopicArn': 'string'
}
}
Response Structure
(dict) --
RouteServer (dict) --
Information about the deleted route server.
RouteServerId (string) --
The unique identifier of the route server.
AmazonSideAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
State (string) --
The current state of the route server.
Tags (list) --
Any tags assigned to the route server.
(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.
PersistRoutesState (string) --
The current state of route persistence for the route server.
PersistRoutesDuration (integer) --
The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'.
If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
SnsNotificationsEnabled (boolean) --
Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
SnsTopicArn (string) --
The ARN of the SNS topic where notifications are published.
Deletes the specified BGP peer from a route server.
A route server peer is a network appliance or function deployed in Amazon Web Services, such as firewall appliances and other network security functions, that meet these requirements:
Have an elastic network interface in the VPC
Support BGP (Border Gateway Protocol)
Can initiate BGP sessions
See also: AWS API Documentation
Request Syntax
client.delete_route_server_peer(
RouteServerPeerId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the route server peer to delete.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServerPeer': {
'RouteServerPeerId': 'string',
'RouteServerEndpointId': 'string',
'RouteServerId': 'string',
'VpcId': 'string',
'SubnetId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed',
'FailureReason': 'string',
'EndpointEniId': 'string',
'EndpointEniAddress': 'string',
'PeerAddress': 'string',
'BgpOptions': {
'PeerAsn': 123,
'PeerLivenessDetection': 'bfd'|'bgp-keepalive'
},
'BgpStatus': {
'Status': 'up'|'down'
},
'BfdStatus': {
'Status': 'up'|'down'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
RouteServerPeer (dict) --
Information about the deleted route server peer.
RouteServerPeerId (string) --
The unique identifier of the route server peer.
RouteServerEndpointId (string) --
The ID of the route server endpoint associated with this peer.
RouteServerId (string) --
The ID of the route server associated with this peer.
VpcId (string) --
The ID of the VPC containing the route server peer.
SubnetId (string) --
The ID of the subnet containing the route server peer.
State (string) --
The current state of the route server peer.
FailureReason (string) --
The reason for any failure in peer creation or operation.
EndpointEniId (string) --
The ID of the Elastic network interface for the route server endpoint.
EndpointEniAddress (string) --
The IP address of the Elastic network interface for the route server endpoint.
PeerAddress (string) --
The IPv4 address of the peer.
BgpOptions (dict) --
The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
PeerAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
PeerLivenessDetection (string) --
The liveness detection protocol used for the BGP peer.
The requested liveness detection protocol for the BGP peer.
bgp-keepalive: The standard BGP keep alive mechanism ( RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure.
bfd: An additional Bidirectional Forwarding Detection (BFD) protocol ( RFC5880) that enables fast failover by using more sensitive liveness detection.
Defaults to bgp-keepalive.
BgpStatus (dict) --
The current status of the BGP session with this peer.
Status (string) --
The operational status of the BGP session. The status enables you to monitor session liveness if you lack monitoring on your router/appliance.
BfdStatus (dict) --
The current status of the BFD session with this peer.
Status (string) --
The operational status of the BFD session.
Tags (list) --
Any tags assigned to the route server peer.
(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.
Associates a route server with a VPC to enable dynamic route updates.
A route server association is the connection established between a route server and a VPC. This is a fundamental configuration step that enables the route server to work with appliances in your VPC.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.associate_route_server(
RouteServerId='string',
VpcId='string',
DryRun=True|False
)
string
[REQUIRED]
The unique identifier for the route server to be associated.
string
[REQUIRED]
The ID of the VPC to associate with the route server.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServerAssociation': {
'RouteServerId': 'string',
'VpcId': 'string',
'State': 'associating'|'associated'|'disassociating'
}
}
Response Structure
(dict) --
RouteServerAssociation (dict) --
Information about the association between the route server and the VPC.
RouteServerId (string) --
The ID of the associated route server.
VpcId (string) --
The ID of the associated VPC.
State (string) --
The current state of the association.
Describes one or more route servers.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_route_servers(
RouteServerIds=[
'string',
],
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
list
The IDs of the route servers to describe.
(string) --
string
The token for the next page of results.
integer
The maximum number of results to return with a single call.
list
One or more filters to apply to the describe request.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServers': [
{
'RouteServerId': 'string',
'AmazonSideAsn': 123,
'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PersistRoutesState': 'enabling'|'enabled'|'resetting'|'disabling'|'disabled'|'modifying',
'PersistRoutesDuration': 123,
'SnsNotificationsEnabled': True|False,
'SnsTopicArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RouteServers (list) --
Information about the described route servers.
(dict) --
Describes a route server and its configuration.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
RouteServerId (string) --
The unique identifier of the route server.
AmazonSideAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
State (string) --
The current state of the route server.
Tags (list) --
Any tags assigned to the route server.
(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.
PersistRoutesState (string) --
The current state of route persistence for the route server.
PersistRoutesDuration (integer) --
The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'.
If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
SnsNotificationsEnabled (boolean) --
Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
SnsTopicArn (string) --
The ARN of the SNS topic where notifications are published.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Gets the routing database for the specified route server. The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
See also: AWS API Documentation
Request Syntax
client.get_route_server_routing_database(
RouteServerId='string',
NextToken='string',
MaxResults=123,
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
string
[REQUIRED]
The ID of the route server for which to get the routing database.
string
The token for the next page of results.
integer
The maximum number of routing database entries to return in a single response.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
Filters to apply to the routing database query.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
dict
Response Syntax
{
'AreRoutesPersisted': True|False,
'Routes': [
{
'RouteServerEndpointId': 'string',
'RouteServerPeerId': 'string',
'RouteInstallationDetails': [
{
'RouteTableId': 'string',
'RouteInstallationStatus': 'installed'|'rejected',
'RouteInstallationStatusReason': 'string'
},
],
'RouteStatus': 'in-rib'|'in-fib',
'Prefix': 'string',
'AsPaths': [
'string',
],
'Med': 123,
'NextHopIp': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AreRoutesPersisted (boolean) --
Indicates whether routes are being persisted in the routing database.
Routes (list) --
The collection of routes in the route server's routing database.
(dict) --
Describes a route in the route server's routing database.
RouteServerEndpointId (string) --
The ID of the route server endpoint that received this route.
RouteServerPeerId (string) --
The ID of the route server peer that advertised this route.
RouteInstallationDetails (list) --
Details about the installation status of this route in route tables.
(dict) --
Describes the installation status of a route in a route table.
RouteTableId (string) --
The ID of the route table where the route is being installed.
RouteInstallationStatus (string) --
The current installation status of the route in the route table.
RouteInstallationStatusReason (string) --
The reason for the current installation status of the route.
RouteStatus (string) --
The current status of the route in the routing database. Values are in-rib or in-fib depending on if the routes are in the RIB or the FIB database.
The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.
The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes that are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.
Prefix (string) --
The destination CIDR block of the route.
AsPaths (list) --
The AS path attributes of the BGP route.
(string) --
Med (integer) --
The Multi-Exit Discriminator (MED) value of the BGP route.
NextHopIp (string) --
The IP address for the next hop.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Gets information about the associations for the specified route server.
A route server association is the connection established between a route server and a VPC. This is a fundamental configuration step that enables the route server to work with appliances in your VPC.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.get_route_server_associations(
RouteServerId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the route server for which to get association information.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServerAssociations': [
{
'RouteServerId': 'string',
'VpcId': 'string',
'State': 'associating'|'associated'|'disassociating'
},
]
}
Response Structure
(dict) --
RouteServerAssociations (list) --
Information about the associations for the specified route server.
(dict) --
Describes the association between a route server and a VPC.
A route server association is the connection established between a route server and a VPC. This is a fundamental configuration step that enables the route server to work with appliances in your VPC.
RouteServerId (string) --
The ID of the associated route server.
VpcId (string) --
The ID of the associated VPC.
State (string) --
The current state of the association.
Modifies the configuration of an existing route server.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.modify_route_server(
RouteServerId='string',
PersistRoutes='enable'|'disable'|'reset',
PersistRoutesDuration=123,
SnsNotificationsEnabled=True|False,
DryRun=True|False
)
string
[REQUIRED]
The ID of the route server to modify.
string
Specifies whether to persist routes after all BGP sessions are terminated.
enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.
disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.
reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.
integer
The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is enabled.
If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
boolean
Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServer': {
'RouteServerId': 'string',
'AmazonSideAsn': 123,
'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PersistRoutesState': 'enabling'|'enabled'|'resetting'|'disabling'|'disabled'|'modifying',
'PersistRoutesDuration': 123,
'SnsNotificationsEnabled': True|False,
'SnsTopicArn': 'string'
}
}
Response Structure
(dict) --
RouteServer (dict) --
Information about the modified route server.
RouteServerId (string) --
The unique identifier of the route server.
AmazonSideAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
State (string) --
The current state of the route server.
Tags (list) --
Any tags assigned to the route server.
(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.
PersistRoutesState (string) --
The current state of route persistence for the route server.
PersistRoutesDuration (integer) --
The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'.
If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
SnsNotificationsEnabled (boolean) --
Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
SnsTopicArn (string) --
The ARN of the SNS topic where notifications are published.
Describes one or more route server peers.
A route server peer is a network appliance or function deployed in Amazon Web Services, such as firewall appliances and other network security functions, that meet these requirements:
Have an elastic network interface in the VPC
Support BGP (Border Gateway Protocol)
Can initiate BGP sessions
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_route_server_peers(
RouteServerPeerIds=[
'string',
],
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
list
The IDs of the route server peers to describe.
(string) --
string
The token for the next page of results.
integer
The maximum number of results to return with a single call.
list
One or more filters to apply to the describe request.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServerPeers': [
{
'RouteServerPeerId': 'string',
'RouteServerEndpointId': 'string',
'RouteServerId': 'string',
'VpcId': 'string',
'SubnetId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed',
'FailureReason': 'string',
'EndpointEniId': 'string',
'EndpointEniAddress': 'string',
'PeerAddress': 'string',
'BgpOptions': {
'PeerAsn': 123,
'PeerLivenessDetection': 'bfd'|'bgp-keepalive'
},
'BgpStatus': {
'Status': 'up'|'down'
},
'BfdStatus': {
'Status': 'up'|'down'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RouteServerPeers (list) --
Information about the described route server peers.
(dict) --
Describes a BGP peer configuration for a route server endpoint.
A route server peer is a network appliance or function deployed in Amazon Web Services, such as firewall appliances and other network security functions, that meet these requirements:
Have an elastic network interface in the VPC
Support BGP (Border Gateway Protocol)
Can initiate BGP sessions
RouteServerPeerId (string) --
The unique identifier of the route server peer.
RouteServerEndpointId (string) --
The ID of the route server endpoint associated with this peer.
RouteServerId (string) --
The ID of the route server associated with this peer.
VpcId (string) --
The ID of the VPC containing the route server peer.
SubnetId (string) --
The ID of the subnet containing the route server peer.
State (string) --
The current state of the route server peer.
FailureReason (string) --
The reason for any failure in peer creation or operation.
EndpointEniId (string) --
The ID of the Elastic network interface for the route server endpoint.
EndpointEniAddress (string) --
The IP address of the Elastic network interface for the route server endpoint.
PeerAddress (string) --
The IPv4 address of the peer.
BgpOptions (dict) --
The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
PeerAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
PeerLivenessDetection (string) --
The liveness detection protocol used for the BGP peer.
The requested liveness detection protocol for the BGP peer.
bgp-keepalive: The standard BGP keep alive mechanism ( RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure.
bfd: An additional Bidirectional Forwarding Detection (BFD) protocol ( RFC5880) that enables fast failover by using more sensitive liveness detection.
Defaults to bgp-keepalive.
BgpStatus (dict) --
The current status of the BGP session with this peer.
Status (string) --
The operational status of the BGP session. The status enables you to monitor session liveness if you lack monitoring on your router/appliance.
BfdStatus (dict) --
The current status of the BFD session with this peer.
Status (string) --
The operational status of the BFD session.
Tags (list) --
Any tags assigned to the route server peer.
(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.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Deletes the specified route server endpoint.
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. Create two endpoints per subnet for redundancy.
See also: AWS API Documentation
Request Syntax
client.delete_route_server_endpoint(
RouteServerEndpointId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the route server endpoint to delete.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServerEndpoint': {
'RouteServerId': 'string',
'RouteServerEndpointId': 'string',
'VpcId': 'string',
'SubnetId': 'string',
'EniId': 'string',
'EniAddress': 'string',
'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed'|'delete-failed',
'FailureReason': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
RouteServerEndpoint (dict) --
Information about the deleted route server endpoint.
RouteServerId (string) --
The ID of the route server associated with this endpoint.
RouteServerEndpointId (string) --
The unique identifier of the route server endpoint.
VpcId (string) --
The ID of the VPC containing the endpoint.
SubnetId (string) --
The ID of the subnet to place the route server endpoint into.
EniId (string) --
The ID of the Elastic network interface for the endpoint.
EniAddress (string) --
The IP address of the Elastic network interface for the endpoint.
State (string) --
The current state of the route server endpoint.
FailureReason (string) --
The reason for any failure in endpoint creation or operation.
Tags (list) --
Any tags assigned to the route server endpoint.
(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.
Defines which route tables the route server can update with routes.
When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.enable_route_server_propagation(
RouteServerId='string',
RouteTableId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the route server for which to enable propagation.
string
[REQUIRED]
The ID of the route table to which route server will propagate routes.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServerPropagation': {
'RouteServerId': 'string',
'RouteTableId': 'string',
'State': 'pending'|'available'|'deleting'
}
}
Response Structure
(dict) --
RouteServerPropagation (dict) --
Information about the enabled route server propagation.
RouteServerId (string) --
The ID of the route server configured for route propagation.
RouteTableId (string) --
The ID of the route table configured for route server propagation.
State (string) --
The current state of route propagation.
Disables route propagation from a route server to a specified route table.
When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.disable_route_server_propagation(
RouteServerId='string',
RouteTableId='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the route server for which to disable propagation.
string
[REQUIRED]
The ID of the route table for which to disable route server propagation.
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServerPropagation': {
'RouteServerId': 'string',
'RouteTableId': 'string',
'State': 'pending'|'available'|'deleting'
}
}
Response Structure
(dict) --
RouteServerPropagation (dict) --
Information about the disabled route server propagation.
RouteServerId (string) --
The ID of the route server configured for route propagation.
RouteTableId (string) --
The ID of the route table configured for route server propagation.
State (string) --
The current state of route propagation.
Describes one or more route server endpoints.
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. Create two endpoints per subnet for redundancy.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_route_server_endpoints(
RouteServerEndpointIds=[
'string',
],
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
list
The IDs of the route server endpoints to describe.
(string) --
string
The token for the next page of results.
integer
The maximum number of results to return with a single call.
list
One or more filters to apply to the describe request.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'RouteServerEndpoints': [
{
'RouteServerId': 'string',
'RouteServerEndpointId': 'string',
'VpcId': 'string',
'SubnetId': 'string',
'EniId': 'string',
'EniAddress': 'string',
'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed'|'delete-failed',
'FailureReason': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RouteServerEndpoints (list) --
Information about the described route server endpoints.
(dict) --
Describes a route server endpoint and its properties.
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. Create two endpoints per subnet for redundancy.
RouteServerId (string) --
The ID of the route server associated with this endpoint.
RouteServerEndpointId (string) --
The unique identifier of the route server endpoint.
VpcId (string) --
The ID of the VPC containing the endpoint.
SubnetId (string) --
The ID of the subnet to place the route server endpoint into.
EniId (string) --
The ID of the Elastic network interface for the endpoint.
EniAddress (string) --
The IP address of the Elastic network interface for the endpoint.
State (string) --
The current state of the route server endpoint.
FailureReason (string) --
The reason for any failure in endpoint creation or operation.
Tags (list) --
Any tags assigned to the route server endpoint.
(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.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'Vpc': {'EncryptionControl': {'State': {'delete-failed', 'creating'}}}}
Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPCs in the Amazon VPC User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
See also: AWS API Documentation
Request Syntax
client.create_default_vpc(
DryRun=True|False
)
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.
dict
Response Syntax
{
'Vpc': {
'OwnerId': 'string',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string',
'Ipv6AddressAttribute': 'public'|'private',
'IpSource': 'amazon'|'byoip'|'none'
},
],
'CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'IsDefault': True|False,
'EncryptionControl': {
'VpcId': 'string',
'VpcEncryptionControlId': 'string',
'Mode': 'monitor'|'enforce',
'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed',
'StateMessage': 'string',
'ResourceExclusions': {
'InternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'EgressOnlyInternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'NatGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VirtualPrivateGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcPeering': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'BlockPublicAccessStates': {
'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress'
},
'VpcId': 'string',
'State': 'pending'|'available',
'CidrBlock': 'string',
'DhcpOptionsId': 'string'
}
}
Response Structure
(dict) --
Vpc (dict) --
Information about the VPC.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
InstanceTenancy (string) --
The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv6 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
Ipv6AddressAttribute (string) --
Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
IpSource (string) --
The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
CidrBlockAssociationSet (list) --
Information about the IPv4 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv4 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
IsDefault (boolean) --
Indicates whether the VPC is the default VPC.
EncryptionControl (dict) --
VpcId (string) --
VpcEncryptionControlId (string) --
Mode (string) --
State (string) --
StateMessage (string) --
ResourceExclusions (dict) --
InternetGateway (dict) --
State (string) --
StateMessage (string) --
EgressOnlyInternetGateway (dict) --
State (string) --
StateMessage (string) --
NatGateway (dict) --
State (string) --
StateMessage (string) --
VirtualPrivateGateway (dict) --
State (string) --
StateMessage (string) --
VpcPeering (dict) --
State (string) --
StateMessage (string) --
Tags (list) --
(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.
Tags (list) --
Any tags assigned to the VPC.
(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.
BlockPublicAccessStates (dict) --
The state of VPC Block Public Access (BPA).
InternetGatewayBlockMode (string) --
The mode of VPC BPA.
off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.
block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).
block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.
VpcId (string) --
The ID of the VPC.
State (string) --
The current state of the VPC.
CidrBlock (string) --
The primary IPv4 CIDR block for the VPC.
DhcpOptionsId (string) --
The ID of the set of DHCP options you've associated with the VPC.
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}}}
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}}}
Response {'LaunchTemplateVersion': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}}}}
{'Vpc': {'EncryptionControl': {'State': {'delete-failed', 'creating'}}}}
Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses ( BYOIP).
By default, each instance that you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP option sets in the Amazon VPC User Guide.
You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.create_vpc(
CidrBlock='string',
Ipv6Pool='string',
Ipv6CidrBlock='string',
Ipv4IpamPoolId='string',
Ipv4NetmaskLength=123,
Ipv6IpamPoolId='string',
Ipv6NetmaskLength=123,
Ipv6CidrBlockNetworkBorderGroup='string',
TagSpecifications=[
{
'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'|'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'|'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-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'|'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',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
InstanceTenancy='default'|'dedicated'|'host',
AmazonProvidedIpv6CidrBlock=True|False
)
string
The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. 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.
string
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
string
The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
string
The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
integer
The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
string
The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
integer
The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
string
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
list
The tags to assign to the VPC.
(dict) --
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.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(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.
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.
string
The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
boolean
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.
dict
Response Syntax
{
'Vpc': {
'OwnerId': 'string',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string',
'Ipv6AddressAttribute': 'public'|'private',
'IpSource': 'amazon'|'byoip'|'none'
},
],
'CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'IsDefault': True|False,
'EncryptionControl': {
'VpcId': 'string',
'VpcEncryptionControlId': 'string',
'Mode': 'monitor'|'enforce',
'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed',
'StateMessage': 'string',
'ResourceExclusions': {
'InternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'EgressOnlyInternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'NatGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VirtualPrivateGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcPeering': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'BlockPublicAccessStates': {
'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress'
},
'VpcId': 'string',
'State': 'pending'|'available',
'CidrBlock': 'string',
'DhcpOptionsId': 'string'
}
}
Response Structure
(dict) --
Vpc (dict) --
Information about the VPC.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
InstanceTenancy (string) --
The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv6 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
Ipv6AddressAttribute (string) --
Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
IpSource (string) --
The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
CidrBlockAssociationSet (list) --
Information about the IPv4 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv4 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
IsDefault (boolean) --
Indicates whether the VPC is the default VPC.
EncryptionControl (dict) --
VpcId (string) --
VpcEncryptionControlId (string) --
Mode (string) --
State (string) --
StateMessage (string) --
ResourceExclusions (dict) --
InternetGateway (dict) --
State (string) --
StateMessage (string) --
EgressOnlyInternetGateway (dict) --
State (string) --
StateMessage (string) --
NatGateway (dict) --
State (string) --
StateMessage (string) --
VirtualPrivateGateway (dict) --
State (string) --
StateMessage (string) --
VpcPeering (dict) --
State (string) --
StateMessage (string) --
Tags (list) --
(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.
Tags (list) --
Any tags assigned to the VPC.
(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.
BlockPublicAccessStates (dict) --
The state of VPC Block Public Access (BPA).
InternetGatewayBlockMode (string) --
The mode of VPC BPA.
off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.
block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).
block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.
VpcId (string) --
The ID of the VPC.
State (string) --
The current state of the VPC.
CidrBlock (string) --
The primary IPv4 CIDR block for the VPC.
DhcpOptionsId (string) --
The ID of the set of DHCP options you've associated with the VPC.
{'LaunchTemplateVersions': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}}}}
{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}},
'TagSpecifications': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}}}}
{'Tags': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}}
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_tags(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
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.
list
The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type. For a list of possible values, see TagSpecification.
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
dict
Response Syntax
{
'NextToken': 'string',
'Tags': [
{
'Key': 'string',
'ResourceId': 'string',
'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'|'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'|'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-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'|'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',
'Value': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type.
Value (string) --
The tag value.
{'Vpcs': {'EncryptionControl': {'State': {'delete-failed', 'creating'}}}}
Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.
See also: AWS API Documentation
Request Syntax
client.describe_vpcs(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpcIds=[
'string',
],
NextToken='string',
MaxResults=123,
DryRun=True|False
)
list
The filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
is-default - Indicates whether the VPC is the default VPC.
owner-id - The ID of the Amazon Web Services account that owns the VPC.
state - The state of the VPC ( pending | available).
tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
list
The IDs of the VPCs.
(string) --
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
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.
dict
Response Syntax
{
'NextToken': 'string',
'Vpcs': [
{
'OwnerId': 'string',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string',
'Ipv6AddressAttribute': 'public'|'private',
'IpSource': 'amazon'|'byoip'|'none'
},
],
'CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'IsDefault': True|False,
'EncryptionControl': {
'VpcId': 'string',
'VpcEncryptionControlId': 'string',
'Mode': 'monitor'|'enforce',
'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed',
'StateMessage': 'string',
'ResourceExclusions': {
'InternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'EgressOnlyInternetGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'NatGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VirtualPrivateGateway': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
},
'VpcPeering': {
'State': 'enabling'|'enabled'|'disabling'|'disabled',
'StateMessage': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'BlockPublicAccessStates': {
'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress'
},
'VpcId': 'string',
'State': 'pending'|'available',
'CidrBlock': 'string',
'DhcpOptionsId': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Vpcs (list) --
Information about the VPCs.
(dict) --
Describes a VPC.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the VPC.
InstanceTenancy (string) --
The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv6 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
Ipv6AddressAttribute (string) --
Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
IpSource (string) --
The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
CidrBlockAssociationSet (list) --
Information about the IPv4 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv4 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
IsDefault (boolean) --
Indicates whether the VPC is the default VPC.
EncryptionControl (dict) --
VpcId (string) --
VpcEncryptionControlId (string) --
Mode (string) --
State (string) --
StateMessage (string) --
ResourceExclusions (dict) --
InternetGateway (dict) --
State (string) --
StateMessage (string) --
EgressOnlyInternetGateway (dict) --
State (string) --
StateMessage (string) --
NatGateway (dict) --
State (string) --
StateMessage (string) --
VirtualPrivateGateway (dict) --
State (string) --
StateMessage (string) --
VpcPeering (dict) --
State (string) --
StateMessage (string) --
Tags (list) --
(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.
Tags (list) --
Any tags assigned to the VPC.
(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.
BlockPublicAccessStates (dict) --
The state of VPC Block Public Access (BPA).
InternetGatewayBlockMode (string) --
The mode of VPC BPA.
off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.
block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).
block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.
VpcId (string) --
The ID of the VPC.
State (string) --
The current state of the VPC.
CidrBlock (string) --
The primary IPv4 CIDR block for the VPC.
DhcpOptionsId (string) --
The ID of the set of DHCP options you've associated with the VPC.
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}}}
{'PoolTagSpecifications': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}}
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
See also: AWS API Documentation
Request Syntax
client.provision_byoip_cidr(
Cidr='string',
CidrAuthorizationContext={
'Message': 'string',
'Signature': 'string'
},
PubliclyAdvertisable=True|False,
Description='string',
DryRun=True|False,
PoolTagSpecifications=[
{
'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'|'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'|'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-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'|'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',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MultiRegion=True|False,
NetworkBorderGroup='string'
)
string
[REQUIRED]
The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
dict
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
Message (string) -- [REQUIRED]
The plain-text authorization message for the prefix and account.
Signature (string) -- [REQUIRED]
The signed authorization message for the prefix and account.
boolean
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
string
A description for the address range and the address pool.
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.
list
The tags to apply to the address pool.
(dict) --
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.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(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.
boolean
Reserved.
string
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'Description': 'string',
'AsnAssociations': [
{
'Asn': 'string',
'Cidr': 'string',
'StatusMessage': 'string',
'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated'
},
],
'StatusMessage': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
Cidr (string) --
The address range, in CIDR notation.
Description (string) --
The description of the address range.
AsnAssociations (list) --
The BYOIP CIDR associations with ASNs.
(dict) --
An Autonomous System Number (ASN) and BYOIP CIDR association.
Asn (string) --
The association's ASN.
Cidr (string) --
The association's CIDR.
StatusMessage (string) --
The association's status message.
State (string) --
The association's state.
StatusMessage (string) --
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
State (string) --
The state of the address range.
advertised: The address range is being advertised to the internet by Amazon Web Services.
deprovisioned: The address range is deprovisioned.
failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
failed-provision: The request to provision the address range was unsuccessful.
pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
pending-provision: You’ve submitted a request to provision an address range and it's pending.
provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
NetworkBorderGroup (string) --
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
{'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}},
'TagSpecifications': {'ResourceType': {'route-server',
'route-server-endpoint',
'route-server-peer'}}}}