Package 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("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 IAM User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PolicyVersion.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PolicyVersion.Builder>	serializableBuilderClass()
PolicyVersion.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	versionId()	The identifier for the policy version.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

document

public final 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 final 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 final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<PolicyVersion.Builder,PolicyVersion>

builder

public static PolicyVersion.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo