multi_region_endpoints

Creates, updates, deletes, gets or lists a multi_region_endpoints resource.

Overview

Name	multi_region_endpoints
Type	Resource
Id	aws.sesv2.multi_region_endpoints

Fields

The following fields are returned by SELECT queries:

get_multi_region_endpoint

Name	Datatype	Description
created_timestamp	string (date-time)	The time stamp of when the multi-region endpoint (global-endpoint) was created.
endpoint_id	string	The ID of the multi-region endpoint (global-endpoint).
endpoint_name	string	The name of the multi-region endpoint (global-endpoint). (pattern: <code>^[\w-_]+$</code>)
last_updated_timestamp	string (date-time)	The time stamp of when the multi-region endpoint (global-endpoint) was last updated.
routes	array	Contains routes information for the multi-region endpoint (global-endpoint).
status	string	The status of the multi-region endpoint (global-endpoint). CREATING – The resource is being provisioned. READY – The resource is ready to use. FAILED – The resource failed to be provisioned. DELETING – The resource is being deleted as requested. (CREATING, READY, FAILED, DELETING)

list_multi_region_endpoints

Name	Datatype	Description
created_timestamp	string (date-time)	The time stamp of when the multi-region endpoint (global-endpoint) was created.
endpoint_id	string	The ID of the multi-region endpoint (global-endpoint).
endpoint_name	string	The name of the multi-region endpoint (global-endpoint). (pattern: <code>^[\w-_]+$</code>)
last_updated_timestamp	string (date-time)	The time stamp of when the multi-region endpoint (global-endpoint) was last updated.
regions	array	Primary and secondary regions between which multi-region endpoint splits sending traffic.
status	string	The status of the multi-region endpoint (global-endpoint). CREATING – The resource is being provisioned. READY – The resource is ready to use. FAILED – The resource failed to be provisioned. DELETING – The resource is being deleted as requested. (CREATING, READY, FAILED, DELETING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_multi_region_endpoint	select	endpoint_name, region		Displays the multi-region endpoint (global-endpoint) configuration. Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be displayed.
list_multi_region_endpoints	select	region	NextToken, PageSize	List the multi-region endpoints (global-endpoints). Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed will be listed.
create_multi_region_endpoint	insert	region, EndpointName, Details		Creates a multi-region endpoint (global-endpoint). The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request's parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic is divided between the two. The primary region is the region where the resource has been created and where it can be managed.
delete_multi_region_endpoint	delete	endpoint_name, region		Deletes a multi-region endpoint (global-endpoint). Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be deleted.

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
endpoint_name	string	The name of the multi-region endpoint (global-endpoint) to be deleted.
region	string	AWS region (default: us-east-1)
NextToken	string	A token returned from a previous call to ListMultiRegionEndpoints to indicate the position in the list of multi-region endpoints (global-endpoints).
PageSize	integer	The number of results to show in a single call to ListMultiRegionEndpoints. If the number of results is larger than the number you specified in this parameter, the response includes a NextToken element that you can use to retrieve the next page of results.

SELECT examples

get_multi_region_endpoint

Displays the multi-region endpoint (global-endpoint) configuration. Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be displayed.

SELECT
created_timestamp,
endpoint_id,
endpoint_name,
last_updated_timestamp,
routes,
status
FROM aws.sesv2.multi_region_endpoints
WHERE endpoint_name = '{{ endpoint_name }}' -- required
AND region = '{{ region }}' -- required
;

list_multi_region_endpoints

List the multi-region endpoints (global-endpoints). Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed will be listed.

SELECT
created_timestamp,
endpoint_id,
endpoint_name,
last_updated_timestamp,
regions,
status
FROM aws.sesv2.multi_region_endpoints
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

INSERT examples

create_multi_region_endpoint

Creates a multi-region endpoint (global-endpoint). The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request's parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic is divided between the two. The primary region is the region where the resource has been created and where it can be managed.

INSERT INTO aws.sesv2.multi_region_endpoints (
EndpointName,
Details,
Tags,
region
)
SELECT 
'{{ EndpointName }}' /* required */,
'{{ Details }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
endpoint_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: multi_region_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the multi_region_endpoints resource.
  - name: EndpointName
    value: "{{ EndpointName }}"
    description: |
      The name of the multi-region endpoint (global-endpoint).
  - name: Details
    description: |
      An object that contains configuration details of multi-region endpoint (global-endpoint).
    value:
      RoutesDetails:
        - Region: "{{ Region }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_multi_region_endpoint

Deletes a multi-region endpoint (global-endpoint). Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be deleted.

DELETE FROM aws.sesv2.multi_region_endpoints
WHERE endpoint_name = '{{ endpoint_name }}' --required
AND region = '{{ region }}' --required
;