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)


931
932
933
934
935
936
937
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 931

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 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)


931
932
933
934
935
936
937
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 931

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.

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)


931
932
933
934
935
936
937
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 931

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

#policy_nameString

The friendly name of the policy.

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

Returns:

  • (String)


931
932
933
934
935
936
937
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 931

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