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

Class PolicySummary

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<PolicySummary.Builder,PolicySummary>

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

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

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 AWS managed policy.
static PolicySummary.Builder	builder()
String	description()	The description of the policy.
boolean	equals(Object obj)
int	hashCode()
String	id()	The unique identifier (ID) of the policy.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	The friendly name of the policy.
static Class<? extends PolicySummary.Builder>	serializableBuilderClass()
PolicySummary.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	The type of policy.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

id

public 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 lower-case letters or digits.

Returns:

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

arn

public 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 AWS Organizations User Guide.

Returns:

The Amazon Resource Name (ARN) of the policy.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

name

public 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 String description()

The description of the policy.

Returns:

The description of the policy.

type

public String type()

The type of policy.

Returns:

The type of policy.

See Also:

PolicyType

awsManaged

public Boolean awsManaged()

A boolean value that indicates whether the specified policy is an AWS 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 AWS 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()

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<PolicySummary.Builder,PolicySummary>

Returns:

a builder for type T

builder

public static PolicySummary.Builder builder()

serializableBuilderClass

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.