Class AddRoleToInstanceProfileCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { IAMClient, AddRoleToInstanceProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, AddRoleToInstanceProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // AddRoleToInstanceProfileRequest
  InstanceProfileName: "STRING_VALUE", // required
  RoleName: "STRING_VALUE", // required
};
const command = new AddRoleToInstanceProfileCommand(input);
const response = await client.send(command);
// {};

Param

AddRoleToInstanceProfileCommandInput

Returns

AddRoleToInstanceProfileCommandOutput

See

• AddRoleToInstanceProfileCommandInput for command's input shape.
• AddRoleToInstanceProfileCommandOutput for command's response shape.
• config for IAMClient's config shape.

Throws

EntityAlreadyExistsException (client fault)

The request was rejected because it attempted to create a resource that already exists.

Throws

LimitExceededException (client fault)

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.

Throws

NoSuchEntityException (client fault)

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

Throws

ServiceFailureException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

UnmodifiableEntityException (client fault)

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.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.

Example

To add a role to an instance profile

// The following command adds the role named S3Access to the instance profile named Webserver:
const input = {
  "InstanceProfileName": "Webserver",
  "RoleName": "S3Access"
};
const command = new AddRoleToInstanceProfileCommand(input);
await client.send(command);
// example id: c107fac3-edb6-4827-8a71-8863ec91c81f