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

Class: Aws::IAM::Types::CreatePolicyRequest

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

{
  policy_name: "policyNameType", # required
  path: "policyPathType",
  policy_document: "policyDocumentType", # required
  description: "policyDescriptionType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Returns:

  • (String)


1068
1069
1070
1071
1072
1073
1074
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1068

class CreatePolicyRequest < Struct.new(
  :policy_name,
  :path,
  :policy_document,
  :description)
  include Aws::Structure
end

#pathString

The path for the policy.

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.

Returns:

  • (String)


1068
1069
1070
1071
1072
1073
1074
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1068

class CreatePolicyRequest < Struct.new(
  :policy_name,
  :path,
  :policy_document,
  :description)
  include Aws::Structure
end

#policy_documentString

The JSON policy document that you want to use as the content for the new policy.

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)


1068
1069
1070
1071
1072
1073
1074
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1068

class CreatePolicyRequest < Struct.new(
  :policy_name,
  :path,
  :policy_document,
  :description)
  include Aws::Structure
end

#policy_nameString

The friendly name of the policy.

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)


1068
1069
1070
1071
1072
1073
1074
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1068

class CreatePolicyRequest < Struct.new(
  :policy_name,
  :path,
  :policy_document,
  :description)
  include Aws::Structure
end