access_control_rules

Creates, updates, deletes, gets or lists an access_control_rules resource.

Overview

Name	access_control_rules
Type	Resource
Id	aws.workmail.access_control_rules

Fields

The following fields are returned by SELECT queries:

list_access_control_rules

Name	Datatype	Description
rules	array	The access control rules.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_access_control_rules	select	region		Lists the access control rules for the specified organization.
put_access_control_rule	replace	region, Name, Effect, Description, OrganizationId		Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
delete_access_control_rule	delete	region		Deletes an access control rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_access_control_rules

Lists the access control rules for the specified organization.

SELECT
rules
FROM aws.workmail.access_control_rules
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_access_control_rule

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

REPLACE aws.workmail.access_control_rules
SET 
Name = '{{ Name }}',
Effect = '{{ Effect }}',
Description = '{{ Description }}',
IpRanges = '{{ IpRanges }}',
NotIpRanges = '{{ NotIpRanges }}',
Actions = '{{ Actions }}',
NotActions = '{{ NotActions }}',
UserIds = '{{ UserIds }}',
NotUserIds = '{{ NotUserIds }}',
OrganizationId = '{{ OrganizationId }}',
ImpersonationRoleIds = '{{ ImpersonationRoleIds }}',
NotImpersonationRoleIds = '{{ NotImpersonationRoleIds }}'
WHERE 
region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
AND Effect = '{{ Effect }}' --required
AND Description = '{{ Description }}' --required
AND OrganizationId = '{{ OrganizationId }}' --required;

DELETE examples

delete_access_control_rule

Deletes an access control rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

DELETE FROM aws.workmail.access_control_rules
WHERE region = '{{ region }}' --required
;