2020/08/27 - Amazon Elastic Compute Cloud - 1 new 5 updated api methods
Changes Update ec2 client to latest version
Modifies the connection options for your Site-to-Site VPN VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the AWS side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
See also: AWS API Documentation
Request Syntax
client.modify_vpn_connection_options( VpnConnectionId='string', LocalIpv4NetworkCidr='string', RemoteIpv4NetworkCidr='string', LocalIpv6NetworkCidr='string', RemoteIpv6NetworkCidr='string', DryRun=True|False )
string
[REQUIRED]
The ID of the Site-to-Site VPN VPN connection.
string
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
string
The IPv4 CIDR on the AWS side of the VPN connection.
Default: 0.0.0.0/0
string
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
string
The IPv6 CIDR on the AWS side of the VPN connection.
Default: ::/0
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
{ 'VpnConnection': { 'CustomerGatewayConfiguration': 'string', 'CustomerGatewayId': 'string', 'Category': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'Type': 'ipsec.1', 'VpnConnectionId': 'string', 'VpnGatewayId': 'string', 'TransitGatewayId': 'string', 'Options': { 'EnableAcceleration': True|False, 'StaticRoutesOnly': True|False, 'LocalIpv4NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelInsideIpVersion': 'ipv4'|'ipv6', 'TunnelOptions': [ { 'OutsideIpAddress': 'string', 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DpdTimeoutSeconds': 123, 'DpdTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IkeVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string' }, ] }, 'Routes': [ { 'DestinationCidrBlock': 'string', 'Source': 'Static', 'State': 'pending'|'available'|'deleting'|'deleted' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VgwTelemetry': [ { 'AcceptedRouteCount': 123, 'LastStatusChange': datetime(2015, 1, 1), 'OutsideIpAddress': 'string', 'Status': 'UP'|'DOWN', 'StatusMessage': 'string', 'CertificateArn': 'string' }, ] } }
Response Structure
(dict) --
VpnConnection (dict) --
Describes a VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(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 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
{'Options': {'LocalIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelOptions': {'DPDTimeoutAction': 'string', 'StartupAction': 'string'}}}Response
{'VpnConnection': {'Options': {'LocalIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelOptions': {'DpdTimeoutAction': 'string', 'StartupAction': 'string'}}}}
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1 .
The response includes information that you need to give to your network administrator to configure your customer gateway.
Warning
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
client.create_vpn_connection( CustomerGatewayId='string', Type='string', VpnGatewayId='string', TransitGatewayId='string', DryRun=True|False, Options={ 'EnableAcceleration': True|False, 'StaticRoutesOnly': True|False, 'TunnelInsideIpVersion': 'ipv4'|'ipv6', 'TunnelOptions': [ { 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DPDTimeoutSeconds': 123, 'DPDTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IKEVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string' }, ], 'LocalIpv4NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string' }, TagSpecifications=[ { 'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] )
string
[REQUIRED]
The ID of the customer gateway.
string
[REQUIRED]
The type of VPN connection ( ipsec.1 ).
string
The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.
string
The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
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
The options for the VPN connection.
EnableAcceleration (boolean) --
Indicate whether to enable acceleration for the VPN connection.
Default: false
StaticRoutesOnly (boolean) --
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true . Use CreateVpnConnectionRoute to create a static route.
Default: false
TunnelInsideIpVersion (string) --
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
TunnelOptions (list) --
The tunnel options for the VPN connection.
(dict) --
The tunnel options for a single VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds .
Default: 3600
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage .
Constraints: A value between 60 and half of Phase2LifetimeSeconds .
Default: 540
RekeyFuzzPercentage (integer) --
The percentage of the rekey window (determined by RekeyMarginTimeSeconds ) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
DPDTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
Constraints: A value between 0 and 30.
Default: 30
DPDTimeoutAction (string) --
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
Phase1EncryptionAlgorithms (list) --
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
(dict) --
Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
(dict) --
Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
(dict) --
Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
(dict) --
Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
(dict) --
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
(dict) --
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IKEVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
(dict) --
The IKE version that is permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation.
Valid Values: add | start
Default: add
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
Default: 0.0.0.0/0
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
Default: ::/0
list
The tags to apply to the VPN connection.
(dict) --
The tags to apply to a resource when the resource is being created.
ResourceType (string) --
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume | vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags.
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 255 Unicode characters.
dict
Response Syntax
{ 'VpnConnection': { 'CustomerGatewayConfiguration': 'string', 'CustomerGatewayId': 'string', 'Category': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'Type': 'ipsec.1', 'VpnConnectionId': 'string', 'VpnGatewayId': 'string', 'TransitGatewayId': 'string', 'Options': { 'EnableAcceleration': True|False, 'StaticRoutesOnly': True|False, 'LocalIpv4NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelInsideIpVersion': 'ipv4'|'ipv6', 'TunnelOptions': [ { 'OutsideIpAddress': 'string', 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DpdTimeoutSeconds': 123, 'DpdTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IkeVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string' }, ] }, 'Routes': [ { 'DestinationCidrBlock': 'string', 'Source': 'Static', 'State': 'pending'|'available'|'deleting'|'deleted' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VgwTelemetry': [ { 'AcceptedRouteCount': 123, 'LastStatusChange': datetime(2015, 1, 1), 'OutsideIpAddress': 'string', 'Status': 'UP'|'DOWN', 'StatusMessage': 'string', 'CertificateArn': 'string' }, ] } }
Response Structure
(dict) --
Contains the output of CreateVpnConnection.
VpnConnection (dict) --
Information about the VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(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 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
{'VpnConnections': {'Options': {'LocalIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelOptions': {'DpdTimeoutAction': 'string', 'StartupAction': 'string'}}}}
Describes one or more of your VPN connections.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
client.describe_vpn_connections( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], VpnConnectionIds=[ 'string', ], DryRun=True|False )
list
One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection ( pending | available | deleting | deleted ).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag :<key> - 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.
type - The type of VPN connection. Currently the only supported type is ipsec.1 .
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
(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. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(string) --
list
One or more VPN connection IDs.
Default: Describes your VPN connections.
(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 .
dict
Response Syntax
{ 'VpnConnections': [ { 'CustomerGatewayConfiguration': 'string', 'CustomerGatewayId': 'string', 'Category': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'Type': 'ipsec.1', 'VpnConnectionId': 'string', 'VpnGatewayId': 'string', 'TransitGatewayId': 'string', 'Options': { 'EnableAcceleration': True|False, 'StaticRoutesOnly': True|False, 'LocalIpv4NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelInsideIpVersion': 'ipv4'|'ipv6', 'TunnelOptions': [ { 'OutsideIpAddress': 'string', 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DpdTimeoutSeconds': 123, 'DpdTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IkeVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string' }, ] }, 'Routes': [ { 'DestinationCidrBlock': 'string', 'Source': 'Static', 'State': 'pending'|'available'|'deleting'|'deleted' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VgwTelemetry': [ { 'AcceptedRouteCount': 123, 'LastStatusChange': datetime(2015, 1, 1), 'OutsideIpAddress': 'string', 'Status': 'UP'|'DOWN', 'StatusMessage': 'string', 'CertificateArn': 'string' }, ] }, ] }
Response Structure
(dict) --
Contains the output of DescribeVpnConnections.
VpnConnections (list) --
Information about one or more VPN connections.
(dict) --
Describes a VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(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 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
{'VpnConnection': {'Options': {'LocalIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelOptions': {'DpdTimeoutAction': 'string', 'StartupAction': 'string'}}}}
Modifies the customer gateway or the target gateway of an AWS Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in VPN Gateway Target Modification Required VPC Route Table Updates in the AWS Site-to-Site VPN User Guide .
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your AWS Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
See also: AWS API Documentation
Request Syntax
client.modify_vpn_connection( VpnConnectionId='string', TransitGatewayId='string', CustomerGatewayId='string', VpnGatewayId='string', DryRun=True|False )
string
[REQUIRED]
The ID of the VPN connection.
string
The ID of the transit gateway.
string
The ID of the customer gateway at your end of the VPN connection.
string
The ID of the virtual private gateway at the AWS side of the VPN connection.
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
{ 'VpnConnection': { 'CustomerGatewayConfiguration': 'string', 'CustomerGatewayId': 'string', 'Category': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'Type': 'ipsec.1', 'VpnConnectionId': 'string', 'VpnGatewayId': 'string', 'TransitGatewayId': 'string', 'Options': { 'EnableAcceleration': True|False, 'StaticRoutesOnly': True|False, 'LocalIpv4NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelInsideIpVersion': 'ipv4'|'ipv6', 'TunnelOptions': [ { 'OutsideIpAddress': 'string', 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DpdTimeoutSeconds': 123, 'DpdTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IkeVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string' }, ] }, 'Routes': [ { 'DestinationCidrBlock': 'string', 'Source': 'Static', 'State': 'pending'|'available'|'deleting'|'deleted' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VgwTelemetry': [ { 'AcceptedRouteCount': 123, 'LastStatusChange': datetime(2015, 1, 1), 'OutsideIpAddress': 'string', 'Status': 'UP'|'DOWN', 'StatusMessage': 'string', 'CertificateArn': 'string' }, ] } }
Response Structure
(dict) --
VpnConnection (dict) --
Describes a VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(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 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
{'VpnConnection': {'Options': {'LocalIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelOptions': {'DpdTimeoutAction': 'string', 'StartupAction': 'string'}}}}
Modifies the VPN tunnel endpoint certificate.
See also: AWS API Documentation
Request Syntax
client.modify_vpn_tunnel_certificate( VpnConnectionId='string', VpnTunnelOutsideIpAddress='string', DryRun=True|False )
string
[REQUIRED]
The ID of the AWS Site-to-Site VPN connection.
string
[REQUIRED]
The external IP address of the VPN tunnel.
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
{ 'VpnConnection': { 'CustomerGatewayConfiguration': 'string', 'CustomerGatewayId': 'string', 'Category': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'Type': 'ipsec.1', 'VpnConnectionId': 'string', 'VpnGatewayId': 'string', 'TransitGatewayId': 'string', 'Options': { 'EnableAcceleration': True|False, 'StaticRoutesOnly': True|False, 'LocalIpv4NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelInsideIpVersion': 'ipv4'|'ipv6', 'TunnelOptions': [ { 'OutsideIpAddress': 'string', 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DpdTimeoutSeconds': 123, 'DpdTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IkeVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string' }, ] }, 'Routes': [ { 'DestinationCidrBlock': 'string', 'Source': 'Static', 'State': 'pending'|'available'|'deleting'|'deleted' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VgwTelemetry': [ { 'AcceptedRouteCount': 123, 'LastStatusChange': datetime(2015, 1, 1), 'OutsideIpAddress': 'string', 'Status': 'UP'|'DOWN', 'StatusMessage': 'string', 'CertificateArn': 'string' }, ] } }
Response Structure
(dict) --
VpnConnection (dict) --
Describes a VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(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 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
{'TunnelOptions': {'DPDTimeoutAction': 'string', 'StartupAction': 'string'}}Response
{'VpnConnection': {'Options': {'LocalIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelOptions': {'DpdTimeoutAction': 'string', 'StartupAction': 'string'}}}}
Modifies the options for a VPN tunnel in an AWS Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN Tunnel Options for Your Site-to-Site VPN Connection in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
client.modify_vpn_tunnel_options( VpnConnectionId='string', VpnTunnelOutsideIpAddress='string', TunnelOptions={ 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DPDTimeoutSeconds': 123, 'DPDTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IKEVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string' }, DryRun=True|False )
string
[REQUIRED]
The ID of the AWS Site-to-Site VPN connection.
string
[REQUIRED]
The external IP address of the VPN tunnel.
dict
[REQUIRED]
The tunnel options to modify.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds .
Default: 3600
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage .
Constraints: A value between 60 and half of Phase2LifetimeSeconds .
Default: 540
RekeyFuzzPercentage (integer) --
The percentage of the rekey window (determined by RekeyMarginTimeSeconds ) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
DPDTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
Constraints: A value between 0 and 30.
Default: 30
DPDTimeoutAction (string) --
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
Phase1EncryptionAlgorithms (list) --
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
(dict) --
Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
(dict) --
Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
(dict) --
Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
(dict) --
Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
(dict) --
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
(dict) --
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IKEVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
(dict) --
The IKE version that is permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation.
Valid Values: add | start
Default: add
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
{ 'VpnConnection': { 'CustomerGatewayConfiguration': 'string', 'CustomerGatewayId': 'string', 'Category': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'Type': 'ipsec.1', 'VpnConnectionId': 'string', 'VpnGatewayId': 'string', 'TransitGatewayId': 'string', 'Options': { 'EnableAcceleration': True|False, 'StaticRoutesOnly': True|False, 'LocalIpv4NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'TunnelInsideIpVersion': 'ipv4'|'ipv6', 'TunnelOptions': [ { 'OutsideIpAddress': 'string', 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DpdTimeoutSeconds': 123, 'DpdTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IkeVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string' }, ] }, 'Routes': [ { 'DestinationCidrBlock': 'string', 'Source': 'Static', 'State': 'pending'|'available'|'deleting'|'deleted' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VgwTelemetry': [ { 'AcceptedRouteCount': 123, 'LastStatusChange': datetime(2015, 1, 1), 'OutsideIpAddress': 'string', 'Status': 'UP'|'DOWN', 'StatusMessage': 'string', 'CertificateArn': 'string' }, ] } }
Response Structure
(dict) --
VpnConnection (dict) --
Describes a VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(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 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.