mail_manager_addon_instances

Creates, updates, deletes or gets a mail_manager_addon_instance resource or lists mail_manager_addon_instances in a region

Overview

Name	mail_manager_addon_instances
Type	Resource
Description	Definition of AWS::SES::MailManagerAddonInstance Resource Type
Id	awscc.ses.mail_manager_addon_instances

Fields

get (all properties)

Name	Datatype	Description
addon_instance_arn	string
addon_instance_id	string
addon_name	string
addon_subscription_id	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
addon_instance_id	string
region	string	AWS region.

For more information, see AWS::SES::MailManagerAddonInstance.

Methods

Name	Resource	Accessible by	Required Params
create_resource	mail_manager_addon_instances	INSERT	AddonSubscriptionId, region
delete_resource	mail_manager_addon_instances	DELETE	Identifier, region
update_resource	mail_manager_addon_instances	UPDATE	Identifier, PatchDocument, region
list_resources	mail_manager_addon_instances_list_only	SELECT	region
get_resource	mail_manager_addon_instances	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual mail_manager_addon_instance.

SELECT
  region,
  addon_instance_arn,
  addon_instance_id,
  addon_name,
  addon_subscription_id,
  tags
FROM awscc.ses.mail_manager_addon_instances
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ addon_instance_id }}';

list (identifiers only)

Lists all mail_manager_addon_instances in a region.

SELECT
  region,
  addon_instance_id
FROM awscc.ses.mail_manager_addon_instances_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new mail_manager_addon_instance resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ses.mail_manager_addon_instances (
  AddonSubscriptionId,
  region
)
SELECT
  '{{ addon_subscription_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ses.mail_manager_addon_instances (
  AddonSubscriptionId,
  Tags,
  region
)
SELECT
  '{{ addon_subscription_id }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: mail_manager_addon_instance
  props:
    - name: addon_subscription_id
      value: '{{ addon_subscription_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a mail_manager_addon_instance resource, using stack-deploy.

/*+ update */
UPDATE awscc.ses.mail_manager_addon_instances
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ addon_instance_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ses.mail_manager_addon_instances
WHERE
  Identifier = '{{ addon_instance_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the mail_manager_addon_instances resource, the following permissions are required:

Create

ses:TagResource,
ses:ListTagsForResource,
ses:GetAddonInstance,
ses:CreateAddonInstance

Read

ses:ListTagsForResource,
ses:GetAddonInstance

Update

ses:TagResource,
ses:UntagResource,
ses:ListTagsForResource,
ses:GetAddonInstance

Delete

ses:GetAddonInstance,
ses:DeleteAddonInstance

List

ses:ListAddonInstances