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	awscc.events.endpoints

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string
region	string	AWS region.

For more information, see AWS::Events::Endpoint.

Methods

Name	Resource	Accessible by	Required Params
create_resource	endpoints	INSERT	RoutingConfig, EventBuses, region
delete_resource	endpoints	DELETE	Identifier, region
update_resource	endpoints	UPDATE	Identifier, PatchDocument, region
list_resources	endpoints_list_only	SELECT	region
get_resource	endpoints	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.events.endpoints
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all endpoints in a region.

SELECT
  region,
  name
FROM awscc.events.endpoints_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.events.endpoints (
  Name,
  RoleArn,
  Description,
  RoutingConfig,
  ReplicationConfig,
  EventBuses,
  region
)
SELECT
  '{{ name }}',
  '{{ role_arn }}',
  '{{ description }}',
  '{{ routing_config }}',
  '{{ replication_config }}',
  '{{ event_buses }}',
  '{{ 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: role_arn
        value: '{{ role_arn }}'
      - name: description
        value: '{{ description }}'
      - name: routing_config
        value:
          failover_config:
            primary:
              health_check: '{{ health_check }}'
            secondary:
              route: '{{ route }}'
      - name: replication_config
        value:
          state: '{{ state }}'
      - name: event_buses
        value:
          - event_bus_arn: '{{ event_bus_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.events.endpoints
SET PatchDocument = string('{{ {
    "RoleArn": role_arn,
    "Description": description,
    "RoutingConfig": routing_config,
    "ReplicationConfig": replication_config,
    "EventBuses": event_buses
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.events.endpoints
WHERE
  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