ImpersonationRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workmail.model.ImpersonationRule

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The rules for the given impersonation role.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ImpersonationRule()

Constructors
Constructor and Description
`ImpersonationRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImpersonationRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` The rule description.
`String`	`getEffect()` The effect of the rule when it matches the input.
`String`	`getImpersonationRuleId()` The identifier of the rule.
`String`	`getName()` The rule name.
`List<String>`	`getNotTargetUsers()` A list of user IDs that don't match the rule.
`List<String>`	`getTargetUsers()` A list of user IDs that match the rule.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription(String description)` The rule description.
`void`	`setEffect(String effect)` The effect of the rule when it matches the input.
`void`	`setImpersonationRuleId(String impersonationRuleId)` The identifier of the rule.
`void`	`setName(String name)` The rule name.
`void`	`setNotTargetUsers(Collection<String> notTargetUsers)` A list of user IDs that don't match the rule.
`void`	`setTargetUsers(Collection<String> targetUsers)` A list of user IDs that match the rule.
`String`	`toString()` Returns a string representation of this object.
`ImpersonationRule`	`withDescription(String description)` The rule description.
`ImpersonationRule`	`withEffect(AccessEffect effect)` The effect of the rule when it matches the input.
`ImpersonationRule`	`withEffect(String effect)` The effect of the rule when it matches the input.
`ImpersonationRule`	`withImpersonationRuleId(String impersonationRuleId)` The identifier of the rule.
`ImpersonationRule`	`withName(String name)` The rule name.
`ImpersonationRule`	`withNotTargetUsers(Collection<String> notTargetUsers)` A list of user IDs that don't match the rule.
`ImpersonationRule`	`withNotTargetUsers(String... notTargetUsers)` A list of user IDs that don't match the rule.
`ImpersonationRule`	`withTargetUsers(Collection<String> targetUsers)` A list of user IDs that match the rule.
`ImpersonationRule`	`withTargetUsers(String... targetUsers)` A list of user IDs that match the rule.

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

- Constructor Detail
  - ImpersonationRule
```
public ImpersonationRule()
```
- Method Detail
  - setImpersonationRuleId
```
public void setImpersonationRuleId(String impersonationRuleId)
```
    The identifier of the rule.
    
    Parameters:
    
    impersonationRuleId - The identifier of the rule.
  - getImpersonationRuleId
```
public String getImpersonationRuleId()
```
    The identifier of the rule.
    
    Returns:
    
    The identifier of the rule.
  - withImpersonationRuleId
```
public ImpersonationRule withImpersonationRuleId(String impersonationRuleId)
```
    The identifier of the rule.
    
    Parameters:
    
    impersonationRuleId - The identifier of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The rule name.
    
    Parameters:
    
    name - The rule name.
  - getName
```
public String getName()
```
    The rule name.
    
    Returns:
    
    The rule name.
  - withName
```
public ImpersonationRule withName(String name)
```
    The rule name.
    
    Parameters:
    
    name - The rule name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The rule description.
    
    Parameters:
    
    description - The rule description.
  - getDescription
```
public String getDescription()
```
    The rule description.
    
    Returns:
    
    The rule description.
  - withDescription
```
public ImpersonationRule withDescription(String description)
```
    The rule description.
    
    Parameters:
    
    description - The rule description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEffect
```
public void setEffect(String effect)
```
    The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
    
    Parameters:
    
    effect - The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
    
    See Also:
    
    AccessEffect
  - getEffect
```
public String getEffect()
```
    The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
    
    Returns:
    
    The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
    
    See Also:
    
    AccessEffect
  - withEffect
```
public ImpersonationRule withEffect(String effect)
```
    The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
    
    Parameters:
    
    effect - The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccessEffect
  - withEffect
```
public ImpersonationRule withEffect(AccessEffect effect)
```
    The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
    
    Parameters:
    
    effect - The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccessEffect
  - getTargetUsers
```
public List<String> getTargetUsers()
```
    A list of user IDs that match the rule.
    
    Returns:
    
    A list of user IDs that match the rule.
  - setTargetUsers
```
public void setTargetUsers(Collection<String> targetUsers)
```
    A list of user IDs that match the rule.
    
    Parameters:
    
    targetUsers - A list of user IDs that match the rule.
  - withTargetUsers
```
public ImpersonationRule withTargetUsers(String... targetUsers)
```
    A list of user IDs that match the rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setTargetUsers(java.util.Collection) or withTargetUsers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    targetUsers - A list of user IDs that match the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargetUsers
```
public ImpersonationRule withTargetUsers(Collection<String> targetUsers)
```
    A list of user IDs that match the rule.
    
    Parameters:
    
    targetUsers - A list of user IDs that match the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNotTargetUsers
```
public List<String> getNotTargetUsers()
```
    A list of user IDs that don't match the rule.
    
    Returns:
    
    A list of user IDs that don't match the rule.
  - setNotTargetUsers
```
public void setNotTargetUsers(Collection<String> notTargetUsers)
```
    A list of user IDs that don't match the rule.
    
    Parameters:
    
    notTargetUsers - A list of user IDs that don't match the rule.
  - withNotTargetUsers
```
public ImpersonationRule withNotTargetUsers(String... notTargetUsers)
```
    A list of user IDs that don't match the rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotTargetUsers(java.util.Collection) or withNotTargetUsers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    notTargetUsers - A list of user IDs that don't match the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNotTargetUsers
```
public ImpersonationRule withNotTargetUsers(Collection<String> notTargetUsers)
```
    A list of user IDs that don't match the rule.
    
    Parameters:
    
    notTargetUsers - A list of user IDs that don't match the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 ImpersonationRule 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.782

Class ImpersonationRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImpersonationRule

Method Detail

setImpersonationRuleId

getImpersonationRuleId

withImpersonationRuleId

setName

getName

withName

setDescription

getDescription

withDescription

setEffect

getEffect

withEffect

withEffect

getTargetUsers

setTargetUsers

withTargetUsers

withTargetUsers

getNotTargetUsers

setNotTargetUsers

withNotTargetUsers

withNotTargetUsers

toString

equals

hashCode

clone

marshall