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

Class: Aws::IAM::Types::UpdateAssumeRolePolicyRequest

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 UpdateAssumeRolePolicyRequest data as a hash:

{
  role_name: "roleNameType", # required
  policy_document: "policyDocumentType", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#policy_documentString

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

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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)

Returns:

  • (String)


10208
10209
10210
10211
10212
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10208

class UpdateAssumeRolePolicyRequest < Struct.new(
  :role_name,
  :policy_document)
  include Aws::Structure
end

#role_nameString

The name of the role to update with the new policy.

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: _+=,.@-

Returns:

  • (String)


10208
10209
10210
10211
10212
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10208

class UpdateAssumeRolePolicyRequest < Struct.new(
  :role_name,
  :policy_document)
  include Aws::Structure
end