[ aws . opensearch ]

create-outbound-connection

Description

Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-outbound-connection
--local-domain-info <value>
--remote-domain-info <value>
--connection-alias <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--local-domain-info (structure)

The `` AWSDomainInformation `` for the local OpenSearch domain.

AWSDomainInformation -> (structure)

OwnerId -> (string)

DomainName -> (string)

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Region -> (string)

Shorthand Syntax:

AWSDomainInformation={OwnerId=string,DomainName=string,Region=string}

JSON Syntax:

{
  "AWSDomainInformation": {
    "OwnerId": "string",
    "DomainName": "string",
    "Region": "string"
  }
}

--remote-domain-info (structure)

The `` AWSDomainInformation `` for the remote OpenSearch domain.

AWSDomainInformation -> (structure)

OwnerId -> (string)

DomainName -> (string)

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Region -> (string)

Shorthand Syntax:

AWSDomainInformation={OwnerId=string,DomainName=string,Region=string}

JSON Syntax:

{
  "AWSDomainInformation": {
    "OwnerId": "string",
    "DomainName": "string",
    "Region": "string"
  }
}

--connection-alias (string)

The connection alias used used by the customer for this cross-cluster connection.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

LocalDomainInfo -> (structure)

The `` AWSDomainInformation `` for the local OpenSearch domain.

AWSDomainInformation -> (structure)

OwnerId -> (string)

DomainName -> (string)

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Region -> (string)

RemoteDomainInfo -> (structure)

The `` AWSDomainInformation `` for the remote OpenSearch domain.

AWSDomainInformation -> (structure)

OwnerId -> (string)

DomainName -> (string)

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Region -> (string)

ConnectionAlias -> (string)

The connection alias provided during the create connection request.

ConnectionStatus -> (structure)

The `` OutboundConnectionStatus `` for the newly created connection.

StatusCode -> (string)

The state code for the outbound connection. Can be one of the following:

• VALIDATING: The outbound connection request is being validated.

• VALIDATION_FAILED: Validation failed for the connection request.

• PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.

• APPROVED: Outbound connection has been approved by the remote domain owner for getting provisioned.

• PROVISIONING: Outbound connection request is in process.

• ACTIVE: Outbound connection is active and ready to use.

• REJECTING: Outbound connection rejection by remote domain owner is in progress.

• REJECTED: Outbound connection request is rejected by remote domain owner.

• DELETING: Outbound connection deletion is in progress.

• DELETED: Outbound connection is deleted and can no longer be used.

Message -> (string)

Verbose information for the outbound connection status.

ConnectionId -> (string)

The unique ID for the created outbound connection, which is used for subsequent operations on the connection.