Amazon DocumentDB
Developer Guide

DBClusterRole

Describes an AWS Identity and Access Management (IAM) role that is associated with a cluster.

Contents

Note

In the following list, the required parameters are described first.

RoleArn

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

Type: String

Required: No

Status

Describes the state of association between the IAM role and the cluster. The Status property returns one of the following values:

  • ACTIVE - The IAM role ARN is associated with the cluster and can be used to access other AWS services on your behalf.

  • PENDING - The IAM role ARN is being associated with the DB cluster.

  • INVALID - The IAM role ARN is associated with the cluster, but the cluster cannot assume the IAM role to access other AWS services on your behalf.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: