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.

Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.

The caller of this operation must be granted the PassRole permission on the IAM role by a permissions policy.

For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

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 BeginAddRoleToInstanceProfile and EndAddRoleToInstanceProfile.

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

Syntax

C#
public virtual Task<AddRoleToInstanceProfileResponse> AddRoleToInstanceProfileAsync(
         AddRoleToInstanceProfileRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest

Container for the necessary parameters to execute the AddRoleToInstanceProfile 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 AddRoleToInstanceProfile service method, as returned by IdentityManagementService.

Exceptions

ExceptionCondition
EntityAlreadyExistsException The request was rejected because it attempted to create a resource that already exists.
LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
NoSuchEntityException The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
ServiceFailureException The request processing has failed because of an unknown error, exception or failure.
UnmodifiableEntityException The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also