You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkMail::Types::PutAccessControlRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutAccessControlRuleRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "AccessControlRuleName", # required
  effect: "ALLOW", # required, accepts ALLOW, DENY
  description: "AccessControlRuleDescription", # required
  ip_ranges: ["IpRange"],
  not_ip_ranges: ["IpRange"],
  actions: ["AccessControlRuleAction"],
  not_actions: ["AccessControlRuleAction"],
  user_ids: ["WorkMailIdentifier"],
  not_user_ids: ["WorkMailIdentifier"],
  organization_id: "OrganizationId", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ Array<String>

Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

Returns:

  • (Array<String>) —

    Access protocol actions to include in the rule.

#description ⇒ String

The rule description.

Returns:

  • (String) —

    The rule description.

#effect ⇒ String

The rule effect.

Possible values:

  • ALLOW
  • DENY

Returns:

  • (String) —

    The rule effect.

#ip_ranges ⇒ Array<String>

IPv4 CIDR ranges to include in the rule.

Returns:

  • (Array<String>) —

    IPv4 CIDR ranges to include in the rule.

#name ⇒ String

The rule name.

Returns:

  • (String) —

    The rule name.

#not_actions ⇒ Array<String>

Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

Returns:

  • (Array<String>) —

    Access protocol actions to exclude from the rule.

#not_ip_ranges ⇒ Array<String>

IPv4 CIDR ranges to exclude from the rule.

Returns:

  • (Array<String>) —

    IPv4 CIDR ranges to exclude from the rule.

#not_user_ids ⇒ Array<String>

User IDs to exclude from the rule.

Returns:

  • (Array<String>) —

    User IDs to exclude from the rule.

#organization_id ⇒ String

The identifier of the organization.

Returns:

  • (String) —

    The identifier of the organization.

#user_ids ⇒ Array<String>

User IDs to include in the rule.

Returns:

  • (Array<String>) —

    User IDs to include in the rule.