software.amazon.awssdk.services.iam.model

Class PolicyVersion

java.lang.Object

software.amazon.awssdk.services.iam.model.PolicyVersion

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PolicyVersion.Builder,PolicyVersion>

@Generated(value="software.amazon.awssdk:codegen")
public final class PolicyVersion
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PolicyVersion.Builder,PolicyVersion>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PolicyVersion.Builder

Method Summary

Modifier and Type	Method and Description
static PolicyVersion.Builder	builder()
Instant	createDate() The date and time, in ISO 8601 date-time format, when the policy version was created.
String	document() The policy document.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	isDefaultVersion() Specifies whether the policy version is set as the policy's default version.
List<SdkField<?>>	sdkFields()
static Class<? extends PolicyVersion.Builder>	serializableBuilderClass()
PolicyVersion.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	versionId() The identifier for the policy version.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

document

public String document()

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:

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.

versionId

public String versionId()

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:

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.

isDefaultVersion

public Boolean isDefaultVersion()

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

Returns:

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

createDate

public Instant createDate()

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

Returns:

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

toBuilder

public PolicyVersion.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PolicyVersion.Builder,PolicyVersion>

Returns:

a builder for type T

builder

public static PolicyVersion.Builder builder()

serializableBuilderClass

public static Class<? extends PolicyVersion.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.