Class: Aws::IAM::Types::CreateUserRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass CreateUserRequest data as a hash:

{
  path: "pathType",
  user_name: "userNameType", # required
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
  permissions_boundary: "arnType",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#path ⇒ String

The path for the user name. For more information about paths, see

IAM Identifiers][1

in the *IAM User Guide*.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (per 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.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html [2]: wikipedia.org/wiki/regex

Returns:

  • (String) 


1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-iam/types.rb', line 1471

class CreateUserRequest < Struct.new(
  :path,
  :user_name,
  :tags,
  :permissions_boundary)
  include Aws::Structure
end

#permissions_boundary ⇒ String

The ARN of the policy that is used to set the permissions boundary for the user.

Returns:

  • (String) 


1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-iam/types.rb', line 1471

class CreateUserRequest < Struct.new(
  :path,
  :user_name,
  :tags,
  :permissions_boundary)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM Identities] in the *IAM User Guide*.

<note markdown=“1”> If any one of the tags is invalid or if you exceed the allowed number of tags per user, then the entire request fails and the user is not created.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:



1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-iam/types.rb', line 1471

class CreateUserRequest < Struct.new(
  :path,
  :user_name,
  :tags,
  :permissions_boundary)
  include Aws::Structure
end

#user_name ⇒ String

The name of the user to create.

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: _+=,.@-. User names are not distinguished by case. For example, you cannot create users named both “TESTUSER” and “testuser”.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-iam/types.rb', line 1471

class CreateUserRequest < Struct.new(
  :path,
  :user_name,
  :tags,
  :permissions_boundary)
  include Aws::Structure
end