mail_manager_ingress_points

Creates, updates, deletes or gets a mail_manager_ingress_point resource or lists mail_manager_ingress_points in a region

Overview

Name	mail_manager_ingress_points
Type	Resource
Description	Definition of AWS::SES::MailManagerIngressPoint Resource Type
Id	awscc.ses.mail_manager_ingress_points

Fields

get (all properties)

Name	Datatype	Description
a_record	string
traffic_policy_id	string
ingress_point_configuration	object
ingress_point_arn	string
ingress_point_id	string
ingress_point_name	string
network_configuration	object
rule_set_id	string
status	string
status_to_update	string
▶tags	array
type	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
ingress_point_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	mail_manager_ingress_points	INSERT	Type, TrafficPolicyId, RuleSetId, region
delete_resource	mail_manager_ingress_points	DELETE	Identifier, region
update_resource	mail_manager_ingress_points	UPDATE	Identifier, PatchDocument, region
list_resources	mail_manager_ingress_points_list_only	SELECT	region
get_resource	mail_manager_ingress_points	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual mail_manager_ingress_point.

SELECT
  region,
  a_record,
  traffic_policy_id,
  ingress_point_configuration,
  ingress_point_arn,
  ingress_point_id,
  ingress_point_name,
  network_configuration,
  rule_set_id,
  status,
  status_to_update,
  tags,
  type
FROM awscc.ses.mail_manager_ingress_points
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ ingress_point_id }}';

list (identifiers only)

Lists all mail_manager_ingress_points in a region.

SELECT
  region,
  ingress_point_id
FROM awscc.ses.mail_manager_ingress_points_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ses.mail_manager_ingress_points (
  TrafficPolicyId,
  RuleSetId,
  Type,
  region
)
SELECT
  '{{ traffic_policy_id }}',
  '{{ rule_set_id }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ses.mail_manager_ingress_points (
  TrafficPolicyId,
  IngressPointConfiguration,
  IngressPointName,
  NetworkConfiguration,
  RuleSetId,
  StatusToUpdate,
  Tags,
  Type,
  region
)
SELECT
  '{{ traffic_policy_id }}',
  '{{ ingress_point_configuration }}',
  '{{ ingress_point_name }}',
  '{{ network_configuration }}',
  '{{ rule_set_id }}',
  '{{ status_to_update }}',
  '{{ tags }}',
  '{{ type }}',
  '{{ 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_ingress_point
  props:
    - name: traffic_policy_id
      value: '{{ traffic_policy_id }}'
    - name: ingress_point_configuration
      value: null
    - name: ingress_point_name
      value: '{{ ingress_point_name }}'
    - name: network_configuration
      value: null
    - name: rule_set_id
      value: '{{ rule_set_id }}'
    - name: status_to_update
      value: '{{ status_to_update }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: type
      value: '{{ type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ses.mail_manager_ingress_points
SET PatchDocument = string('{{ {
    "TrafficPolicyId": traffic_policy_id,
    "IngressPointConfiguration": ingress_point_configuration,
    "IngressPointName": ingress_point_name,
    "RuleSetId": rule_set_id,
    "StatusToUpdate": status_to_update,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ ingress_point_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ses.mail_manager_ingress_points
WHERE
  Identifier = '{{ ingress_point_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_ingress_points resource, the following permissions are required:

Create

ses:TagResource,
ses:ListTagsForResource,
ses:GetIngressPoint,
ses:CreateIngressPoint,
iam:CreateServiceLinkedRole,
ec2:DescribeVpcEndpoints

Read

ses:ListTagsForResource,
ses:GetIngressPoint

Update

ses:TagResource,
ses:UntagResource,
ses:ListTagsForResource,
ses:GetIngressPoint,
ses:UpdateIngressPoint

Delete

ses:GetIngressPoint,
ses:DeleteIngressPoint

List

ses:ListIngressPoints