VPCLattice / Client / create_resource_gateway

create_resource_gateway#

VPCLattice.Client.create_resource_gateway(**kwargs)#

Creates a resource gateway.

See also: AWS API Documentation

Request Syntax

response = client.create_resource_gateway(
    clientToken='string',
    ipAddressType='IPV4'|'IPV6'|'DUALSTACK',
    name='string',
    securityGroupIds=[
        'string',
    ],
    subnetIds=[
        'string',
    ],
    tags={
        'string': 'string'
    },
    vpcIdentifier='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.

  • ipAddressType (string) – The type of IP address used by the resource gateway.

  • name (string) –

    [REQUIRED]

    The name of the resource gateway.

  • securityGroupIds (list) –

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

    • (string) –

  • subnetIds (list) –

    [REQUIRED]

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

    • (string) –

  • 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: _ . : / = + - @

  • vpcIdentifier (string) –

    [REQUIRED]

    The ID of the VPC for the resource gateway.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • arn (string) –

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

    • id (string) –

      The ID of the resource gateway.

    • ipAddressType (string) –

      The type of IP address for the resource gateway.

    • name (string) –

      The name of the resource gateway.

    • securityGroupIds (list) –

      The IDs of the security groups for the resource gateway.

      • (string) –

    • status (string) –

      The status of the resource gateway.

    • subnetIds (list) –

      The IDs of the resource gateway subnets.

      • (string) –

    • vpcIdentifier (string) –

      The ID of the VPC.

Exceptions