libZSservicesZSamazonka-opsworksZSamazonka-opsworks
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.OpsWorks.DescribeRdsDbInstances

Description

Describes Amazon RDS instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Synopsis

Creating a Request

data DescribeRdsDbInstances Source #

See: newDescribeRdsDbInstances smart constructor.

Constructors

DescribeRdsDbInstances' 

Fields

  • rdsDbInstanceArns :: Maybe [Text]

    An array containing the ARNs of the instances to be described.

  • stackId :: Text

    The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

Instances

Instances details
Eq DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Read DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Show DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Generic DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Associated Types

type Rep DescribeRdsDbInstances :: Type -> Type #

NFData DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Methods

rnf :: DescribeRdsDbInstances -> () #

Hashable DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

ToJSON DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

AWSRequest DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Associated Types

type AWSResponse DescribeRdsDbInstances #

ToHeaders DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

ToPath DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

ToQuery DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

type Rep DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

type Rep DescribeRdsDbInstances = D1 ('MetaData "DescribeRdsDbInstances" "Amazonka.OpsWorks.DescribeRdsDbInstances" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "DescribeRdsDbInstances'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rdsDbInstanceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeRdsDbInstances Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

newDescribeRdsDbInstances Source #

Create a value of DescribeRdsDbInstances 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:rdsDbInstanceArns:DescribeRdsDbInstances', describeRdsDbInstances_rdsDbInstanceArns - An array containing the ARNs of the instances to be described.

$sel:stackId:DescribeRdsDbInstances', describeRdsDbInstances_stackId - The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

Request Lenses

describeRdsDbInstances_rdsDbInstanceArns :: Lens' DescribeRdsDbInstances (Maybe [Text]) Source #

An array containing the ARNs of the instances to be described.

describeRdsDbInstances_stackId :: Lens' DescribeRdsDbInstances Text Source #

The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

Destructuring the Response

data DescribeRdsDbInstancesResponse Source #

Contains the response to a DescribeRdsDbInstances request.

See: newDescribeRdsDbInstancesResponse smart constructor.

Constructors

DescribeRdsDbInstancesResponse' 

Fields

Instances

Instances details
Eq DescribeRdsDbInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Read DescribeRdsDbInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Show DescribeRdsDbInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Generic DescribeRdsDbInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

Associated Types

type Rep DescribeRdsDbInstancesResponse :: Type -> Type #

NFData DescribeRdsDbInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

type Rep DescribeRdsDbInstancesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeRdsDbInstances

type Rep DescribeRdsDbInstancesResponse = D1 ('MetaData "DescribeRdsDbInstancesResponse" "Amazonka.OpsWorks.DescribeRdsDbInstances" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "DescribeRdsDbInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rdsDbInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RdsDbInstance])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeRdsDbInstancesResponse Source #

Create a value of DescribeRdsDbInstancesResponse 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:rdsDbInstances:DescribeRdsDbInstancesResponse', describeRdsDbInstancesResponse_rdsDbInstances - An a array of RdsDbInstance objects that describe the instances.

$sel:httpStatus:DescribeRdsDbInstancesResponse', describeRdsDbInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeRdsDbInstancesResponse_rdsDbInstances :: Lens' DescribeRdsDbInstancesResponse (Maybe [RdsDbInstance]) Source #

An a array of RdsDbInstance objects that describe the instances.