api_destinations

Creates, updates, deletes or gets an api_destination resource or lists api_destinations in a region

Overview

Name	api_destinations
Type	Resource
Description	Resource Type definition for AWS::Events::ApiDestination.
Id	awscc.events.api_destinations

Fields

get (all properties)

Name	Datatype	Description
name	string	Name of the apiDestination.
description	string
connection_arn	string	The arn of the connection.
arn	string	The arn of the api destination.
arn_for_policy	string	The arn of the api destination to be used in IAM policies.
invocation_rate_limit_per_second	integer
invocation_endpoint	string	Url endpoint to invoke.
http_method	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	Name of the apiDestination.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	api_destinations	INSERT	ConnectionArn, InvocationEndpoint, HttpMethod, region
delete_resource	api_destinations	DELETE	Identifier, region
update_resource	api_destinations	UPDATE	Identifier, PatchDocument, region
list_resources	api_destinations_list_only	SELECT	region
get_resource	api_destinations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual api_destination.

SELECT
  region,
  name,
  description,
  connection_arn,
  arn,
  arn_for_policy,
  invocation_rate_limit_per_second,
  invocation_endpoint,
  http_method
FROM awscc.events.api_destinations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all api_destinations in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.events.api_destinations (
  ConnectionArn,
  InvocationEndpoint,
  HttpMethod,
  region
)
SELECT
  '{{ connection_arn }}',
  '{{ invocation_endpoint }}',
  '{{ http_method }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.events.api_destinations (
  Name,
  Description,
  ConnectionArn,
  InvocationRateLimitPerSecond,
  InvocationEndpoint,
  HttpMethod,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ connection_arn }}',
  '{{ invocation_rate_limit_per_second }}',
  '{{ invocation_endpoint }}',
  '{{ http_method }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: api_destination
    props:
      - name: name
        value: '{{ name }}'
      - name: description
        value: '{{ description }}'
      - name: connection_arn
        value: '{{ connection_arn }}'
      - name: invocation_rate_limit_per_second
        value: '{{ invocation_rate_limit_per_second }}'
      - name: invocation_endpoint
        value: '{{ invocation_endpoint }}'
      - name: http_method
        value: '{{ http_method }}'

UPDATE example

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

/*+ update */
UPDATE awscc.events.api_destinations
SET PatchDocument = string('{{ {
    "Description": description,
    "ConnectionArn": connection_arn,
    "InvocationRateLimitPerSecond": invocation_rate_limit_per_second,
    "InvocationEndpoint": invocation_endpoint,
    "HttpMethod": http_method
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.events.api_destinations
WHERE
  Identifier = '{{ name }}' AND
  region = 'us-east-1';

Permissions

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

Create

events:CreateApiDestination,
events:DescribeApiDestination

Read

events:DescribeApiDestination

Update

events:UpdateApiDestination,
events:DescribeApiDestination

Delete

events:DeleteApiDestination,
events:DescribeApiDestination

List

events:ListApiDestinations