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.Neptune.CreateDBClusterEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.

Synopsis

Creating a Request

data CreateDBClusterEndpoint Source #

See: newCreateDBClusterEndpoint smart constructor.

Constructors

CreateDBClusterEndpoint'

Fields

staticMembers :: Maybe [Text]
List of DB instance identifiers that are part of the custom endpoint group.
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.
tags :: Maybe [Tag]
The tags to be assigned to the Amazon Neptune resource.
dbClusterIdentifier :: Text
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
dbClusterEndpointIdentifier :: Text
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
endpointType :: Text
The type of the endpoint. One of: READER, WRITER, ANY.

Instances

Instances details

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

newCreateDBClusterEndpoint Source #

Arguments

:: Text	`$sel:dbClusterIdentifier:CreateDBClusterEndpoint'`
-> Text	`$sel:dbClusterEndpointIdentifier:CreateDBClusterEndpoint'`
-> Text	`$sel:endpointType:CreateDBClusterEndpoint'`
-> CreateDBClusterEndpoint

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

$sel:excludedMembers:CreateDBClusterEndpoint', createDBClusterEndpoint_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:tags:CreateDBClusterEndpoint', createDBClusterEndpoint_tags - The tags to be assigned to the Amazon Neptune resource.

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

$sel:dbClusterEndpointIdentifier:CreateDBClusterEndpoint', createDBClusterEndpoint_dbClusterEndpointIdentifier - The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

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

Request Lenses

createDBClusterEndpoint_staticMembers :: Lens' CreateDBClusterEndpoint (Maybe [Text]) Source #

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

createDBClusterEndpoint_excludedMembers :: Lens' CreateDBClusterEndpoint (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.

createDBClusterEndpoint_tags :: Lens' CreateDBClusterEndpoint (Maybe [Tag]) Source #

The tags to be assigned to the Amazon Neptune resource.

createDBClusterEndpoint_dbClusterIdentifier :: Lens' CreateDBClusterEndpoint Text Source #

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

createDBClusterEndpoint_dbClusterEndpointIdentifier :: Lens' CreateDBClusterEndpoint Text Source #

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

createDBClusterEndpoint_endpointType :: Lens' CreateDBClusterEndpoint Text Source #

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

Destructuring the Response

data CreateDBClusterEndpointResponse Source #

This data type represents the information you need to connect to an Amazon Neptune 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 Neptune DB instance endpoints, see Endpoint.

See: newCreateDBClusterEndpointResponse smart constructor.

Constructors

CreateDBClusterEndpointResponse'

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 cannot 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateDBClusterEndpointResponse Source #
Instance details Defined in Amazonka.Neptune.CreateDBClusterEndpoint Methods (==) :: CreateDBClusterEndpointResponse -> CreateDBClusterEndpointResponse -> Bool # (/=) :: CreateDBClusterEndpointResponse -> CreateDBClusterEndpointResponse -> Bool #
Read CreateDBClusterEndpointResponse Source #
Instance details Defined in Amazonka.Neptune.CreateDBClusterEndpoint Methods readsPrec :: Int -> ReadS CreateDBClusterEndpointResponse # readList :: ReadS [CreateDBClusterEndpointResponse] # readPrec :: ReadPrec CreateDBClusterEndpointResponse # readListPrec :: ReadPrec [CreateDBClusterEndpointResponse] #
Show CreateDBClusterEndpointResponse Source #
Instance details Defined in Amazonka.Neptune.CreateDBClusterEndpoint Methods showsPrec :: Int -> CreateDBClusterEndpointResponse -> ShowS # show :: CreateDBClusterEndpointResponse -> String # showList :: [CreateDBClusterEndpointResponse] -> ShowS #
Generic CreateDBClusterEndpointResponse Source #
Instance details Defined in Amazonka.Neptune.CreateDBClusterEndpoint Associated Types type Rep CreateDBClusterEndpointResponse :: Type -> Type # Methods from :: CreateDBClusterEndpointResponse -> Rep CreateDBClusterEndpointResponse x # to :: Rep CreateDBClusterEndpointResponse x -> CreateDBClusterEndpointResponse #
NFData CreateDBClusterEndpointResponse Source #
Instance details Defined in Amazonka.Neptune.CreateDBClusterEndpoint Methods rnf :: CreateDBClusterEndpointResponse -> () #
type Rep CreateDBClusterEndpointResponse Source #
Instance details Defined in Amazonka.Neptune.CreateDBClusterEndpoint type Rep CreateDBClusterEndpointResponse = D1 ('MetaData "CreateDBClusterEndpointResponse" "Amazonka.Neptune.CreateDBClusterEndpoint" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "CreateDBClusterEndpointResponse'" '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])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateDBClusterEndpointResponse Source #

Arguments

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

Create a value of CreateDBClusterEndpointResponse 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:CreateDBClusterEndpointResponse', createDBClusterEndpointResponse_status - The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot 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:CreateDBClusterEndpoint', createDBClusterEndpointResponse_dbClusterIdentifier - The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

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

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

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

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

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

$sel:endpoint:CreateDBClusterEndpointResponse', createDBClusterEndpointResponse_endpoint - The DNS address of the endpoint.

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

$sel:excludedMembers:CreateDBClusterEndpoint', createDBClusterEndpointResponse_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:httpStatus:CreateDBClusterEndpointResponse', createDBClusterEndpointResponse_httpStatus - The response's http status code.

Response Lenses

createDBClusterEndpointResponse_status :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_dbClusterIdentifier :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_dbClusterEndpointArn :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the endpoint.

createDBClusterEndpointResponse_customEndpointType :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_staticMembers :: Lens' CreateDBClusterEndpointResponse (Maybe [Text]) Source #

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

createDBClusterEndpointResponse_endpointType :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_dbClusterEndpointIdentifier :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_endpoint :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

The DNS address of the endpoint.

createDBClusterEndpointResponse_dbClusterEndpointResourceIdentifier :: Lens' CreateDBClusterEndpointResponse (Maybe Text) Source #

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

createDBClusterEndpointResponse_excludedMembers :: Lens' CreateDBClusterEndpointResponse (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.

createDBClusterEndpointResponse_httpStatus :: Lens' CreateDBClusterEndpointResponse Int Source #

The response's http status code.