GetUserResult

data class GetUserResult(val arn: String? = null, val groups: List<String>? = null, val loginProfile: UserLoginProfile? = null, val managedPolicyArns: List<String>? = null, val path: String? = null, val permissionsBoundary: String? = null, val policies: List<UserPolicy>? = null, val tags: List<Tag>? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, groups: List<String>? = null, loginProfile: UserLoginProfile? = null, managedPolicyArns: List<String>? = null, path: String? = null, permissionsBoundary: String? = null, policies: List<UserPolicy>? = null, tags: List<Tag>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::User resource. For example: arn:aws:iam::123456789012:user/mystack-myuser-1CCXAFG2H2U4D .

Link copied to clipboard
val groups: List<String>? = null

A list of group names to which you want to add the user.

Link copied to clipboard

Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console. You can use the CLI, the AWS API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the console. For more information about managing passwords, see Managing passwords in the User Guide.

Link copied to clipboard

A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user. For more information about ARNs, see Amazon Resource Names (ARNs) and Service Namespaces in the General Reference.

Link copied to clipboard
val path: String? = null

The path for the user name. 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.

Link copied to clipboard

The ARN of the managed policy that is used to set the permissions boundary for the user. A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide. For more information about policy types, see Policy types in the IAM User Guide.

Link copied to clipboard
val policies: List<UserPolicy>? = null

Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see Declaring an User Resource. The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. For information about limits on the number of inline policies that you can embed in a user, see Limitations on Entities in the User Guide.

Link copied to clipboard
val tags: List<Tag>? = null

A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.