Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . rds ]



Associates an AWS Identity and Access Management (IAM) role with a DB instance.


To add a role to a DB instance, the status of the DB instance must be available .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--db-instance-identifier <value>
--role-arn <value>
--feature-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--db-instance-identifier (string)

The name of the DB instance to associate the IAM role with.

--role-arn (string)

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole .

--feature-name (string)

The name of the feature for the DB instance that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To associate an AWS Identity and Access Management (IAM) role with a DB instance

The following add-role-to-db-instance example adds the role to an Oracle DB instance named test-instance.

aws rds add-role-to-db-instance \
    --db-instance-identifier test-instance \
    --feature-name S3_INTEGRATION \
    --role-arn arn:aws:iam::111122223333:role/rds-s3-integration-role

This command produces no output.

For more information, see Prerequisites for Amazon RDS Oracle Integration with Amazon S3 in the Amazon RDS User Guide.