DBInstanceRole - Amazon Relational Database Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DBInstanceRole

Information about an Amazon Identity and Access Management (IAM) role that is associated with a DB instance.

Contents

Note

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

FeatureName

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

Type: String

Required: No

RoleArn

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

Type: String

Required: No

Status

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 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 services on your behalf.

Type: String

Required: No

See Also

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