Skip to content

Describe Rds Db Instances

opsworks_describe_rds_db_instances R Documentation

Describes Amazon RDS instances

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.

Usage

opsworks_describe_rds_db_instances(StackId, RdsDbInstanceArns)

Arguments

StackId

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

RdsDbInstanceArns

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

Value

A list with the following syntax:

list(
  RdsDbInstances = list(
    list(
      RdsDbInstanceArn = "string",
      DbInstanceIdentifier = "string",
      DbUser = "string",
      DbPassword = "string",
      Region = "string",
      Address = "string",
      Engine = "string",
      StackId = "string",
      MissingOnRds = TRUE|FALSE
    )
  )
)

Request syntax

svc$describe_rds_db_instances(
  StackId = "string",
  RdsDbInstanceArns = list(
    "string"
  )
)