libZSservicesZSamazonka-rdsZSamazonka-rds
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.RDS.Types.DBClusterEndpoint

Description

 
Synopsis

Documentation

data DBClusterEndpoint Source #

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

  • CreateDBClusterEndpoint
  • DescribeDBClusterEndpoints
  • ModifyDBClusterEndpoint
  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

See: newDBClusterEndpoint smart constructor.

Constructors

DBClusterEndpoint' 

Fields

  • status :: Maybe Text

    The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

  • dbClusterIdentifier :: Maybe Text

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

  • dbClusterEndpointArn :: Maybe Text

    The Amazon Resource Name (ARN) for the endpoint.

  • customEndpointType :: Maybe Text

    The type associated with a custom endpoint. One of: READER, WRITER, ANY.

  • staticMembers :: Maybe [Text]

    List of DB instance identifiers that are part of the custom endpoint group.

  • endpointType :: Maybe Text

    The type of the endpoint. One of: READER, WRITER, CUSTOM.

  • dbClusterEndpointIdentifier :: Maybe Text

    The identifier associated with the endpoint. This parameter is stored as a lowercase string.

  • endpoint :: Maybe Text

    The DNS address of the endpoint.

  • dbClusterEndpointResourceIdentifier :: Maybe Text

    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

  • excludedMembers :: Maybe [Text]

    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

Instances

Instances details
Eq DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

Read DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

Show DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

Generic DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

Associated Types

type Rep DBClusterEndpoint :: Type -> Type #

NFData DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

Methods

rnf :: DBClusterEndpoint -> () #

Hashable DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

FromXML DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

type Rep DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

type Rep DBClusterEndpoint = D1 ('MetaData "DBClusterEndpoint" "Amazonka.RDS.Types.DBClusterEndpoint" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DBClusterEndpoint'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbClusterEndpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "customEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "staticMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterEndpointIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbClusterEndpointResourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "excludedMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newDBClusterEndpoint :: DBClusterEndpoint Source #

Create a value of DBClusterEndpoint 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:status:DBClusterEndpoint', dbClusterEndpoint_status - The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

$sel:dbClusterIdentifier:DBClusterEndpoint', dbClusterEndpoint_dbClusterIdentifier - The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

$sel:dbClusterEndpointArn:DBClusterEndpoint', dbClusterEndpoint_dbClusterEndpointArn - The Amazon Resource Name (ARN) for the endpoint.

$sel:customEndpointType:DBClusterEndpoint', dbClusterEndpoint_customEndpointType - The type associated with a custom endpoint. One of: READER, WRITER, ANY.

$sel:staticMembers:DBClusterEndpoint', dbClusterEndpoint_staticMembers - List of DB instance identifiers that are part of the custom endpoint group.

$sel:endpointType:DBClusterEndpoint', dbClusterEndpoint_endpointType - The type of the endpoint. One of: READER, WRITER, CUSTOM.

$sel:dbClusterEndpointIdentifier:DBClusterEndpoint', dbClusterEndpoint_dbClusterEndpointIdentifier - The identifier associated with the endpoint. This parameter is stored as a lowercase string.

$sel:endpoint:DBClusterEndpoint', dbClusterEndpoint_endpoint - The DNS address of the endpoint.

$sel:dbClusterEndpointResourceIdentifier:DBClusterEndpoint', dbClusterEndpoint_dbClusterEndpointResourceIdentifier - A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

$sel:excludedMembers:DBClusterEndpoint', dbClusterEndpoint_excludedMembers - List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

dbClusterEndpoint_status :: Lens' DBClusterEndpoint (Maybe Text) Source #

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

dbClusterEndpoint_dbClusterIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_dbClusterEndpointArn :: Lens' DBClusterEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the endpoint.

dbClusterEndpoint_customEndpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

dbClusterEndpoint_staticMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that are part of the custom endpoint group.

dbClusterEndpoint_endpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type of the endpoint. One of: READER, WRITER, CUSTOM.

dbClusterEndpoint_dbClusterEndpointIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_endpoint :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DNS address of the endpoint.

dbClusterEndpoint_dbClusterEndpointResourceIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

dbClusterEndpoint_excludedMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.