Skip to content

DBInstanceRole

Source code in docs_src/capo_rds/types/db_instance_role.py
class DBInstanceRole(TypedDict, closed=True):
    role_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.</p>"""
    feature_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see <code>DBEngineVersion</code>.</p>"""
    status: NotRequired["capo_rds.types.string.String"]
    """<p>Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.</p> </li> <li> <p> <code>PENDING</code> - the IAM role ARN is being associated with the DB instance.</p> </li> <li> <p> <code>INVALID</code> - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.</p> </li> </ul>"""

feature_name instance-attribute

feature_name: NotRequired[String]

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

role_arn instance-attribute

role_arn: NotRequired[String]

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

status instance-attribute

status: NotRequired[String]

Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.

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

  • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.