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

Class: Aws::IAM::Types::PutGroupPolicyRequest

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

{
  group_name: "groupNameType", # required
  policy_name: "policyNameType", # required
  policy_document: "policyDocumentType", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#group_nameString

The name of the group to associate the policy with.

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)


8006
8007
8008
8009
8010
8011
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 8006

class PutGroupPolicyRequest < Struct.new(
  :group_name,
  :policy_name,
  :policy_document)
  include Aws::Structure
end

#policy_documentString

The policy document.

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)


8006
8007
8008
8009
8010
8011
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 8006

class PutGroupPolicyRequest < Struct.new(
  :group_name,
  :policy_name,
  :policy_document)
  include Aws::Structure
end

#policy_nameString

The name of the policy document.

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)


8006
8007
8008
8009
8010
8011
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 8006

class PutGroupPolicyRequest < Struct.new(
  :group_name,
  :policy_name,
  :policy_document)
  include Aws::Structure
end