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

Class PolicyTargetSummary

java.lang.Object

software.amazon.awssdk.services.organizations.model.PolicyTargetSummary

All Implemented Interfaces:

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

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

Contains information about a root, OU, or account that a policy is attached to.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PolicyTargetSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the policy target.
static PolicyTargetSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The friendly name of the policy target.
List<SdkField<?>>	sdkFields()
static Class<? extends PolicyTargetSummary.Builder>	serializableBuilderClass()
String	targetId()	The unique identifier (ID) of the policy target.
PolicyTargetSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TargetType	type()	The type of the policy target.
String	typeAsString()	The type of the policy target.

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

targetId

public final String targetId()

The unique identifier (ID) of the policy target.

The regex pattern for a target ID string requires one of the following:

• Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

• Account - A string that consists of exactly 12 digits.

• Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Returns:

The unique identifier (ID) of the policy target.

The regex pattern for a target ID string requires one of the following:

• Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

• Account - A string that consists of exactly 12 digits.

• Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

arn

public final String arn()

The Amazon Resource Name (ARN) of the policy target.

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 target.

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 target.

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 target.

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

type

public final TargetType type()

The type of the policy target.

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

Returns:

The type of the policy target.

See Also:

TargetType

typeAsString

public final String typeAsString()

The type of the policy target.

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

Returns:

The type of the policy target.

See Also:

TargetType

toBuilder

public PolicyTargetSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PolicyTargetSummary.Builder,PolicyTargetSummary>

builder

public static PolicyTargetSummary.Builder builder()

serializableBuilderClass

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