OpsWorks / Client / describe_rds_db_instances

describe_rds_db_instances#

OpsWorks.Client.describe_rds_db_instances(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_rds_db_instances(
    StackId='string',
    RdsDbInstanceArns=[
        'string',
    ]
)
Parameters:

  • StackId (string) –

    [REQUIRED]

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

  • RdsDbInstanceArns (list) –

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

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RdsDbInstances': [
        {
            'RdsDbInstanceArn': 'string',
            'DbInstanceIdentifier': 'string',
            'DbUser': 'string',
            'DbPassword': 'string',
            'Region': 'string',
            'Address': 'string',
            'Engine': 'string',
            'StackId': 'string',
            'MissingOnRds': True|False
        },
    ]
}

Response Structure

  • (dict) –

    Contains the response to a DescribeRdsDbInstances request.

    • RdsDbInstances (list) –

      An a array of RdsDbInstance objects that describe the instances.

      • (dict) –

        Describes an Amazon RDS instance.

        • RdsDbInstanceArn (string) –

          The instance’s ARN.

        • DbInstanceIdentifier (string) –

          The DB instance identifier.

        • DbUser (string) –

          The master user name.

        • DbPassword (string) –

          AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

        • Region (string) –

          The instance’s AWS region.

        • Address (string) –

          The instance’s address.

        • Engine (string) –

          The instance’s database engine.

        • StackId (string) –

          The ID of the stack with which the instance is registered.

        • MissingOnRds (boolean) –

          Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS OpsWorks Stacks attempts to discover the instance only once. If this value is set to true, you must deregister the instance, and then register it again.

Exceptions