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

Class: Aws::IAM::Types::PolicyVersion

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

Overview

Contains information about a version of a managed policy.

This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails operations.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

Instance Attribute Summary collapse

Instance Attribute Details

#create_dateTime

The date and time, in ISO 8601 date-time format, when the policy version was created.

Returns:

  • (Time)


7914
7915
7916
7917
7918
7919
7920
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7914

class PolicyVersion < Struct.new(
  :document,
  :version_id,
  :is_default_version,
  :create_date)
  include Aws::Structure
end

#documentString

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Returns:

  • (String)


7914
7915
7916
7917
7918
7919
7920
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7914

class PolicyVersion < Struct.new(
  :document,
  :version_id,
  :is_default_version,
  :create_date)
  include Aws::Structure
end

#is_default_versionBoolean

Specifies whether the policy version is set as the policy's default version.

Returns:

  • (Boolean)


7914
7915
7916
7917
7918
7919
7920
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7914

class PolicyVersion < Struct.new(
  :document,
  :version_id,
  :is_default_version,
  :create_date)
  include Aws::Structure
end

#version_idString

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

Returns:

  • (String)


7914
7915
7916
7917
7918
7919
7920
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7914

class PolicyVersion < Struct.new(
  :document,
  :version_id,
  :is_default_version,
  :create_date)
  include Aws::Structure
end