endpoints

Creates, updates, deletes or gets an endpoint resource or lists endpoints in a region

Overview

Name	endpoints
Type	Resource
Description	Resource Type definition for AWS::Events::Endpoint.
Id	aws.events.endpoints

Fields

Name	Datatype	Description
name	string
arn	string
role_arn	string
description	string
routing_config	object
replication_config	object
event_buses	array
endpoint_id	string
endpoint_url	string
state	string
state_reason	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RoutingConfig, EventBuses, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all endpoints in a region.

SELECT
region,
name,
arn,
role_arn,
description,
routing_config,
replication_config,
event_buses,
endpoint_id,
endpoint_url,
state,
state_reason
FROM aws.events.endpoints
WHERE region = 'us-east-1';

Gets all properties from an individual endpoint.

SELECT
region,
name,
arn,
role_arn,
description,
routing_config,
replication_config,
event_buses,
endpoint_id,
endpoint_url,
state,
state_reason
FROM aws.events.endpoints
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.events.endpoints (
 RoutingConfig,
 EventBuses,
 region
)
SELECT 
'{{ RoutingConfig }}',
 '{{ EventBuses }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.events.endpoints (
 Name,
 RoleArn,
 Description,
 RoutingConfig,
 ReplicationConfig,
 EventBuses,
 region
)
SELECT 
 '{{ Name }}',
 '{{ RoleArn }}',
 '{{ Description }}',
 '{{ RoutingConfig }}',
 '{{ ReplicationConfig }}',
 '{{ EventBuses }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: endpoint
    props:
      - name: Name
        value: '{{ Name }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Description
        value: '{{ Description }}'
      - name: RoutingConfig
        value:
          FailoverConfig:
            Primary:
              HealthCheck: '{{ HealthCheck }}'
            Secondary:
              Route: '{{ Route }}'
      - name: ReplicationConfig
        value:
          State: '{{ State }}'
      - name: EventBuses
        value:
          - EventBusArn: '{{ EventBusArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.events.endpoints
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the endpoints resource, the following permissions are required:

Create

events:CreateEndpoint,
events:DescribeEndpoint,
route53:GetHealthCheck,
iam:PassRole

Read

events:DescribeEndpoint

Update

events:DescribeEndpoint,
events:UpdateEndpoint,
route53:GetHealthCheck,
iam:PassRole

Delete

events:DeleteEndpoint,
events:DescribeEndpoint

List

events:ListEndpoints