PolicyTargetSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.organizations.model.PolicyTargetSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PolicyTargetSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about a root, OU, or account that a policy is attached to.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PolicyTargetSummary()

Constructors
Constructor and Description
`PolicyTargetSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PolicyTargetSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the policy target.
`String`	`getName()` The friendly name of the policy target.
`String`	`getTargetId()` The unique identifier (ID) of the policy target.
`String`	`getType()` The type of the policy target.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the policy target.
`void`	`setName(String name)` The friendly name of the policy target.
`void`	`setTargetId(String targetId)` The unique identifier (ID) of the policy target.
`void`	`setType(String type)` The type of the policy target.
`void`	`setType(TargetType type)` The type of the policy target.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PolicyTargetSummary`	`withArn(String arn)` The Amazon Resource Name (ARN) of the policy target.
`PolicyTargetSummary`	`withName(String name)` The friendly name of the policy target.
`PolicyTargetSummary`	`withTargetId(String targetId)` The unique identifier (ID) of the policy target.
`PolicyTargetSummary`	`withType(String type)` The type of the policy target.
`PolicyTargetSummary`	`withType(TargetType type)` The type of the policy target.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PolicyTargetSummary
```
public PolicyTargetSummary()
```
- Method Detail
  - setTargetId
```
public void setTargetId(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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
    Parameters:
    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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
  - getTargetId
```
public String getTargetId()
```
    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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case 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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
  - withTargetId
```
public PolicyTargetSummary withTargetId(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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
    Parameters:
    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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(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 AWS Organizations User Guide.
    
    Parameters:
    
    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 AWS Organizations User Guide.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the policy target.
    
    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 target.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
  - withArn
```
public PolicyTargetSummary withArn(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 AWS Organizations User Guide.
    
    Parameters:
    
    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 AWS Organizations User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(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.
    
    Parameters:
    
    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.
  - getName
```
public String getName()
```
    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.
  - withName
```
public PolicyTargetSummary withName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the policy target.
    
    Parameters:
    
    type - The type of the policy target.
    
    See Also:
    
    TargetType
  - getType
```
public String getType()
```
    The type of the policy target.
    
    Returns:
    
    The type of the policy target.
    
    See Also:
    
    TargetType
  - withType
```
public PolicyTargetSummary withType(String type)
```
    The type of the policy target.
    
    Parameters:
    
    type - The type of the policy target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetType
  - setType
```
public void setType(TargetType type)
```
    The type of the policy target.
    
    Parameters:
    
    type - The type of the policy target.
    
    See Also:
    
    TargetType
  - withType
```
public PolicyTargetSummary withType(TargetType type)
```
    The type of the policy target.
    
    Parameters:
    
    type - The type of the policy target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetType
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PolicyTargetSummary clone()
```
    Overrides:
    
    clone 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.

Did this page help you?

Class PolicyTargetSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PolicyTargetSummary

Method Detail

setTargetId

getTargetId

withTargetId

setArn

getArn

withArn

setName

getName

withName

setType

getType

withType

setType

withType

toString

equals

hashCode

clone

marshall