Package software.amazon.awssdk.services.organizations.model

Class PolicySummary

java.lang.Object

software.amazon.awssdk.services.organizations.model.PolicySummary

All Implemented Interfaces:

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

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

Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PolicySummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the policy.
Boolean	awsManaged()	A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy.
static PolicySummary.Builder	builder()
String	description()	The description of the policy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The unique identifier (ID) of the policy.
String	name()	The friendly name of the policy.
List<SdkField<?>>	sdkFields()
static Class<? extends PolicySummary.Builder>	serializableBuilderClass()
PolicySummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PolicyType	type()	The type of policy.
String	typeAsString()	The type of policy.

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

id

public final String id()

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

Returns:

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

arn

public final String arn()

The Amazon Resource Name (ARN) of the policy.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

Returns:

The Amazon Resource Name (ARN) of the policy.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

name

public final String name()

The friendly name of the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

Returns:

The friendly name of the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

description

public final String description()

The description of the policy.

Returns:

The description of the policy.

type

public final PolicyType type()

The type of policy.

If the service returns an enum value that is not available in the current SDK version, type will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of policy.

See Also:

PolicyType

typeAsString

public final String typeAsString()

The type of policy.

If the service returns an enum value that is not available in the current SDK version, type will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of policy.

See Also:

PolicyType

awsManaged

public final Boolean awsManaged()

A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

Returns:

A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

toBuilder

public PolicySummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PolicySummary.Builder,PolicySummary>

builder

public static PolicySummary.Builder builder()

serializableBuilderClass

public static Class<? extends PolicySummary.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