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

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::CreateUserRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iam/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #path ⇒ String

  The path for the user name.

• #permissions_boundary ⇒ String

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

• #tags ⇒ Array<Types::Tag>

  A list of tags that you want to attach to the new user.

• #user_name ⇒ String

  The name of the user to create.

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

# File 'lib/aws-sdk-iam/types.rb', line 1613

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

#permissions_boundary ⇒ String

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 ][2] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 1613

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

#tags ⇒ Array<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:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-iam/types.rb', line 1613

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

#user_name ⇒ String

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)

# File 'lib/aws-sdk-iam/types.rb', line 1613

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