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
  permissions_boundary: "arnType",
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#pathString

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 (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.

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

Returns:

  • (String)

1756
1757
1758
1759
1760
1761
1762
1763
# File 'lib/aws-sdk-iam/types.rb', line 1756

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

#permissions_boundaryString

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

Returns:

  • (String)

1756
1757
1758
1759
1760
1761
1762
1763
# File 'lib/aws-sdk-iam/types.rb', line 1756

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

#tagsArray<Types::Tag>

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*.

<note markdown=“1”> 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.

</note>

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

Returns:


1756
1757
1758
1759
1760
1761
1762
1763
# File 'lib/aws-sdk-iam/types.rb', line 1756

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

#user_nameString

The name of the user to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.

Returns:

  • (String)

1756
1757
1758
1759
1760
1761
1762
1763
# File 'lib/aws-sdk-iam/types.rb', line 1756

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