Skip to main content

roles

Creates, updates, deletes or gets a role resource or lists roles in a region

Overview​

Nameroles
TypeResource
Description
Creates a new role for your AWS-account.For more information about roles, see IAM roles in the IAM User Guide. For information about quotas for role names and the number of roles you can create, see IAM and quotas in the IAM User Guide.
Idawscc.iam.roles

Fields​

NameDatatypeDescription
arnstring
assume_role_policy_documentobjectThe trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see Template Examples. For more information about the elements that you can use in an IAM policy, see Policy Elements Reference in the User Guide.
descriptionstringA description of the role that you provide.
managed_policy_arnsarray
A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.For more information about ARNs, see Amazon Resource Names (ARNs) and Service Namespaces in the General Reference.
max_session_durationinteger
The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-secondsCLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole API operations or the assume-roleCLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.
pathstring
The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
permissions_boundarystring
The ARN of the policy used to set the permissions boundary for the role.For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
▶policiesarray
Adds or updates an inline policy document that is embedded in the specified IAM role.When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities.
A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies in the User Guide.
For information about limits on the number of inline policies that you can embed with a role, see Limitations on Entities in the User Guide.
If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy) has a Ref to a role and if a resource (such as AWS::ECS::Service) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that CFN deletes the AWS::ECS::Service resource before deleting its role's policy.
role_idstring
role_namestring
A name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the CreateRole action in the User Guide.This parameter allows (per 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: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging Resources in Templates.
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
▶tagsarrayA list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
regionstringAWS region.

For more information, see AWS::IAM::Role.

Methods​

NameResourceAccessible byRequired Params
create_resourcerolesINSERTAssumeRolePolicyDocument, region
delete_resourcerolesDELETEIdentifier, region
update_resourcerolesUPDATEIdentifier, PatchDocument, region
list_resourcesroles_list_onlySELECTregion
get_resourcerolesSELECTIdentifier, region

SELECT examples​

Gets all properties from an individual role.

SELECT
  region,
  arn,
  assume_role_policy_document,
  description,
  managed_policy_arns,
  max_session_duration,
  path,
  permissions_boundary,
  policies,
  role_id,
  role_name,
  tags
FROM awscc.iam.roles
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ role_name }}';

INSERT example​

Use the following StackQL query and manifest file to create a new role resource, using stack-deploy.

/*+ create */
INSERT INTO awscc.iam.roles (
  AssumeRolePolicyDocument,
  region
)
SELECT
  '{{ assume_role_policy_document }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

UPDATE example​

Use the following StackQL query and manifest file to update a role resource, using stack-deploy.

/*+ update */
UPDATE awscc.iam.roles
SET PatchDocument = string('{{ {
    "AssumeRolePolicyDocument": assume_role_policy_document,
    "Description": description,
    "ManagedPolicyArns": managed_policy_arns,
    "MaxSessionDuration": max_session_duration,
    "PermissionsBoundary": permissions_boundary,
    "Policies": policies,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ role_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example​

/*+ delete */
DELETE FROM awscc.iam.roles
WHERE
  Identifier = '{{ role_name }}' AND
  region = 'us-east-1'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters​

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

ParameterDescription
ClientToken
A unique identifier to ensure the idempotency of the resource request.This allows the provider to accurately distinguish between retries and new requests.
A client token is valid for 36 hours once used.
After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
RoleArn
The ARN of the IAM role used to perform this resource operation.The role specified must have the permissions required for this operation.
If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId
For private resource types, the type version to use in this resource operation.If you do not specify a resource version, the default version is used.

Permissions​

To operate on the roles resource, the following permissions are required:

iam:CreateRole,
iam:PutRolePolicy,
iam:AttachRolePolicy,
iam:GetRolePolicy,
iam:TagRole,
iam:UntagRole,
iam:GetRole