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 = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all endpoints in a region.

SELECT
  region,
  name
FROM awscc.events.endpoints_list_only
WHERE
  region = '{{ region }}';

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.events.endpoints
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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