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	awscc.ses.mail_manager_relays

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
relay_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	mail_manager_relays	INSERT	Authentication, ServerName, ServerPort, region
delete_resource	mail_manager_relays	DELETE	Identifier, region
update_resource	mail_manager_relays	UPDATE	Identifier, PatchDocument, region
list_resources	mail_manager_relays_list_only	SELECT	region
get_resource	mail_manager_relays	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual mail_manager_relay.

SELECT
  region,
  authentication,
  relay_arn,
  relay_id,
  relay_name,
  server_name,
  server_port,
  tags
FROM awscc.ses.mail_manager_relays
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ relay_id }}';

list (identifiers only)

Lists all mail_manager_relays in a region.

SELECT
  region,
  relay_id
FROM awscc.ses.mail_manager_relays_list_only
WHERE
  region = '{{ region }}';

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 awscc.ses.mail_manager_relays (
  Authentication,
  ServerName,
  ServerPort,
  region
)
SELECT
  '{{ authentication }}',
  '{{ server_name }}',
  '{{ server_port }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ses.mail_manager_relays (
  Authentication,
  RelayName,
  ServerName,
  ServerPort,
  Tags,
  region
)
SELECT
  '{{ authentication }}',
  '{{ relay_name }}',
  '{{ server_name }}',
  '{{ server_port }}',
  '{{ 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_relay
  props:
    - name: authentication
      value: null
    - name: relay_name
      value: '{{ relay_name }}'
    - name: server_name
      value: '{{ server_name }}'
    - name: server_port
      value: null
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ses.mail_manager_relays
SET PatchDocument = string('{{ {
    "Authentication": authentication,
    "RelayName": relay_name,
    "ServerName": server_name,
    "ServerPort": server_port,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ relay_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ses.mail_manager_relays
WHERE
  Identifier = '{{ relay_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_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