Amazon Elastic Compute Cloud

2024/05/28 - Amazon Elastic Compute Cloud - 2 updated api methods

Changes  Providing support to accept BgpAsnExtended attribute

CreateCustomerGateway (updated) Link ¶
Changes (request, response)
Request 
{'BgpAsnExtended': 'long'}
Response 
{'CustomerGateway': {'BgpAsnExtended': 'string'}}

Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide .

To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.

See also: AWS API Documentation

Request Syntax

client.create_customer_gateway(
    BgpAsn=123,
    PublicIp='string',
    CertificateArn='string',
    Type='ipsec.1',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'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'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DeviceName='string',
    IpAddress='string',
    DryRun=True|False,
    BgpAsnExtended=123
)
type BgpAsn

integer

param BgpAsn

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647 , you must use BgpAsnExtended .

Default: 65000

Valid values: 1 to 2,147,483,647

type PublicIp

string

param PublicIp

This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

type CertificateArn

string

param CertificateArn

The Amazon Resource Name (ARN) for the customer gateway certificate.

type Type

string

param Type

[REQUIRED]

The type of VPN connection that this customer gateway supports ( ipsec.1 ).

type TagSpecifications

list

param TagSpecifications

The tags to apply to the customer gateway.

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

    Note

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

    • ResourceType (string) --

      The type of resource to tag on creation.

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

type DeviceName

string

param DeviceName

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

type IpAddress

string

param IpAddress

IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4 , you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4 , you can use a public IPv4 address.

type DryRun

boolean

param DryRun

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 .

type BgpAsnExtended

integer

param BgpAsnExtended

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647 , you must use BgpAsnExtended .

Valid values: 2,147,483,648 to 4,294,967,295

rtype

dict

returns

Response Syntax

{
    'CustomerGateway': {
        'BgpAsn': 'string',
        'CustomerGatewayId': 'string',
        'IpAddress': 'string',
        'CertificateArn': 'string',
        'State': 'string',
        'Type': 'string',
        'DeviceName': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'BgpAsnExtended': 'string'
    }
}

Response Structure

  • (dict) --

    Contains the output of CreateCustomerGateway.

    • CustomerGateway (dict) --

      Information about the customer gateway.

      • BgpAsn (string) --

        The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

        Valid values: 1 to 2,147,483,647

      • CustomerGatewayId (string) --

        The ID of the customer gateway.

      • IpAddress (string) --

        IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4 , you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4 , you can use a public IPv4 address.

      • CertificateArn (string) --

        The Amazon Resource Name (ARN) for the customer gateway certificate.

      • State (string) --

        The current state of the customer gateway ( pending | available | deleting | deleted ).

      • Type (string) --

        The type of VPN connection the customer gateway supports ( ipsec.1 ).

      • DeviceName (string) --

        The name of customer gateway device.

      • Tags (list) --

        Any tags assigned to the customer gateway.

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

      • BgpAsnExtended (string) --

        The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

        Valid values: 2,147,483,648 to 4,294,967,295

DescribeCustomerGateways (updated) Link ¶
Changes (response) 
{'CustomerGateways': {'BgpAsnExtended': 'string'}}

Describes one or more of your VPN customer gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide .

See also: AWS API Documentation

Request Syntax

client.describe_customer_gateways(
    CustomerGatewayIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)
type CustomerGatewayIds

list

param CustomerGatewayIds

One or more customer gateway IDs.

Default: Describes all your customer gateways.

  • (string) --

type Filters

list

param Filters

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway device's external interface.

  • state - The state of the customer gateway ( pending | available | deleting | deleted ).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1 .

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

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

    • 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) --

type DryRun

boolean

param DryRun

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 .

rtype

dict

returns

Response Syntax

{
    'CustomerGateways': [
        {
            'BgpAsn': 'string',
            'CustomerGatewayId': 'string',
            'IpAddress': 'string',
            'CertificateArn': 'string',
            'State': 'string',
            'Type': 'string',
            'DeviceName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'BgpAsnExtended': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Contains the output of DescribeCustomerGateways.

    • CustomerGateways (list) --

      Information about one or more customer gateways.

      • (dict) --

        Describes a customer gateway.

        • BgpAsn (string) --

          The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

          Valid values: 1 to 2,147,483,647

        • CustomerGatewayId (string) --

          The ID of the customer gateway.

        • IpAddress (string) --

          IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4 , you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4 , you can use a public IPv4 address.

        • CertificateArn (string) --

          The Amazon Resource Name (ARN) for the customer gateway certificate.

        • State (string) --

          The current state of the customer gateway ( pending | available | deleting | deleted ).

        • Type (string) --

          The type of VPN connection the customer gateway supports ( ipsec.1 ).

        • DeviceName (string) --

          The name of customer gateway device.

        • Tags (list) --

          Any tags assigned to the customer gateway.

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

        • BgpAsnExtended (string) --

          The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

          Valid values: 2,147,483,648 to 4,294,967,295