Create Outbound Connection

opensearchservice_create_outbound_connection

R Documentation

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain¶

Description¶

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Usage¶

opensearchservice_create_outbound_connection(LocalDomainInfo,
  RemoteDomainInfo, ConnectionAlias, ConnectionMode, ConnectionProperties)

Arguments¶

LocalDomainInfo: [required] Name and Region of the source (local) domain.
RemoteDomainInfo: [required] Name and Region of the destination (remote) domain.
ConnectionAlias: [required] Name of the connection.
ConnectionMode: The connection mode.
ConnectionProperties: The ConnectionProperties for the outbound connection.

Value¶

A list with the following syntax:

list(
  LocalDomainInfo = list(
    AWSDomainInformation = list(
      OwnerId = "string",
      DomainName = "string",
      Region = "string"
    )
  ),
  RemoteDomainInfo = list(
    AWSDomainInformation = list(
      OwnerId = "string",
      DomainName = "string",
      Region = "string"
    )
  ),
  ConnectionAlias = "string",
  ConnectionStatus = list(
    StatusCode = "VALIDATING"|"VALIDATION_FAILED"|"PENDING_ACCEPTANCE"|"APPROVED"|"PROVISIONING"|"ACTIVE"|"REJECTING"|"REJECTED"|"DELETING"|"DELETED",
    Message = "string"
  ),
  ConnectionId = "string",
  ConnectionMode = "DIRECT"|"VPC_ENDPOINT",
  ConnectionProperties = list(
    Endpoint = "string",
    CrossClusterSearch = list(
      SkipUnavailable = "ENABLED"|"DISABLED"
    )
  )
)

Request syntax¶

svc$create_outbound_connection(
  LocalDomainInfo = list(
    AWSDomainInformation = list(
      OwnerId = "string",
      DomainName = "string",
      Region = "string"
    )
  ),
  RemoteDomainInfo = list(
    AWSDomainInformation = list(
      OwnerId = "string",
      DomainName = "string",
      Region = "string"
    )
  ),
  ConnectionAlias = "string",
  ConnectionMode = "DIRECT"|"VPC_ENDPOINT",
  ConnectionProperties = list(
    Endpoint = "string",
    CrossClusterSearch = list(
      SkipUnavailable = "ENABLED"|"DISABLED"
    )
  )
)