Principal (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.servicecatalog.model.Principal

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Principal
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about a principal.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Principal()

Constructors
Constructor and Description
`Principal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Principal`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getPrincipalARN()` The ARN of the principal (user, role, or group).
`String`	`getPrincipalType()` The principal type.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setPrincipalARN(String principalARN)` The ARN of the principal (user, role, or group).
`void`	`setPrincipalType(PrincipalType principalType)` The principal type.
`void`	`setPrincipalType(String principalType)` The principal type.
`String`	`toString()` Returns a string representation of this object.
`Principal`	`withPrincipalARN(String principalARN)` The ARN of the principal (user, role, or group).
`Principal`	`withPrincipalType(PrincipalType principalType)` The principal type.
`Principal`	`withPrincipalType(String principalType)` The principal type.

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

- Constructor Detail
  - Principal
```
public Principal()
```
- Method Detail
  - setPrincipalARN
```
public void setPrincipalARN(String principalARN)
```
    The ARN of the principal (user, role, or group). This field allows for an ARN with no accountID, with or without wildcard characters if the PrincipalType is an IAM_PATTERN.
    
    For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
    
    Parameters:
    
    principalARN - The ARN of the principal (user, role, or group). This field allows for an ARN with no accountID, with or without wildcard characters if the PrincipalType is an IAM_PATTERN.
    
    For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
  - getPrincipalARN
```
public String getPrincipalARN()
```
    The ARN of the principal (user, role, or group). This field allows for an ARN with no accountID, with or without wildcard characters if the PrincipalType is an IAM_PATTERN.
    
    For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
    
    Returns:
    
    The ARN of the principal (user, role, or group). This field allows for an ARN with no accountID, with or without wildcard characters if the PrincipalType is an IAM_PATTERN.
    
    For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
  - withPrincipalARN
```
public Principal withPrincipalARN(String principalARN)
```
    The ARN of the principal (user, role, or group). This field allows for an ARN with no accountID, with or without wildcard characters if the PrincipalType is an IAM_PATTERN.
    
    For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
    
    Parameters:
    
    principalARN - The ARN of the principal (user, role, or group). This field allows for an ARN with no accountID, with or without wildcard characters if the PrincipalType is an IAM_PATTERN.
    
    For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrincipalType
```
public void setPrincipalType(String principalType)
```
    The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
    
    Parameters:
    
    principalType - The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
    
    See Also:
    
    PrincipalType
  - getPrincipalType
```
public String getPrincipalType()
```
    The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
    
    Returns:
    
    The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
    
    See Also:
    
    PrincipalType
  - withPrincipalType
```
public Principal withPrincipalType(String principalType)
```
    The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
    
    Parameters:
    
    principalType - The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PrincipalType
  - setPrincipalType
```
public void setPrincipalType(PrincipalType principalType)
```
    The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
    
    Parameters:
    
    principalType - The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
    
    See Also:
    
    PrincipalType
  - withPrincipalType
```
public Principal withPrincipalType(PrincipalType principalType)
```
    The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
    
    Parameters:
    
    principalType - The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PrincipalType
  - toString
```
public 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
    
    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 Principal 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class Principal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Principal

Method Detail

setPrincipalARN

getPrincipalARN

withPrincipalARN

setPrincipalType

getPrincipalType

withPrincipalType

setPrincipalType

withPrincipalType

toString

equals

hashCode

clone

marshall