Class: Aws::IoT::Types::CreatePolicyRequest

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

Overview

Note:

When making an API call, you may pass CreatePolicyRequest data as a hash:

{
  policy_name: "PolicyName", # required
  policy_document: "PolicyDocument", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

The input for the CreatePolicy operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#policy_documentString

The JSON document that describes the policy. *policyDocument* must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Returns:

  • (String)


4225
4226
4227
4228
4229
4230
4231
# File 'lib/aws-sdk-iot/types.rb', line 4225

class CreatePolicyRequest < Struct.new(
  :policy_name,
  :policy_document,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#policy_nameString

The policy name.

Returns:

  • (String)


4225
4226
4227
4228
4229
4230
4231
# File 'lib/aws-sdk-iot/types.rb', line 4225

class CreatePolicyRequest < Struct.new(
  :policy_name,
  :policy_document,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Metadata which can be used to manage the policy.

<note markdown=“1”> For URI Request parameters use format: …key1=value1&amp;key2=value2…

For the CLI command-line parameter use format: &amp;&amp;tags

“key1=value1&amp;key2=value2…”

For the cli-input-json file use format: "tags":

“key1=value1&amp;key2=value2…”

</note>

Returns:



4225
4226
4227
4228
4229
4230
4231
# File 'lib/aws-sdk-iot/types.rb', line 4225

class CreatePolicyRequest < Struct.new(
  :policy_name,
  :policy_document,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end