AWS::RDS::DBInstance DBInstanceRole - Amazon CloudFormation
SyntaxPropertiesExamples
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).

AWS::RDS::DBInstance DBInstanceRole

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "FeatureName" : String,
  "RoleArn" : String
}

YAML

  FeatureName: String
  RoleArn: String

Properties

FeatureName

The name of the feature associated with the Amazon Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other Amazon services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.

Required: Yes

Type: String

Update requires: No interruption

RoleArn

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

Required: Yes

Type: String

Update requires: No interruption

Examples

The following specifies a role to associate with a DB instance.

JSON

"AssociatedRoles": [
    {
        "FeatureName": "s3Import",
        "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3"               
    }
]

YAML

AssociatedRoles:
    - FeatureName: s3Import
      RoleArn: 'arn:aws:iam::123456789012:role/RDSLoadFromS3'