addon_instances

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

Overview

Name	addon_instances
Type	Resource
Id	aws.mailmanager.addon_instances

Fields

The following fields are returned by SELECT queries:

get_addon_instance

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

list_addon_instances

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_addon_instance	select	region		Gets detailed information about an Add On instance.
list_addon_instances	select	region		Lists all Add On instances in your account.
create_addon_instance	insert	region, AddonSubscriptionId		Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.
delete_addon_instance	delete	region		Deletes an Add On instance.

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_instance

Gets detailed information about an Add On instance.

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

list_addon_instances

Lists all Add On instances in your account.

SELECT
addon_instance_arn,
addon_instance_id,
addon_name,
addon_subscription_id,
created_timestamp
FROM aws.mailmanager.addon_instances
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_addon_instance

Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.

INSERT INTO aws.mailmanager.addon_instances (
ClientToken,
AddonSubscriptionId,
Tags,
region
)
SELECT 
'{{ ClientToken }}',
'{{ AddonSubscriptionId }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
addon_instance_id
;

Manifest

# Description fields are for documentation purposes
- name: addon_instances
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the addon_instances resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique token that Amazon SES uses to recognize subsequent retries of the same request.
  - name: AddonSubscriptionId
    value: "{{ AddonSubscriptionId }}"
    description: |
      The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.
  - 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_instance

Deletes an Add On instance.

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