AccessControlRule
A rule that controls access to an WorkMail organization.
Contents
- Actions
-
Access protocol actions to include in the rule. Valid values include
ActiveSync,AutoDiscover,EWS,IMAP,SMTP,WindowsOutlook, andWebMail.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z]+Required: No
- DateCreated
-
The date that the rule was created.
Type: Timestamp
Required: No
- DateModified
-
The date that the rule was modified.
Type: Timestamp
Required: No
- Description
-
The rule description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
[\u0020-\u00FF]+Required: No
- Effect
-
The rule effect.
Type: String
Valid Values:
ALLOW | DENYRequired: No
- ImpersonationRoleIds
-
Impersonation role IDs to include in the rule.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: No
- IpRanges
-
IPv4 CIDR ranges to include in the rule.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1024 items.
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$Required: No
- Name
-
The rule name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: No
- NotActions
-
Access protocol actions to exclude from the rule. Valid values include
ActiveSync,AutoDiscover,EWS,IMAP,SMTP,WindowsOutlook, andWebMail.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z]+Required: No
- NotImpersonationRoleIds
-
Impersonation role IDs to exclude from the rule.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: No
- NotIpRanges
-
IPv4 CIDR ranges to exclude from the rule.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1024 items.
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$Required: No
- NotUserIds
-
User IDs to exclude from the rule.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 12. Maximum length of 256.
Required: No
- UserIds
-
User IDs to include in the rule.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 12. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
