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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

Overview

Note:

When making an API call, you may pass PutAccessControlRuleRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<String>

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

Returns:

  • (Array<String>)


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 3328

class PutAccessControlRuleRequest < Struct.new(
  :name,
  :effect,
  :description,
  :ip_ranges,
  :not_ip_ranges,
  :actions,
  :not_actions,
  :user_ids,
  :not_user_ids,
  :organization_id)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The rule description.

Returns:

  • (String)


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 3328

class PutAccessControlRuleRequest < Struct.new(
  :name,
  :effect,
  :description,
  :ip_ranges,
  :not_ip_ranges,
  :actions,
  :not_actions,
  :user_ids,
  :not_user_ids,
  :organization_id)
  SENSITIVE = []
  include Aws::Structure
end

#effectString

The rule effect.

Returns:

  • (String)


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 3328

class PutAccessControlRuleRequest < Struct.new(
  :name,
  :effect,
  :description,
  :ip_ranges,
  :not_ip_ranges,
  :actions,
  :not_actions,
  :user_ids,
  :not_user_ids,
  :organization_id)
  SENSITIVE = []
  include Aws::Structure
end

#ip_rangesArray<String>

IPv4 CIDR ranges to include in the rule.

Returns:

  • (Array<String>)


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 3328

class PutAccessControlRuleRequest < Struct.new(
  :name,
  :effect,
  :description,
  :ip_ranges,
  :not_ip_ranges,
  :actions,
  :not_actions,
  :user_ids,
  :not_user_ids,
  :organization_id)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The rule name.

Returns:

  • (String)


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 3328

class PutAccessControlRuleRequest < Struct.new(
  :name,
  :effect,
  :description,
  :ip_ranges,
  :not_ip_ranges,
  :actions,
  :not_actions,
  :user_ids,
  :not_user_ids,
  :organization_id)
  SENSITIVE = []
  include Aws::Structure
end

#not_actionsArray<String>

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

Returns:

  • (Array<String>)


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 3328

class PutAccessControlRuleRequest < Struct.new(
  :name,
  :effect,
  :description,
  :ip_ranges,
  :not_ip_ranges,
  :actions,
  :not_actions,
  :user_ids,
  :not_user_ids,
  :organization_id)
  SENSITIVE = []
  include Aws::Structure
end

#not_ip_rangesArray<String>

IPv4 CIDR ranges to exclude from the rule.

Returns:

  • (Array<String>)


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 3328

class PutAccessControlRuleRequest < Struct.new(
  :name,
  :effect,
  :description,
  :ip_ranges,
  :not_ip_ranges,
  :actions,
  :not_actions,
  :user_ids,
  :not_user_ids,
  :organization_id)
  SENSITIVE = []
  include Aws::Structure
end

#not_user_idsArray<String>

User IDs to exclude from the rule.

Returns:

  • (Array<String>)


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 3328

class PutAccessControlRuleRequest < Struct.new(
  :name,
  :effect,
  :description,
  :ip_ranges,
  :not_ip_ranges,
  :actions,
  :not_actions,
  :user_ids,
  :not_user_ids,
  :organization_id)
  SENSITIVE = []
  include Aws::Structure
end

#organization_idString

The identifier of the organization.

Returns:

  • (String)


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 3328

class PutAccessControlRuleRequest < Struct.new(
  :name,
  :effect,
  :description,
  :ip_ranges,
  :not_ip_ranges,
  :actions,
  :not_actions,
  :user_ids,
  :not_user_ids,
  :organization_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_idsArray<String>

User IDs to include in the rule.

Returns:

  • (Array<String>)


3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 3328

class PutAccessControlRuleRequest < Struct.new(
  :name,
  :effect,
  :description,
  :ip_ranges,
  :not_ip_ranges,
  :actions,
  :not_actions,
  :user_ids,
  :not_user_ids,
  :organization_id)
  SENSITIVE = []
  include Aws::Structure
end