Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpenSearch.CreateOutboundConnection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

Creating a Request

data CreateOutboundConnection Source #

Container for the parameters to the CreateOutboundConnection operation.

See: newCreateOutboundConnection smart constructor.

Constructors

CreateOutboundConnection'
Fields localDomainInfo :: DomainInformationContainer Name and Region of the source (local) domain. remoteDomainInfo :: DomainInformationContainer Name and Region of the destination (remote) domain. connectionAlias :: Text Name of the connection.

Instances

Instances details

ToJSON CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods toJSON :: CreateOutboundConnection -> Value # toEncoding :: CreateOutboundConnection -> Encoding # toJSONList :: [CreateOutboundConnection] -> Value # toEncodingList :: [CreateOutboundConnection] -> Encoding #
ToHeaders CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods toHeaders :: CreateOutboundConnection -> [Header] #
ToPath CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods toPath :: CreateOutboundConnection -> ByteString #
ToQuery CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods toQuery :: CreateOutboundConnection -> QueryString #
AWSRequest CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Associated Types type AWSResponse CreateOutboundConnection # Methods request :: (Service -> Service) -> CreateOutboundConnection -> Request CreateOutboundConnection # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateOutboundConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateOutboundConnection))) #
Generic CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Associated Types type Rep CreateOutboundConnection :: Type -> Type # Methods from :: CreateOutboundConnection -> Rep CreateOutboundConnection x # to :: Rep CreateOutboundConnection x -> CreateOutboundConnection #
Read CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods readsPrec :: Int -> ReadS CreateOutboundConnection # readList :: ReadS [CreateOutboundConnection] # readPrec :: ReadPrec CreateOutboundConnection # readListPrec :: ReadPrec [CreateOutboundConnection] #
Show CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods showsPrec :: Int -> CreateOutboundConnection -> ShowS # show :: CreateOutboundConnection -> String # showList :: [CreateOutboundConnection] -> ShowS #
NFData CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods rnf :: CreateOutboundConnection -> () #
Eq CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods (==) :: CreateOutboundConnection -> CreateOutboundConnection -> Bool # (/=) :: CreateOutboundConnection -> CreateOutboundConnection -> Bool #
Hashable CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods hashWithSalt :: Int -> CreateOutboundConnection -> Int # hash :: CreateOutboundConnection -> Int #
type AWSResponse CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection type AWSResponse CreateOutboundConnection = CreateOutboundConnectionResponse
type Rep CreateOutboundConnection Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection type Rep CreateOutboundConnection = D1 ('MetaData "CreateOutboundConnection" "Amazonka.OpenSearch.CreateOutboundConnection" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "CreateOutboundConnection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "localDomainInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DomainInformationContainer) :: (S1 ('MetaSel ('Just "remoteDomainInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DomainInformationContainer) :: S1 ('MetaSel ('Just "connectionAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateOutboundConnection Source #

Arguments

:: DomainInformationContainer	`CreateOutboundConnection`
-> DomainInformationContainer	`CreateOutboundConnection`
-> Text	`CreateOutboundConnection`
-> CreateOutboundConnection

Create a value of CreateOutboundConnection with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateOutboundConnection, createOutboundConnection_localDomainInfo - Name and Region of the source (local) domain.

CreateOutboundConnection, createOutboundConnection_remoteDomainInfo - Name and Region of the destination (remote) domain.

CreateOutboundConnection, createOutboundConnection_connectionAlias - Name of the connection.

Request Lenses

createOutboundConnection_localDomainInfo :: Lens' CreateOutboundConnection DomainInformationContainer Source #

Name and Region of the source (local) domain.

createOutboundConnection_remoteDomainInfo :: Lens' CreateOutboundConnection DomainInformationContainer Source #

Name and Region of the destination (remote) domain.

createOutboundConnection_connectionAlias :: Lens' CreateOutboundConnection Text Source #

Name of the connection.

Destructuring the Response

data CreateOutboundConnectionResponse Source #

The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.

See: newCreateOutboundConnectionResponse smart constructor.

Constructors

CreateOutboundConnectionResponse'

Fields

connectionAlias :: Maybe Text
Name of the connection.
connectionId :: Maybe Text
The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.
connectionStatus :: Maybe OutboundConnectionStatus
The status of the connection.
localDomainInfo :: Maybe DomainInformationContainer
Information about the source (local) domain.
remoteDomainInfo :: Maybe DomainInformationContainer
Information about the destination (remote) domain.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateOutboundConnectionResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Associated Types type Rep CreateOutboundConnectionResponse :: Type -> Type # Methods from :: CreateOutboundConnectionResponse -> Rep CreateOutboundConnectionResponse x # to :: Rep CreateOutboundConnectionResponse x -> CreateOutboundConnectionResponse #
Read CreateOutboundConnectionResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods readsPrec :: Int -> ReadS CreateOutboundConnectionResponse # readList :: ReadS [CreateOutboundConnectionResponse] # readPrec :: ReadPrec CreateOutboundConnectionResponse # readListPrec :: ReadPrec [CreateOutboundConnectionResponse] #
Show CreateOutboundConnectionResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods showsPrec :: Int -> CreateOutboundConnectionResponse -> ShowS # show :: CreateOutboundConnectionResponse -> String # showList :: [CreateOutboundConnectionResponse] -> ShowS #
NFData CreateOutboundConnectionResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods rnf :: CreateOutboundConnectionResponse -> () #
Eq CreateOutboundConnectionResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection Methods (==) :: CreateOutboundConnectionResponse -> CreateOutboundConnectionResponse -> Bool # (/=) :: CreateOutboundConnectionResponse -> CreateOutboundConnectionResponse -> Bool #
type Rep CreateOutboundConnectionResponse Source #
Instance details Defined in Amazonka.OpenSearch.CreateOutboundConnection type Rep CreateOutboundConnectionResponse = D1 ('MetaData "CreateOutboundConnectionResponse" "Amazonka.OpenSearch.CreateOutboundConnection" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "CreateOutboundConnectionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectionAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutboundConnectionStatus)))) :: (S1 ('MetaSel ('Just "localDomainInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainInformationContainer)) :: (S1 ('MetaSel ('Just "remoteDomainInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainInformationContainer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateOutboundConnectionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateOutboundConnectionResponse'`
-> CreateOutboundConnectionResponse

Create a value of CreateOutboundConnectionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateOutboundConnection, createOutboundConnectionResponse_connectionAlias - Name of the connection.

CreateOutboundConnectionResponse, createOutboundConnectionResponse_connectionId - The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.

CreateOutboundConnectionResponse, createOutboundConnectionResponse_connectionStatus - The status of the connection.

CreateOutboundConnection, createOutboundConnectionResponse_localDomainInfo - Information about the source (local) domain.

CreateOutboundConnection, createOutboundConnectionResponse_remoteDomainInfo - Information about the destination (remote) domain.

$sel:httpStatus:CreateOutboundConnectionResponse', createOutboundConnectionResponse_httpStatus - The response's http status code.

Response Lenses

createOutboundConnectionResponse_connectionAlias :: Lens' CreateOutboundConnectionResponse (Maybe Text) Source #

Name of the connection.

createOutboundConnectionResponse_connectionId :: Lens' CreateOutboundConnectionResponse (Maybe Text) Source #

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

createOutboundConnectionResponse_connectionStatus :: Lens' CreateOutboundConnectionResponse (Maybe OutboundConnectionStatus) Source #

The status of the connection.

createOutboundConnectionResponse_localDomainInfo :: Lens' CreateOutboundConnectionResponse (Maybe DomainInformationContainer) Source #

Information about the source (local) domain.

createOutboundConnectionResponse_remoteDomainInfo :: Lens' CreateOutboundConnectionResponse (Maybe DomainInformationContainer) Source #

Information about the destination (remote) domain.

createOutboundConnectionResponse_httpStatus :: Lens' CreateOutboundConnectionResponse Int Source #

The response's http status code.