libZSservicesZSamazonka-docdbZSamazonka-docdb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DocumentDB.Types.Endpoint

Description

 
Synopsis

Documentation

data Endpoint Source #

Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

See: newEndpoint smart constructor.

Constructors

Endpoint' 

Fields

Instances

Instances details
Eq Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

Read Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

Show Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

Generic Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

Associated Types

type Rep Endpoint :: Type -> Type #

Methods

from :: Endpoint -> Rep Endpoint x #

to :: Rep Endpoint x -> Endpoint #

NFData Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

Methods

rnf :: Endpoint -> () #

Hashable Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

Methods

hashWithSalt :: Int -> Endpoint -> Int #

hash :: Endpoint -> Int #

FromXML Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

type Rep Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.DocumentDB.Types.Endpoint" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newEndpoint :: Endpoint Source #

Create a value of Endpoint 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:

$sel:hostedZoneId:Endpoint', endpoint_hostedZoneId - Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

$sel:address:Endpoint', endpoint_address - Specifies the DNS address of the instance.

$sel:port:Endpoint', endpoint_port - Specifies the port that the database engine is listening on.

endpoint_hostedZoneId :: Lens' Endpoint (Maybe Text) Source #

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

endpoint_address :: Lens' Endpoint (Maybe Text) Source #

Specifies the DNS address of the instance.

endpoint_port :: Lens' Endpoint (Maybe Int) Source #

Specifies the port that the database engine is listening on.