VPCLattice / Client / create_resource_gateway

create_resource_gateway

VPCLattice.Client.create_resource_gateway(**kwargs)

A resource gateway is a point of ingress into the VPC where a resource resides. It spans multiple Availability Zones. For your resource to be accessible from all Availability Zones, you should create your resource gateways to span as many Availability Zones as possible. A VPC can have multiple resource gateways.

See also: AWS API Documentation

Request Syntax

response = client.create_resource_gateway(
    clientToken='string',
    name='string',
    vpcIdentifier='string',
    subnetIds=[
        'string',
    ],
    securityGroupIds=[
        'string',
    ],
    ipAddressType='IPV4'|'IPV6'|'DUALSTACK',
    ipv4AddressesPerEni=123,
    tags={
        'string': 'string'
    }
)

Parameters:

• clientToken (string) –

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.

  This field is autopopulated if not provided.

• name (string) –

  [REQUIRED]

  The name of the resource gateway.

• vpcIdentifier (string) – The ID of the VPC for the resource gateway.

• subnetIds (list) –

  The IDs of the VPC subnets in which to create the resource gateway.

  • (string) –

• securityGroupIds (list) –

  The IDs of the security groups to apply to the resource gateway. The security groups must be in the same VPC.

  • (string) –

• ipAddressType (string) –

  A resource gateway can have IPv4, IPv6 or dualstack addresses. The IP address type of a resource gateway must be compatible with the subnets of the resource gateway and the IP address type of the resource, as described here:

  • **IPv4**Assign IPv4 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets have IPv4 address ranges, and the resource also has an IPv4 address.

  • **IPv6**Assign IPv6 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets are IPv6 only subnets, and the resource also has an IPv6 address.

  • **Dualstack**Assign both IPv4 and IPv6 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets have both IPv4 and IPv6 address ranges, and the resource either has an IPv4 or IPv6 address.

  The IP address type of the resource gateway is independent of the IP address type of the client or the VPC endpoint through which the resource is accessed.

• ipv4AddressesPerEni (integer) – The number of IPv4 addresses in each ENI for the resource gateway.

• tags (dict) –

  The tags for the resource gateway.

  • (string) –

    The key of the tag.

    Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with aws:.

    • (string) –

      The value of the tag.

      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'id': 'string',
    'arn': 'string',
    'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
    'vpcIdentifier': 'string',
    'subnetIds': [
        'string',
    ],
    'securityGroupIds': [
        'string',
    ],
    'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK',
    'ipv4AddressesPerEni': 123
}

Response Structure

• (dict) –

  • name (string) –

    The name of the resource gateway.

  • id (string) –

    The ID of the resource gateway.

  • arn (string) –

    The Amazon Resource Name (ARN) of the resource gateway.

  • status (string) –

    The status of the resource gateway.

  • vpcIdentifier (string) –

    The ID of the VPC.

  • subnetIds (list) –

    The IDs of the resource gateway subnets.

    • (string) –

  • securityGroupIds (list) –

    The IDs of the security groups for the resource gateway.

    • (string) –

  • ipAddressType (string) –

    The type of IP address for the resource gateway.

  • ipv4AddressesPerEni (integer) –

    The number of IPv4 addresses in each ENI for the resource gateway.

Exceptions

• VPCLattice.Client.exceptions.ValidationException

• VPCLattice.Client.exceptions.AccessDeniedException

• VPCLattice.Client.exceptions.ConflictException

• VPCLattice.Client.exceptions.ResourceNotFoundException

• VPCLattice.Client.exceptions.ThrottlingException

• VPCLattice.Client.exceptions.ServiceQuotaExceededException

• VPCLattice.Client.exceptions.InternalServerException