You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IAM::Types::CreateRoleRequest

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

Overview

Note:

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

{
  path: "pathType",
  role_name: "roleNameType", # required
  assume_role_policy_document: "policyDocumentType", # required
  description: "roleDescriptionType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#assume_role_policy_documentString

The trust relationship policy document that grants an entity permission to assume the role.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF). It also includes the special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D).

Returns:

  • (String)


1097
1098
1099
1100
1101
1102
1103
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1097

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description)
  include Aws::Structure
end

#descriptionString

A customer-provided description of the role.

Returns:

  • (String)


1097
1098
1099
1100
1101
1102
1103
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1097

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description)
  include Aws::Structure
end

#pathString

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 paramater 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, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Returns:

  • (String)


1097
1098
1099
1100
1101
1102
1103
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1097

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description)
  include Aws::Structure
end

#role_nameString

The name of the role 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: _+=,.@-

Role names are not distinguished by case. For example, you cannot create roles named both "PRODROLE" and "prodrole".

Returns:

  • (String)


1097
1098
1099
1100
1101
1102
1103
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1097

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description)
  include Aws::Structure
end