opsworks_describe_rds_db_instances: Describes Amazon RDS instances

Description Usage Arguments Value Request syntax

View source: R/opsworks_operations.R

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

1
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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
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

1
2
3
4
5
6
svc$describe_rds_db_instances(
  StackId = "string",
  RdsDbInstanceArns = list(
    "string"
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.