add-role-to-db-instance¶

Description¶

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

Note

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

This command doesn’t apply to RDS Custom.

Synopsis¶

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

Options¶

--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 information about supported feature names, see DBEngineVersion .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples¶

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.

Output¶

None

Table of Contents

Feedback

User Guide