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

Class: Aws::IoT::Types::CreatePolicyVersionRequest

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

Overview

Note:

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

{
  policy_name: "PolicyName", # required
  policy_document: "PolicyDocument", # required
  set_as_default: false,
}

The input for the CreatePolicyVersion operation.

Instance Attribute Summary collapse

Instance Attribute Details

#policy_documentString

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespaces

Returns:

  • (String)


720
721
722
723
724
725
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 720

class CreatePolicyVersionRequest < Struct.new(
  :policy_name,
  :policy_document,
  :set_as_default)
  include Aws::Structure
end

#policy_nameString

The policy name.

Returns:

  • (String)


720
721
722
723
724
725
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 720

class CreatePolicyVersionRequest < Struct.new(
  :policy_name,
  :policy_document,
  :set_as_default)
  include Aws::Structure
end

#set_as_defaultBoolean

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Returns:

  • (Boolean)


720
721
722
723
724
725
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 720

class CreatePolicyVersionRequest < Struct.new(
  :policy_name,
  :policy_document,
  :set_as_default)
  include Aws::Structure
end