ingress_points

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

Overview

Name	ingress_points
Type	Resource
Id	aws.mailmanager.ingress_points

Fields

The following fields are returned by SELECT queries:

get_ingress_point

Name	Datatype	Description
a_record	string	The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.
created_timestamp	string (date-time)	The timestamp of when the ingress endpoint was created.
ingress_point_arn	string	The Amazon Resource Name (ARN) of the ingress endpoint resource.
ingress_point_auth_configuration	object	The authentication configuration of the ingress endpoint resource.
ingress_point_id	string	The identifier of an ingress endpoint resource.
ingress_point_name	string	A user friendly name for the ingress endpoint. (pattern: <code>[A-Za-z0-9_-]+</code>)
last_updated_timestamp	string (date-time)	The timestamp of when the ingress endpoint was last updated.
network_configuration	object	The network configuration for the ingress point.
rule_set_id	string	The identifier of a rule set resource associated with the ingress endpoint.
status	string	The status of the ingress endpoint resource. (PROVISIONING, DEPROVISIONING, UPDATING, ACTIVE, CLOSED, FAILED, ASSOCIATED_VPC_ENDPOINT_DOES_NOT_EXIST)
tls_policy	string	The selected Transport Layer Security (TLS) policy of the ingress point. (REQUIRED, OPTIONAL, FIPS)
traffic_policy_id	string	The identifier of the traffic policy resource associated with the ingress endpoint.
type	string	The type of ingress endpoint. (OPEN, AUTH, MTLS)

list_ingress_points

Name	Datatype	Description
a_record	string	The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.
ingress_point_id	string	The identifier of the ingress endpoint resource.
ingress_point_name	string	A user friendly name for the ingress endpoint resource. (pattern: <code>[A-Za-z0-9_-]+</code>)
status	string	The status of the ingress endpoint resource. (PROVISIONING, DEPROVISIONING, UPDATING, ACTIVE, CLOSED, FAILED, ASSOCIATED_VPC_ENDPOINT_DOES_NOT_EXIST)
type	string	The type of ingress endpoint resource. (OPEN, AUTH, MTLS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ingress_point	select	region		Fetch ingress endpoint resource attributes.
list_ingress_points	select	region		List all ingress endpoint resources.
create_ingress_point	insert	region, IngressPointName, RuleSetId, TrafficPolicyId		Provision a new ingress endpoint resource.
update_ingress_point	update	region, IngressPointId		Update attributes of a provisioned ingress endpoint resource.
delete_ingress_point	delete	region		Delete an ingress endpoint resource.

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_ingress_point

Fetch ingress endpoint resource attributes.

SELECT
a_record,
created_timestamp,
ingress_point_arn,
ingress_point_auth_configuration,
ingress_point_id,
ingress_point_name,
last_updated_timestamp,
network_configuration,
rule_set_id,
status,
tls_policy,
traffic_policy_id,
type
FROM aws.mailmanager.ingress_points
WHERE region = '{{ region }}' -- required
;

list_ingress_points

List all ingress endpoint resources.

SELECT
a_record,
ingress_point_id,
ingress_point_name,
status,
type
FROM aws.mailmanager.ingress_points
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_ingress_point

Provision a new ingress endpoint resource.

INSERT INTO aws.mailmanager.ingress_points (
ClientToken,
IngressPointName,
Type,
RuleSetId,
TrafficPolicyId,
IngressPointConfiguration,
NetworkConfiguration,
TlsPolicy,
Tags,
region
)
SELECT 
'{{ ClientToken }}',
'{{ IngressPointName }}' /* required */,
'{{ Type }}',
'{{ RuleSetId }}' /* required */,
'{{ TrafficPolicyId }}' /* required */,
'{{ IngressPointConfiguration }}',
'{{ NetworkConfiguration }}',
'{{ TlsPolicy }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
ingress_point_id
;

Manifest

# Description fields are for documentation purposes
- name: ingress_points
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ingress_points resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique token that Amazon SES uses to recognize subsequent retries of the same request.
  - name: IngressPointName
    value: "{{ IngressPointName }}"
    description: |
      A user friendly name for an ingress endpoint resource.
  - name: Type
    value: "{{ Type }}"
    description: |
      The type of the ingress endpoint to create.
    valid_values: ['OPEN', 'AUTH', 'MTLS']
  - name: RuleSetId
    value: "{{ RuleSetId }}"
    description: |
      The identifier of an existing rule set that you attach to an ingress endpoint resource.
  - name: TrafficPolicyId
    value: "{{ TrafficPolicyId }}"
    description: |
      The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
  - name: IngressPointConfiguration
    description: |
      If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
    value:
      SmtpPassword: "{{ SmtpPassword }}"
      SecretArn: "{{ SecretArn }}"
      TlsAuthConfiguration:
        TrustStore:
          CAContent: "{{ CAContent }}"
          CrlContent: "{{ CrlContent }}"
          KmsKeyArn: "{{ KmsKeyArn }}"
  - name: NetworkConfiguration
    description: |
      Specifies the network configuration for the ingress point. This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only.
    value:
      PublicNetworkConfiguration:
        IpType: "{{ IpType }}"
      PrivateNetworkConfiguration:
        VpcEndpointId: "{{ VpcEndpointId }}"
  - name: TlsPolicy
    value: "{{ TlsPolicy }}"
    description: |
      The Transport Layer Security (TLS) policy for the ingress point. The FIPS value is only valid in US and Canada regions.
    valid_values: ['REQUIRED', 'OPTIONAL', 'FIPS']
  - 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 }}"

UPDATE examples

update_ingress_point

Update attributes of a provisioned ingress endpoint resource.

UPDATE aws.mailmanager.ingress_points
SET 
IngressPointId = '{{ IngressPointId }}',
IngressPointName = '{{ IngressPointName }}',
StatusToUpdate = '{{ StatusToUpdate }}',
RuleSetId = '{{ RuleSetId }}',
TrafficPolicyId = '{{ TrafficPolicyId }}',
IngressPointConfiguration = '{{ IngressPointConfiguration }}',
TlsPolicy = '{{ TlsPolicy }}'
WHERE 
region = '{{ region }}' --required
AND IngressPointId = '{{ IngressPointId }}' --required;

DELETE examples

delete_ingress_point

Delete an ingress endpoint resource.

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