create_vpc_endpoint

ElasticsearchService.Client.create_vpc_endpoint(**kwargs)

Creates an Amazon OpenSearch Service-managed VPC endpoint.

See also: AWS API Documentation

Request Syntax

response = client.create_vpc_endpoint(
    DomainArn='string',
    VpcOptions={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    ClientToken='string'
)

Parameters

• DomainArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the domain to grant access to.

• VpcOptions (dict) --

  [REQUIRED]

  Options to specify the subnets and security groups for the endpoint.

  • SubnetIds (list) --

    Specifies the subnets for VPC endpoint.

    • (string) --
  • SecurityGroupIds (list) --

    Specifies the security groups for VPC endpoint.

    • (string) --
• ClientToken (string) -- Unique, case-sensitive identifier to ensure idempotency of the request.

Return type

dict

Returns

Response Syntax

{
    'VpcEndpoint': {
        'VpcEndpointId': 'string',
        'VpcEndpointOwner': 'string',
        'DomainArn': 'string',
        'VpcOptions': {
            'VPCId': 'string',
            'SubnetIds': [
                'string',
            ],
            'AvailabilityZones': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
        'Endpoint': 'string'
    }
}

Response Structure

• (dict) --

  Container for response parameters to the CreateVpcEndpoint operation. Contains the configuration and status of the VPC Endpoint being created.

  • VpcEndpoint (dict) --

    Information about the newly created VPC endpoint.

    • VpcEndpointId (string) --

      The unique identifier of the endpoint.

    • VpcEndpointOwner (string) --

      The creator of the endpoint.

    • DomainArn (string) --

      The Amazon Resource Name (ARN) of the domain associated with the endpoint.

    • VpcOptions (dict) --

      Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

      • VPCId (string) --

        The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

      • SubnetIds (list) --

        Specifies the subnets for VPC endpoint.

        • (string) --

      • AvailabilityZones (list) --

        The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

        • (string) --

      • SecurityGroupIds (list) --

        Specifies the security groups for VPC endpoint.

        • (string) --

    • Status (string) --

      The current status of the endpoint.

    • Endpoint (string) --

      The connection endpoint ID for connecting to the domain.

Exceptions

• ElasticsearchService.Client.exceptions.ConflictException
• ElasticsearchService.Client.exceptions.ValidationException
• ElasticsearchService.Client.exceptions.LimitExceededException
• ElasticsearchService.Client.exceptions.InternalException
• ElasticsearchService.Client.exceptions.DisabledOperationException
• ElasticsearchService.Client.exceptions.BaseException