Skip to content

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint

Description

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Usage

opensearchservice_authorize_vpc_endpoint_access(DomainName, Account,
  Service, ServiceOptions)

Arguments

  • DomainName

    [required] The name of the OpenSearch Service domain to provide access to.

  • Account

    The Amazon Web Services account ID to grant access to.

  • Service

    The Amazon Web Services service SP to grant access to.

  • ServiceOptions

    The options for the service, including the supported Regions for the endpoint access.

Value

A list with the following syntax:

list(
  AuthorizedPrincipal = list(
    PrincipalType = "AWS_ACCOUNT"|"AWS_SERVICE",
    Principal = "string",
    ServiceOptions = list(
      SupportedRegions = list(
        "string"
      )
    )
  )
)

Request syntax

svc$authorize_vpc_endpoint_access(
  DomainName = "string",
  Account = "string",
  Service = "application.opensearchservice.amazonaws.com",
  ServiceOptions = list(
    SupportedRegions = list(
      "string"
    )
  )
)