Skip to content

DBClusterRole

Source code in docs_src/capo_docdb/types/db_cluster_role.py
class DBClusterRole(TypedDict, closed=True):
    role_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.</p>"""
    status: NotRequired["capo_docdb.types.string.String"]
    """<p>Describes the state of association between the IAMrole and the cluster. The <code>Status</code> property returns one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.</p> </li> <li> <p> <code>PENDING</code> - The IAMrole ARN is being associated with the cluster.</p> </li> <li> <p> <code>INVALID</code> - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.</p> </li> </ul>"""

role_arn instance-attribute

role_arn: NotRequired[String]

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

status instance-attribute

status: NotRequired[String]

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

  • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

  • PENDING - The IAMrole ARN is being associated with the cluster.

  • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.