add_role_to_instance_profile¶
Operation¶
add_role_to_instance_profile
async
¶
add_role_to_instance_profile(request: AddRoleToInstanceProfileInput | AddRoleToInstanceProfileInputDict, /, *, plugins: list[Plugin] | None = None) -> AddRoleToInstanceProfileOutput
add_role_to_instance_profile(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AddRoleToInstanceProfileInputDict]) -> AddRoleToInstanceProfileOutput
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.
Note
The caller of this operation must be granted the PassRole permission
on the IAM role by a permissions policy.
Warning:
When using the
iam:AssociatedResourceArn
condition in a policy to restrict the
PassRole
IAM action, special considerations apply if the policy is intended to
define access for the AddRoleToInstanceProfile action. In this case,
you cannot specify a Region or instance ID in the EC2 instance ARN. The
ARN value must be arn:aws:ec2:*:CallerAccountId:instance/*. Using any
other ARN value may lead to unexpected evaluation results.
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
AddRoleToInstanceProfileOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
AddRoleToInstanceProfileInput
dataclass
¶
Bases: _SerdeShape
Dataclass for AddRoleToInstanceProfileInput structure.
Attributes¶
instance_profile_name
class-attribute
instance-attribute
¶
instance_profile_name: str | None = ...
The name of the instance profile to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
role_name
class-attribute
instance-attribute
¶
role_name: str | None = ...
The name of the role to add.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Dictionaries¶
AddRoleToInstanceProfileInputDict
¶
Bases: TypedDict
Dictionary form of AddRoleToInstanceProfileInput.
Attributes¶
instance_profile_name
instance-attribute
¶
The name of the instance profile to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
role_name
instance-attribute
¶
The name of the role to add.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Output¶
AddRoleToInstanceProfileOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for AddRoleToInstanceProfileOutput structure.