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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

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.

In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The [regex pattern] used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (‘u0020`) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through ‘u00FF`)

  • The special characters tab (‘u0009`), line feed (`u000A`), and carriage return (`u000D`)

Upon success, the response includes the same trust policy in JSON format.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String)


1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
# File 'lib/aws-sdk-iam/types.rb', line 1300

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the role.

Returns:

  • (String)


1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
# File 'lib/aws-sdk-iam/types.rb', line 1300

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#max_session_durationInteger

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the CLI or API can use the ‘DurationSeconds` API parameter or the `duration-seconds` CLI parameter to request a longer session. The `MaxSessionDuration` setting determines the maximum duration that can be requested using the `DurationSeconds` parameter. If users don’t specify a value for the ‘DurationSeconds` parameter, their security credentials are valid for one hour by default. This applies when you use the `AssumeRole*` API operations or the `assume-role*` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles] in the *IAM User Guide*.

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

Returns:

  • (Integer)


1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
# File 'lib/aws-sdk-iam/types.rb', line 1300

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  SENSITIVE = []
  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 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)


1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
# File 'lib/aws-sdk-iam/types.rb', line 1300

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#permissions_boundaryString

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

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)


1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
# File 'lib/aws-sdk-iam/types.rb', line 1300

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_nameString

The name of the role 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”.

This parameter allows (through 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: _+=,[email protected]

[1]: wikipedia.org/wiki/regex

Returns:

  • (String)


1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
# File 'lib/aws-sdk-iam/types.rb', line 1300

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags that you want to attach to the new role. 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:



1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
# File 'lib/aws-sdk-iam/types.rb', line 1300

class CreateRoleRequest < Struct.new(
  :path,
  :role_name,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end