AccessControlRule (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AccessControlRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A rule that controls access to an WorkMail organization.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AccessControlRule()

Constructors
Constructor and Description
`AccessControlRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessControlRule`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getActions()` Access protocol actions to include in the rule.
`Date`	`getDateCreated()` The date that the rule was created.
`Date`	`getDateModified()` The date that the rule was modified.
`String`	`getDescription()` The rule description.
`String`	`getEffect()` The rule effect.
`List<String>`	`getImpersonationRoleIds()` Impersonation role IDs to include in the rule.
`List<String>`	`getIpRanges()` IPv4 CIDR ranges to include in the rule.
`String`	`getName()` The rule name.
`List<String>`	`getNotActions()` Access protocol actions to exclude from the rule.
`List<String>`	`getNotImpersonationRoleIds()` Impersonation role IDs to exclude from the rule.
`List<String>`	`getNotIpRanges()` IPv4 CIDR ranges to exclude from the rule.
`List<String>`	`getNotUserIds()` User IDs to exclude from the rule.
`List<String>`	`getUserIds()` User IDs to include in the rule.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActions(Collection<String> actions)` Access protocol actions to include in the rule.
`void`	`setDateCreated(Date dateCreated)` The date that the rule was created.
`void`	`setDateModified(Date dateModified)` The date that the rule was modified.
`void`	`setDescription(String description)` The rule description.
`void`	`setEffect(String effect)` The rule effect.
`void`	`setImpersonationRoleIds(Collection<String> impersonationRoleIds)` Impersonation role IDs to include in the rule.
`void`	`setIpRanges(Collection<String> ipRanges)` IPv4 CIDR ranges to include in the rule.
`void`	`setName(String name)` The rule name.
`void`	`setNotActions(Collection<String> notActions)` Access protocol actions to exclude from the rule.
`void`	`setNotImpersonationRoleIds(Collection<String> notImpersonationRoleIds)` Impersonation role IDs to exclude from the rule.
`void`	`setNotIpRanges(Collection<String> notIpRanges)` IPv4 CIDR ranges to exclude from the rule.
`void`	`setNotUserIds(Collection<String> notUserIds)` User IDs to exclude from the rule.
`void`	`setUserIds(Collection<String> userIds)` User IDs to include in the rule.
`String`	`toString()` Returns a string representation of this object.
`AccessControlRule`	`withActions(Collection<String> actions)` Access protocol actions to include in the rule.
`AccessControlRule`	`withActions(String... actions)` Access protocol actions to include in the rule.
`AccessControlRule`	`withDateCreated(Date dateCreated)` The date that the rule was created.
`AccessControlRule`	`withDateModified(Date dateModified)` The date that the rule was modified.
`AccessControlRule`	`withDescription(String description)` The rule description.
`AccessControlRule`	`withEffect(AccessControlRuleEffect effect)` The rule effect.
`AccessControlRule`	`withEffect(String effect)` The rule effect.
`AccessControlRule`	`withImpersonationRoleIds(Collection<String> impersonationRoleIds)` Impersonation role IDs to include in the rule.
`AccessControlRule`	`withImpersonationRoleIds(String... impersonationRoleIds)` Impersonation role IDs to include in the rule.
`AccessControlRule`	`withIpRanges(Collection<String> ipRanges)` IPv4 CIDR ranges to include in the rule.
`AccessControlRule`	`withIpRanges(String... ipRanges)` IPv4 CIDR ranges to include in the rule.
`AccessControlRule`	`withName(String name)` The rule name.
`AccessControlRule`	`withNotActions(Collection<String> notActions)` Access protocol actions to exclude from the rule.
`AccessControlRule`	`withNotActions(String... notActions)` Access protocol actions to exclude from the rule.
`AccessControlRule`	`withNotImpersonationRoleIds(Collection<String> notImpersonationRoleIds)` Impersonation role IDs to exclude from the rule.
`AccessControlRule`	`withNotImpersonationRoleIds(String... notImpersonationRoleIds)` Impersonation role IDs to exclude from the rule.
`AccessControlRule`	`withNotIpRanges(Collection<String> notIpRanges)` IPv4 CIDR ranges to exclude from the rule.
`AccessControlRule`	`withNotIpRanges(String... notIpRanges)` IPv4 CIDR ranges to exclude from the rule.
`AccessControlRule`	`withNotUserIds(Collection<String> notUserIds)` User IDs to exclude from the rule.
`AccessControlRule`	`withNotUserIds(String... notUserIds)` User IDs to exclude from the rule.
`AccessControlRule`	`withUserIds(Collection<String> userIds)` User IDs to include in the rule.
`AccessControlRule`	`withUserIds(String... userIds)` User IDs to include in the rule.

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

- Constructor Detail
  - AccessControlRule
```
public AccessControlRule()
```
- Method Detail
  - 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 AccessControlRule 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.
  - setEffect
```
public void setEffect(String effect)
```
    The rule effect.
    
    Parameters:
    
    effect - The rule effect.
    
    See Also:
    
    AccessControlRuleEffect
  - getEffect
```
public String getEffect()
```
    The rule effect.
    
    Returns:
    
    The rule effect.
    
    See Also:
    
    AccessControlRuleEffect
  - withEffect
```
public AccessControlRule withEffect(String effect)
```
    The rule effect.
    
    Parameters:
    
    effect - The rule effect.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccessControlRuleEffect
  - withEffect
```
public AccessControlRule withEffect(AccessControlRuleEffect effect)
```
    The rule effect.
    
    Parameters:
    
    effect - The rule effect.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccessControlRuleEffect
  - 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 AccessControlRule 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.
  - getIpRanges
```
public List<String> getIpRanges()
```
    IPv4 CIDR ranges to include in the rule.
    
    Returns:
    
    IPv4 CIDR ranges to include in the rule.
  - setIpRanges
```
public void setIpRanges(Collection<String> ipRanges)
```
    IPv4 CIDR ranges to include in the rule.
    
    Parameters:
    
    ipRanges - IPv4 CIDR ranges to include in the rule.
  - withIpRanges
```
public AccessControlRule withIpRanges(String... ipRanges)
```
    IPv4 CIDR ranges to include in the rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setIpRanges(java.util.Collection) or withIpRanges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ipRanges - IPv4 CIDR ranges to include in the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIpRanges
```
public AccessControlRule withIpRanges(Collection<String> ipRanges)
```
    IPv4 CIDR ranges to include in the rule.
    
    Parameters:
    
    ipRanges - IPv4 CIDR ranges to include in the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNotIpRanges
```
public List<String> getNotIpRanges()
```
    IPv4 CIDR ranges to exclude from the rule.
    
    Returns:
    
    IPv4 CIDR ranges to exclude from the rule.
  - setNotIpRanges
```
public void setNotIpRanges(Collection<String> notIpRanges)
```
    IPv4 CIDR ranges to exclude from the rule.
    
    Parameters:
    
    notIpRanges - IPv4 CIDR ranges to exclude from the rule.
  - withNotIpRanges
```
public AccessControlRule withNotIpRanges(String... notIpRanges)
```
    IPv4 CIDR ranges to exclude from the rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotIpRanges(java.util.Collection) or withNotIpRanges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    notIpRanges - IPv4 CIDR ranges to exclude from the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNotIpRanges
```
public AccessControlRule withNotIpRanges(Collection<String> notIpRanges)
```
    IPv4 CIDR ranges to exclude from the rule.
    
    Parameters:
    
    notIpRanges - IPv4 CIDR ranges to exclude from the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getActions
```
public List<String> getActions()
```
    Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Returns:
    
    Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
  - setActions
```
public void setActions(Collection<String> actions)
```
    Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Parameters:
    
    actions - Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
  - withActions
```
public AccessControlRule withActions(String... actions)
```
    Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    NOTE: This method appends the values to the existing list (if any). Use setActions(java.util.Collection) or withActions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    actions - Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withActions
```
public AccessControlRule withActions(Collection<String> actions)
```
    Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Parameters:
    
    actions - Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNotActions
```
public List<String> getNotActions()
```
    Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Returns:
    
    Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
  - setNotActions
```
public void setNotActions(Collection<String> notActions)
```
    Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Parameters:
    
    notActions - Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
  - withNotActions
```
public AccessControlRule withNotActions(String... notActions)
```
    Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotActions(java.util.Collection) or withNotActions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    notActions - Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNotActions
```
public AccessControlRule withNotActions(Collection<String> notActions)
```
    Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Parameters:
    
    notActions - Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserIds
```
public List<String> getUserIds()
```
    User IDs to include in the rule.
    
    Returns:
    
    User IDs to include in the rule.
  - setUserIds
```
public void setUserIds(Collection<String> userIds)
```
    User IDs to include in the rule.
    
    Parameters:
    
    userIds - User IDs to include in the rule.
  - withUserIds
```
public AccessControlRule withUserIds(String... userIds)
```
    User IDs to include in the rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setUserIds(java.util.Collection) or withUserIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    userIds - User IDs to include in the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUserIds
```
public AccessControlRule withUserIds(Collection<String> userIds)
```
    User IDs to include in the rule.
    
    Parameters:
    
    userIds - User IDs to include in the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNotUserIds
```
public List<String> getNotUserIds()
```
    User IDs to exclude from the rule.
    
    Returns:
    
    User IDs to exclude from the rule.
  - setNotUserIds
```
public void setNotUserIds(Collection<String> notUserIds)
```
    User IDs to exclude from the rule.
    
    Parameters:
    
    notUserIds - User IDs to exclude from the rule.
  - withNotUserIds
```
public AccessControlRule withNotUserIds(String... notUserIds)
```
    User IDs to exclude from the rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotUserIds(java.util.Collection) or withNotUserIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    notUserIds - User IDs to exclude from the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNotUserIds
```
public AccessControlRule withNotUserIds(Collection<String> notUserIds)
```
    User IDs to exclude from the rule.
    
    Parameters:
    
    notUserIds - User IDs to exclude from the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDateCreated
```
public void setDateCreated(Date dateCreated)
```
    The date that the rule was created.
    
    Parameters:
    
    dateCreated - The date that the rule was created.
  - getDateCreated
```
public Date getDateCreated()
```
    The date that the rule was created.
    
    Returns:
    
    The date that the rule was created.
  - withDateCreated
```
public AccessControlRule withDateCreated(Date dateCreated)
```
    The date that the rule was created.
    
    Parameters:
    
    dateCreated - The date that the rule was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDateModified
```
public void setDateModified(Date dateModified)
```
    The date that the rule was modified.
    
    Parameters:
    
    dateModified - The date that the rule was modified.
  - getDateModified
```
public Date getDateModified()
```
    The date that the rule was modified.
    
    Returns:
    
    The date that the rule was modified.
  - withDateModified
```
public AccessControlRule withDateModified(Date dateModified)
```
    The date that the rule was modified.
    
    Parameters:
    
    dateModified - The date that the rule was modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getImpersonationRoleIds
```
public List<String> getImpersonationRoleIds()
```
    Impersonation role IDs to include in the rule.
    
    Returns:
    
    Impersonation role IDs to include in the rule.
  - setImpersonationRoleIds
```
public void setImpersonationRoleIds(Collection<String> impersonationRoleIds)
```
    Impersonation role IDs to include in the rule.
    
    Parameters:
    
    impersonationRoleIds - Impersonation role IDs to include in the rule.
  - withImpersonationRoleIds
```
public AccessControlRule withImpersonationRoleIds(String... impersonationRoleIds)
```
    Impersonation role IDs to include in the rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setImpersonationRoleIds(java.util.Collection) or withImpersonationRoleIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    impersonationRoleIds - Impersonation role IDs to include in the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withImpersonationRoleIds
```
public AccessControlRule withImpersonationRoleIds(Collection<String> impersonationRoleIds)
```
    Impersonation role IDs to include in the rule.
    
    Parameters:
    
    impersonationRoleIds - Impersonation role IDs to include in the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNotImpersonationRoleIds
```
public List<String> getNotImpersonationRoleIds()
```
    Impersonation role IDs to exclude from the rule.
    
    Returns:
    
    Impersonation role IDs to exclude from the rule.
  - setNotImpersonationRoleIds
```
public void setNotImpersonationRoleIds(Collection<String> notImpersonationRoleIds)
```
    Impersonation role IDs to exclude from the rule.
    
    Parameters:
    
    notImpersonationRoleIds - Impersonation role IDs to exclude from the rule.
  - withNotImpersonationRoleIds
```
public AccessControlRule withNotImpersonationRoleIds(String... notImpersonationRoleIds)
```
    Impersonation role IDs to exclude from the rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotImpersonationRoleIds(java.util.Collection) or withNotImpersonationRoleIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    notImpersonationRoleIds - Impersonation role IDs to exclude from the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNotImpersonationRoleIds
```
public AccessControlRule withNotImpersonationRoleIds(Collection<String> notImpersonationRoleIds)
```
    Impersonation role IDs to exclude from the rule.
    
    Parameters:
    
    notImpersonationRoleIds - Impersonation role IDs to exclude from 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 AccessControlRule 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.792

Class AccessControlRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccessControlRule

Method Detail

setName

getName

withName

setEffect

getEffect

withEffect

withEffect

setDescription

getDescription

withDescription

getIpRanges

setIpRanges

withIpRanges

withIpRanges

getNotIpRanges

setNotIpRanges

withNotIpRanges

withNotIpRanges

getActions

setActions

withActions

withActions

getNotActions

setNotActions

withNotActions

withNotActions

getUserIds

setUserIds

withUserIds

withUserIds

getNotUserIds

setNotUserIds

withNotUserIds

withNotUserIds

setDateCreated

getDateCreated

withDateCreated

setDateModified

getDateModified

withDateModified

getImpersonationRoleIds

setImpersonationRoleIds

withImpersonationRoleIds

withImpersonationRoleIds

getNotImpersonationRoleIds

setNotImpersonationRoleIds

withNotImpersonationRoleIds

withNotImpersonationRoleIds

toString

equals

hashCode

clone

marshall