Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RDS.ModifyDBClusterEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

Synopsis

data ModifyDBClusterEndpoint = ModifyDBClusterEndpoint' {
- staticMembers :: Maybe [Text]
- endpointType :: Maybe Text
- excludedMembers :: Maybe [Text]
- dbClusterEndpointIdentifier :: Text
}
newModifyDBClusterEndpoint :: Text -> ModifyDBClusterEndpoint
modifyDBClusterEndpoint_staticMembers :: Lens' ModifyDBClusterEndpoint (Maybe [Text])
modifyDBClusterEndpoint_endpointType :: Lens' ModifyDBClusterEndpoint (Maybe Text)
modifyDBClusterEndpoint_excludedMembers :: Lens' ModifyDBClusterEndpoint (Maybe [Text])
modifyDBClusterEndpoint_dbClusterEndpointIdentifier :: Lens' ModifyDBClusterEndpoint Text
data DBClusterEndpoint = DBClusterEndpoint' {
- status :: Maybe Text
- dbClusterIdentifier :: Maybe Text
- dbClusterEndpointArn :: Maybe Text
- customEndpointType :: Maybe Text
- staticMembers :: Maybe [Text]
- endpointType :: Maybe Text
- dbClusterEndpointIdentifier :: Maybe Text
- endpoint :: Maybe Text
- dbClusterEndpointResourceIdentifier :: Maybe Text
- excludedMembers :: Maybe [Text]
}
newDBClusterEndpoint :: DBClusterEndpoint
dbClusterEndpoint_status :: Lens' DBClusterEndpoint (Maybe Text)
dbClusterEndpoint_dbClusterIdentifier :: Lens' DBClusterEndpoint (Maybe Text)
dbClusterEndpoint_dbClusterEndpointArn :: Lens' DBClusterEndpoint (Maybe Text)
dbClusterEndpoint_customEndpointType :: Lens' DBClusterEndpoint (Maybe Text)
dbClusterEndpoint_staticMembers :: Lens' DBClusterEndpoint (Maybe [Text])
dbClusterEndpoint_endpointType :: Lens' DBClusterEndpoint (Maybe Text)
dbClusterEndpoint_dbClusterEndpointIdentifier :: Lens' DBClusterEndpoint (Maybe Text)
dbClusterEndpoint_endpoint :: Lens' DBClusterEndpoint (Maybe Text)
dbClusterEndpoint_dbClusterEndpointResourceIdentifier :: Lens' DBClusterEndpoint (Maybe Text)
dbClusterEndpoint_excludedMembers :: Lens' DBClusterEndpoint (Maybe [Text])

Creating a Request

data ModifyDBClusterEndpoint Source #

See: newModifyDBClusterEndpoint smart constructor.

Constructors

ModifyDBClusterEndpoint'

Fields

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, ANY.
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.
dbClusterEndpointIdentifier :: Text
The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

Instances

Instances details

Eq ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint Methods (==) :: ModifyDBClusterEndpoint -> ModifyDBClusterEndpoint -> Bool # (/=) :: ModifyDBClusterEndpoint -> ModifyDBClusterEndpoint -> Bool #
Read ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint Methods readsPrec :: Int -> ReadS ModifyDBClusterEndpoint # readList :: ReadS [ModifyDBClusterEndpoint] # readPrec :: ReadPrec ModifyDBClusterEndpoint # readListPrec :: ReadPrec [ModifyDBClusterEndpoint] #
Show ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint Methods showsPrec :: Int -> ModifyDBClusterEndpoint -> ShowS # show :: ModifyDBClusterEndpoint -> String # showList :: [ModifyDBClusterEndpoint] -> ShowS #
Generic ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint Associated Types type Rep ModifyDBClusterEndpoint :: Type -> Type # Methods from :: ModifyDBClusterEndpoint -> Rep ModifyDBClusterEndpoint x # to :: Rep ModifyDBClusterEndpoint x -> ModifyDBClusterEndpoint #
NFData ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint Methods rnf :: ModifyDBClusterEndpoint -> () #
Hashable ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint Methods hashWithSalt :: Int -> ModifyDBClusterEndpoint -> Int # hash :: ModifyDBClusterEndpoint -> Int #
AWSRequest ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint Associated Types type AWSResponse ModifyDBClusterEndpoint # Methods request :: ModifyDBClusterEndpoint -> Request ModifyDBClusterEndpoint # response :: MonadResource m => Logger -> Service -> Proxy ModifyDBClusterEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyDBClusterEndpoint))) #
ToHeaders ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint Methods toHeaders :: ModifyDBClusterEndpoint -> [Header] #
ToPath ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint Methods toPath :: ModifyDBClusterEndpoint -> ByteString #
ToQuery ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint Methods toQuery :: ModifyDBClusterEndpoint -> QueryString #
type Rep ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint type Rep ModifyDBClusterEndpoint = D1 ('MetaData "ModifyDBClusterEndpoint" "Amazonka.RDS.ModifyDBClusterEndpoint" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "ModifyDBClusterEndpoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "staticMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "excludedMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "dbClusterEndpointIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ModifyDBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.ModifyDBClusterEndpoint type AWSResponse ModifyDBClusterEndpoint = DBClusterEndpoint

newModifyDBClusterEndpoint Source #

Arguments

:: Text	`$sel:dbClusterEndpointIdentifier:ModifyDBClusterEndpoint'`
-> ModifyDBClusterEndpoint

Create a value of ModifyDBClusterEndpoint 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:staticMembers:ModifyDBClusterEndpoint', modifyDBClusterEndpoint_staticMembers - List of DB instance identifiers that are part of the custom endpoint group.

$sel:endpointType:ModifyDBClusterEndpoint', modifyDBClusterEndpoint_endpointType - The type of the endpoint. One of: READER, WRITER, ANY.

$sel:excludedMembers:ModifyDBClusterEndpoint', modifyDBClusterEndpoint_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.

$sel:dbClusterEndpointIdentifier:ModifyDBClusterEndpoint', modifyDBClusterEndpoint_dbClusterEndpointIdentifier - The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

Request Lenses

modifyDBClusterEndpoint_staticMembers :: Lens' ModifyDBClusterEndpoint (Maybe [Text]) Source #

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

modifyDBClusterEndpoint_endpointType :: Lens' ModifyDBClusterEndpoint (Maybe Text) Source #

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

modifyDBClusterEndpoint_excludedMembers :: Lens' ModifyDBClusterEndpoint (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.

modifyDBClusterEndpoint_dbClusterEndpointIdentifier :: Lens' ModifyDBClusterEndpoint Text Source #

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

Destructuring the Response

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 Methods (==) :: DBClusterEndpoint -> DBClusterEndpoint -> Bool # (/=) :: DBClusterEndpoint -> DBClusterEndpoint -> Bool #
Read DBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterEndpoint Methods readsPrec :: Int -> ReadS DBClusterEndpoint # readList :: ReadS [DBClusterEndpoint] # readPrec :: ReadPrec DBClusterEndpoint # readListPrec :: ReadPrec [DBClusterEndpoint] #
Show DBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterEndpoint Methods showsPrec :: Int -> DBClusterEndpoint -> ShowS # show :: DBClusterEndpoint -> String # showList :: [DBClusterEndpoint] -> ShowS #
Generic DBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterEndpoint Associated Types type Rep DBClusterEndpoint :: Type -> Type # Methods from :: DBClusterEndpoint -> Rep DBClusterEndpoint x # to :: Rep DBClusterEndpoint x -> DBClusterEndpoint #
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 Methods hashWithSalt :: Int -> DBClusterEndpoint -> Int # hash :: DBClusterEndpoint -> Int #
FromXML DBClusterEndpoint Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterEndpoint Methods parseXML :: [Node] -> Either String 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.

Response Lenses

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.