Delete Outbound Connection

opensearchservice_delete_outbound_connection

R Documentation

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection

Description

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Usage

opensearchservice_delete_outbound_connection(ConnectionId)

Arguments

ConnectionId

[required] The ID of the outbound connection you want to permanently delete.

Value

A list with the following syntax:

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

Request syntax

svc$delete_outbound_connection(
  ConnectionId = "string"
)