Role
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.
Example Usage
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Properties
The 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. Search the CloudFormation User Guide for AWS::IAM::Role
for more information about the expected schema for this property.
A description of the role that you provide.
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.
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-seconds`
CLI 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-role*`
CLI 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.
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.
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.
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 IAM User Guide . For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .
Returns the stable and unique string identifying the role. For example, AIDAJQABLZS4A3QDU576Q
. For more information about IDs, see IAM Identifiers in the IAM User Guide .
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 IAM 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, AWS CloudFormation 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 IAM Resources in AWS CloudFormation Templates .
A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.