Amazonka.RDS.Types.Endpoint

Documentation

data Endpoint

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

• CreateDBInstance

• DescribeDBInstances

• DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

See: newEndpoint smart constructor.

Constructors

Endpoint'

Fields

• address :: Maybe Text

  Specifies the DNS address of the DB instance.

• hostedZoneId :: Maybe Text

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

• port :: Maybe Int

  Specifies the port that the database engine is listening on.

Instances

FromXML Endpoint

Defined in Amazonka.RDS.Types.Endpoint

Methods

parseXML :: [Node] -> Either String Endpoint

Generic Endpoint

Defined in Amazonka.RDS.Types.Endpoint

Associated Types

type Rep Endpoint :: Type -> Type

Methods

from :: Endpoint -> Rep Endpoint x

to :: Rep Endpoint x -> Endpoint

Read Endpoint

Defined in Amazonka.RDS.Types.Endpoint

Methods

readsPrec :: Int -> ReadS Endpoint

readList :: ReadS [Endpoint]

readPrec :: ReadPrec Endpoint

readListPrec :: ReadPrec [Endpoint]

Show Endpoint

Defined in Amazonka.RDS.Types.Endpoint

Methods

showsPrec :: Int -> Endpoint -> ShowS

show :: Endpoint -> String

showList :: [Endpoint] -> ShowS

NFData Endpoint

Defined in Amazonka.RDS.Types.Endpoint

Methods

rnf :: Endpoint -> ()

Eq Endpoint

Defined in Amazonka.RDS.Types.Endpoint

Methods

(==) :: Endpoint -> Endpoint -> Bool

(/=) :: Endpoint -> Endpoint -> Bool

Hashable Endpoint

Defined in Amazonka.RDS.Types.Endpoint

Methods

hashWithSalt :: Int -> Endpoint -> Int

hash :: Endpoint -> Int

type Rep Endpoint

Defined in Amazonka.RDS.Types.Endpoint

type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.RDS.Types.Endpoint" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newEndpoint :: Endpoint

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:address:Endpoint', endpoint_address - Specifies the DNS address of the DB instance.

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

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

endpoint_address :: Lens' Endpoint (Maybe Text)

Specifies the DNS address of the DB instance.

endpoint_hostedZoneId :: Lens' Endpoint (Maybe Text)

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

endpoint_port :: Lens' Endpoint (Maybe Int)

Specifies the port that the database engine is listening on.