mail_manager_relays

Creates, updates, deletes or gets a mail_manager_relay resource or lists mail_manager_relays in a region

Overview

Name	mail_manager_relays
Type	Resource
Description	Definition of AWS::SES::MailManagerRelay Resource Type
Id	aws.ses.mail_manager_relays

Fields

Name	Datatype	Description
authentication	undefined
relay_arn	string
relay_id	string
relay_name	string
server_name	string
server_port	number
tags	array
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Authentication, ServerName, ServerPort, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all mail_manager_relays in a region.

SELECT
region,
authentication,
relay_arn,
relay_id,
relay_name,
server_name,
server_port,
tags
FROM aws.ses.mail_manager_relays
WHERE region = 'us-east-1';

Gets all properties from an individual mail_manager_relay.

SELECT
region,
authentication,
relay_arn,
relay_id,
relay_name,
server_name,
server_port,
tags
FROM aws.ses.mail_manager_relays
WHERE region = 'us-east-1' AND data__Identifier = '<RelayId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ses.mail_manager_relays (
 Authentication,
 ServerName,
 ServerPort,
 region
)
SELECT 
'{{ Authentication }}',
 '{{ ServerName }}',
 '{{ ServerPort }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ses.mail_manager_relays (
 Authentication,
 RelayName,
 ServerName,
 ServerPort,
 Tags,
 region
)
SELECT 
 '{{ Authentication }}',
 '{{ RelayName }}',
 '{{ ServerName }}',
 '{{ ServerPort }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: mail_manager_relay
    props:
      - name: Authentication
        value: null
      - name: RelayName
        value: '{{ RelayName }}'
      - name: ServerName
        value: '{{ ServerName }}'
      - name: ServerPort
        value: null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.ses.mail_manager_relays
WHERE data__Identifier = '<RelayId>'
AND region = 'us-east-1';

Permissions

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

Create

ses:TagResource,
ses:ListTagsForResource,
ses:GetRelay,
ses:CreateRelay

Read

ses:ListTagsForResource,
ses:GetRelay

Update

ses:TagResource,
ses:UntagResource,
ses:ListTagsForResource,
ses:GetRelay,
ses:UpdateRelay

Delete

ses:GetRelay,
ses:DeleteRelay

List

ses:ListRelays