rule_sets

Creates, updates, deletes, gets or lists a rule_sets resource.

Overview

Name	rule_sets
Type	Resource
Id	aws.mailmanager.rule_sets

Fields

The following fields are returned by SELECT queries:

get_rule_set

Name	Datatype	Description
created_date	string (date-time)	The date of when then rule set was created.
last_modification_date	string (date-time)	The date of when the rule set was last modified.
rule_set_arn	string	The Amazon Resource Name (ARN) of the rule set resource.
rule_set_id	string	The identifier of the rule set resource.
rule_set_name	string	A user-friendly name for the rule set resource. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
rules	array	The rules contained in the rule set.

list_rule_sets

Name	Datatype	Description
last_modification_date	string (date-time)	The last modification date of the rule set.
rule_set_id	string	The identifier of the rule set.
rule_set_name	string	A user-friendly name for the rule set. (pattern: <code>[a-zA-Z0-9_.-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_rule_set	select	region		Fetch attributes of a rule set.
list_rule_sets	select	region		List rule sets for this account.
create_rule_set	insert	region, RuleSetName		Provision a new rule set.
update_rule_set	update	region, RuleSetId		Update attributes of an already provisioned rule set.
delete_rule_set	delete	region		Delete a rule set.

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

get_rule_set

Fetch attributes of a rule set.

SELECT
created_date,
last_modification_date,
rule_set_arn,
rule_set_id,
rule_set_name,
rules
FROM aws.mailmanager.rule_sets
WHERE region = '{{ region }}' -- required
;

list_rule_sets

List rule sets for this account.

SELECT
last_modification_date,
rule_set_id,
rule_set_name
FROM aws.mailmanager.rule_sets
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_rule_set

Provision a new rule set.

INSERT INTO aws.mailmanager.rule_sets (
ClientToken,
RuleSetName,
Rules,
Tags,
region
)
SELECT 
'{{ ClientToken }}',
'{{ RuleSetName }}' /* required */,
'{{ Rules }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
rule_set_id
;

Manifest

# Description fields are for documentation purposes
- name: rule_sets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the rule_sets resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique token that Amazon SES uses to recognize subsequent retries of the same request.
  - name: RuleSetName
    value: "{{ RuleSetName }}"
    description: |
      A user-friendly name for the rule set.
  - name: Rules
    description: |
      Conditional rules that are evaluated for determining actions on email.
    value:
      - Name: "{{ Name }}"
        Conditions: "{{ Conditions }}"
        Unless: "{{ Unless }}"
        Actions: "{{ Actions }}"
  - name: Tags
    description: |
      The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_rule_set

Update attributes of an already provisioned rule set.

UPDATE aws.mailmanager.rule_sets
SET 
RuleSetId = '{{ RuleSetId }}',
RuleSetName = '{{ RuleSetName }}',
Rules = '{{ Rules }}'
WHERE 
region = '{{ region }}' --required
AND RuleSetId = '{{ RuleSetId }}' --required;

DELETE examples

delete_rule_set

Delete a rule set.

DELETE FROM aws.mailmanager.rule_sets
WHERE region = '{{ region }}' --required
;