endpoints

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

Overview

Name	endpoints
Type	Resource
Id	aws.events.endpoints

Fields

The following fields are returned by SELECT queries:

describe_endpoint

Name	Datatype	Description
arn	string	The ARN of the endpoint you asked for information about. (pattern: <code>^arn:aws([a-z]|-):events:([a-z]|\d|-):([0-9]{12})?:endpoint/[/.-_A-Za-z0-9]+$</code>)
creation_time	string (date-time)	The time the endpoint you asked for information about was created.
description	string	The description of the endpoint you asked for information about. (pattern: <code>.*</code>)
endpoint_id	string	The ID of the endpoint you asked for information about. (pattern: <code>^[A-Za-z0-9-]+[.][A-Za-z0-9-]+$</code>)
endpoint_url	string	The URL of the endpoint you asked for information about. (pattern: <code>^(https:​//)?[.-a-z0-9]+$</code>)
event_buses	array	The event buses being used by the endpoint you asked for information about.
last_modified_time	string (date-time)	The last time the endpoint you asked for information about was modified.
name	string	The name of the endpoint you asked for information about. (pattern: <code>[.-_A-Za-z0-9]+</code>)
replication_config	object	Whether replication is enabled or disabled for the endpoint you asked for information about.
role_arn	string	The ARN of the role used by the endpoint you asked for information about. (pattern: <code>^arn:aws[a-z-]*:iam::\d{12}:role/[\w+=,.@/-]+$</code>)
routing_config	object	The routing configuration of the endpoint you asked for information about.
state	string	The current state of the endpoint you asked for information about. (ACTIVE, CREATING, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED)
state_reason	string	The reason the endpoint you asked for information about is in its current state. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_endpoint	select	region		Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .
create_endpoint	insert	region, RoutingConfig, EventBuses		Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.
update_endpoint	update	region		Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .
delete_endpoint	delete	region		Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .
list_endpoints	exec	region		List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

describe_endpoint

Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

SELECT
arn,
creation_time,
description,
endpoint_id,
endpoint_url,
event_buses,
last_modified_time,
name,
replication_config,
role_arn,
routing_config,
state,
state_reason
FROM aws.events.endpoints
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_endpoint

Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.

INSERT INTO aws.events.endpoints (
Name,
Description,
RoutingConfig,
ReplicationConfig,
EventBuses,
RoleArn,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ RoutingConfig }}' /* required */,
'{{ ReplicationConfig }}',
'{{ EventBuses }}' /* required */,
'{{ RoleArn }}',
'{{ region }}'
RETURNING
arn,
event_buses,
name,
replication_config,
role_arn,
routing_config,
state
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the endpoints resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the global endpoint.
  - name: RoutingConfig
    description: |
      Configure the routing policy, including the health check and secondary Region..
    value:
      FailoverConfig:
        Primary:
          HealthCheck: "{{ HealthCheck }}"
        Secondary:
          Route: "{{ Route }}"
  - name: ReplicationConfig
    description: |
      Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.
    value:
      State: "{{ State }}"
  - name: EventBuses
    description: |
      Define the event buses used. The names of the event buses must be identical in each Region.
    value:
      - EventBusArn: "{{ EventBusArn }}"
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      The ARN of the role used for replication.

UPDATE examples

update_endpoint

Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

UPDATE aws.events.endpoints
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
RoutingConfig = '{{ RoutingConfig }}',
ReplicationConfig = '{{ ReplicationConfig }}',
EventBuses = '{{ EventBuses }}',
RoleArn = '{{ RoleArn }}'
WHERE 
region = '{{ region }}' --required
RETURNING
arn,
endpoint_id,
endpoint_url,
event_buses,
name,
replication_config,
role_arn,
routing_config,
state;

DELETE examples

delete_endpoint

Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

DELETE FROM aws.events.endpoints
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_endpoints

List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

EXEC aws.events.endpoints.list_endpoints 
@region='{{ region }}' --required 
@@json=
'{
"NamePrefix": "{{ NamePrefix }}", 
"HomeRegion": "{{ HomeRegion }}", 
"NextToken": "{{ NextToken }}", 
"MaxResults": {{ MaxResults }}
}'
;