addon_subscriptions

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

Overview

Name	addon_subscriptions
Type	Resource
Id	aws.mailmanager.addon_subscriptions

Fields

The following fields are returned by SELECT queries:

get_addon_subscription

Name	Datatype	Description
addon_name	string	The name of the Add On for the subscription.
addon_subscription_arn	string	Amazon Resource Name (ARN) for the subscription.
created_timestamp	string (date-time)	The timestamp of when the Add On subscription was created.

list_addon_subscriptions

Name	Datatype	Description
addon_name	string	The name of the Add On.
addon_subscription_arn	string	The Amazon Resource Name (ARN) of the Add On subscription.
addon_subscription_id	string	The unique ID of the Add On subscription. (pattern: <code>as-[a-zA-Z0-9]{1,64}</code>)
created_timestamp	string (date-time)	The timestamp of when the Add On subscription was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_addon_subscription	select	region		Gets detailed information about an Add On subscription.
list_addon_subscriptions	select	region		Lists all Add On subscriptions in your account.
create_addon_subscription	insert	region, AddonName		Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.
delete_addon_subscription	delete	region		Deletes an Add On subscription.

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_addon_subscription

Gets detailed information about an Add On subscription.

SELECT
addon_name,
addon_subscription_arn,
created_timestamp
FROM aws.mailmanager.addon_subscriptions
WHERE region = '{{ region }}' -- required
;

list_addon_subscriptions

Lists all Add On subscriptions in your account.

SELECT
addon_name,
addon_subscription_arn,
addon_subscription_id,
created_timestamp
FROM aws.mailmanager.addon_subscriptions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_addon_subscription

Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.

INSERT INTO aws.mailmanager.addon_subscriptions (
ClientToken,
AddonName,
Tags,
region
)
SELECT 
'{{ ClientToken }}',
'{{ AddonName }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
addon_subscription_id
;

Manifest

# Description fields are for documentation purposes
- name: addon_subscriptions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the addon_subscriptions resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique token that Amazon SES uses to recognize subsequent retries of the same request.
  - name: AddonName
    value: "{{ AddonName }}"
    description: |
      The name of the Add On to subscribe to. You can only have one subscription for each Add On name.
  - 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 }}"

DELETE examples

delete_addon_subscription

Deletes an Add On subscription.

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