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

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::PolicyVersion

Includes:

Structure

Defined in:

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][4

operations.

For more information about managed policies, refer to [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicyVersion.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicyVersion.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListPolicyVersions.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetAccountAuthorizationDetails.html [5]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #create_date ⇒ Time

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

• #document ⇒ String

  The policy document.

• #is_default_version ⇒ Boolean

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

• #version_id ⇒ String

  The identifier for the policy version.

Instance Attribute Details

#create_date ⇒ Time

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

[1]: www.iso.org/iso/iso8601

Returns:

• (Time)

# File 'lib/aws-sdk-iam/types.rb', line 8828

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

#document ⇒ String

The policy document.

The policy document is returned in the response to the

GetPolicyVersion][1

and [GetAccountAuthorizationDetails]

operations. It is not returned in the response to the

CreatePolicyVersion][3

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.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicyVersion.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetAccountAuthorizationDetails.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicyVersion.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListPolicyVersions.html [5]: tools.ietf.org/html/rfc3986

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 8828

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

#is_default_version ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-iam/types.rb', line 8828

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

#version_id ⇒ String

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)

# File 'lib/aws-sdk-iam/types.rb', line 8828

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