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.Types.DBProxyTarget

Description

Documentation

data DBProxyTarget Source #

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

This data type is used as a response element in the DescribeDBProxyTargets action.

See: newDBProxyTarget smart constructor.

Constructors

DBProxyTarget'

Fields

targetArn :: Maybe Text
The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
targetHealth :: Maybe TargetHealth
Information about the connection health of the RDS Proxy target.
trackedClusterId :: Maybe Text
The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
role' :: Maybe TargetRole
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
rdsResourceId :: Maybe Text
The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
type' :: Maybe TargetType
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
endpoint :: Maybe Text
The writer endpoint for the RDS DB instance or Aurora DB cluster.
port :: Maybe Int
The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

Instances

Instances details

Eq DBProxyTarget Source #
Instance details Defined in Amazonka.RDS.Types.DBProxyTarget Methods (==) :: DBProxyTarget -> DBProxyTarget -> Bool # (/=) :: DBProxyTarget -> DBProxyTarget -> Bool #
Read DBProxyTarget Source #
Instance details Defined in Amazonka.RDS.Types.DBProxyTarget Methods readsPrec :: Int -> ReadS DBProxyTarget # readList :: ReadS [DBProxyTarget] # readPrec :: ReadPrec DBProxyTarget # readListPrec :: ReadPrec [DBProxyTarget] #
Show DBProxyTarget Source #
Instance details Defined in Amazonka.RDS.Types.DBProxyTarget Methods showsPrec :: Int -> DBProxyTarget -> ShowS # show :: DBProxyTarget -> String # showList :: [DBProxyTarget] -> ShowS #
Generic DBProxyTarget Source #
Instance details Defined in Amazonka.RDS.Types.DBProxyTarget Associated Types type Rep DBProxyTarget :: Type -> Type # Methods from :: DBProxyTarget -> Rep DBProxyTarget x # to :: Rep DBProxyTarget x -> DBProxyTarget #
NFData DBProxyTarget Source #
Instance details Defined in Amazonka.RDS.Types.DBProxyTarget Methods rnf :: DBProxyTarget -> () #
Hashable DBProxyTarget Source #
Instance details Defined in Amazonka.RDS.Types.DBProxyTarget Methods hashWithSalt :: Int -> DBProxyTarget -> Int # hash :: DBProxyTarget -> Int #
FromXML DBProxyTarget Source #
Instance details Defined in Amazonka.RDS.Types.DBProxyTarget Methods parseXML :: [Node] -> Either String DBProxyTarget #
type Rep DBProxyTarget Source #
Instance details Defined in Amazonka.RDS.Types.DBProxyTarget type Rep DBProxyTarget = D1 ('MetaData "DBProxyTarget" "Amazonka.RDS.Types.DBProxyTarget" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DBProxyTarget'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "targetHealth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetHealth))) :: (S1 ('MetaSel ('Just "trackedClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetRole)))) :: ((S1 ('MetaSel ('Just "rdsResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetType))) :: (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newDBProxyTarget :: DBProxyTarget Source #

Create a value of DBProxyTarget 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:targetArn:DBProxyTarget', dbProxyTarget_targetArn - The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

$sel:targetHealth:DBProxyTarget', dbProxyTarget_targetHealth - Information about the connection health of the RDS Proxy target.

$sel:trackedClusterId:DBProxyTarget', dbProxyTarget_trackedClusterId - The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

$sel:role':DBProxyTarget', dbProxyTarget_role - A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

$sel:rdsResourceId:DBProxyTarget', dbProxyTarget_rdsResourceId - The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

$sel:type':DBProxyTarget', dbProxyTarget_type - Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

$sel:endpoint:DBProxyTarget', dbProxyTarget_endpoint - The writer endpoint for the RDS DB instance or Aurora DB cluster.

$sel:port:DBProxyTarget', dbProxyTarget_port - The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

dbProxyTarget_targetArn :: Lens' DBProxyTarget (Maybe Text) Source #

The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

dbProxyTarget_targetHealth :: Lens' DBProxyTarget (Maybe TargetHealth) Source #

Information about the connection health of the RDS Proxy target.

dbProxyTarget_trackedClusterId :: Lens' DBProxyTarget (Maybe Text) Source #

The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

dbProxyTarget_role :: Lens' DBProxyTarget (Maybe TargetRole) Source #

A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

dbProxyTarget_rdsResourceId :: Lens' DBProxyTarget (Maybe Text) Source #

The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

dbProxyTarget_type :: Lens' DBProxyTarget (Maybe TargetType) Source #

Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

dbProxyTarget_endpoint :: Lens' DBProxyTarget (Maybe Text) Source #

The writer endpoint for the RDS DB instance or Aurora DB cluster.

dbProxyTarget_port :: Lens' DBProxyTarget (Maybe Int) Source #

The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.