Skip to content

Create Vpc Endpoint

opensearchservice_create_vpc_endpoint R Documentation

Creates an Amazon OpenSearch Service-managed VPC endpoint

Description

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Usage

opensearchservice_create_vpc_endpoint(DomainArn, VpcOptions,
  ClientToken)

Arguments

DomainArn

[required] The Amazon Resource Name (ARN) of the domain to create the endpoint for.

VpcOptions

[required] Options to specify the subnets and security groups for the endpoint.

ClientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

Value

A list with the following syntax:

list(
  VpcEndpoint = list(
    VpcEndpointId = "string",
    VpcEndpointOwner = "string",
    DomainArn = "string",
    VpcOptions = list(
      VPCId = "string",
      SubnetIds = list(
        "string"
      ),
      AvailabilityZones = list(
        "string"
      ),
      SecurityGroupIds = list(
        "string"
      )
    ),
    Status = "CREATING"|"CREATE_FAILED"|"ACTIVE"|"UPDATING"|"UPDATE_FAILED"|"DELETING"|"DELETE_FAILED",
    Endpoint = "string"
  )
)

Request syntax

svc$create_vpc_endpoint(
  DomainArn = "string",
  VpcOptions = list(
    SubnetIds = list(
      "string"
    ),
    SecurityGroupIds = list(
      "string"
    )
  ),
  ClientToken = "string"
)