AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Associates an Amazon Web Services 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.

This command doesn't apply to RDS Custom.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginAddRoleToDBInstance and EndAddRoleToDBInstance.

Namespace: Amazon.RDS
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<AddRoleToDBInstanceResponse> AddRoleToDBInstanceAsync(
         AddRoleToDBInstanceRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.RDS.Model.AddRoleToDBInstanceRequest

Container for the necessary parameters to execute the AddRoleToDBInstance service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the AddRoleToDBInstance service method, as returned by RDS.

Exceptions

ExceptionCondition
DBInstanceNotFoundException DBInstanceIdentifier doesn't refer to an existing DB instance.
DBInstanceRoleAlreadyExistsException The specified RoleArn or FeatureName value is already associated with the DB instance.
DBInstanceRoleQuotaExceededException You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.
InvalidDBInstanceStateException The DB instance isn't in a valid state.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also