AWS Fundamentals Logo
AWS Fundamentals
AWS::Events::ApiDestination

Events ApiDestination

Resource Type definition for AWS::Events::ApiDestination.

Properties

6 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
ConnectionArn
string
Required
HttpMethod
string
Required
InvocationEndpoint
string
Required
Description
string
InvocationRateLimitPerSecond
integer
Name
string
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ArnstringThe arn of the api destination.
ArnForPolicystringThe arn of the api destination to be used in IAM policies.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Events::ApiDestination

Resources:
  MyResource:
    Type: AWS::Events::ApiDestination
    Properties:
      ConnectionArn: "arn:aws:service:region:account:resource"
      InvocationEndpoint: "value"
      HttpMethod: "GET"
      Description: !Ref "AWS::StackName"
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

events:CreateApiDestinationevents:DescribeApiDestination

read

events:DescribeApiDestination

update

events:UpdateApiDestinationevents:DescribeApiDestination

delete

events:DeleteApiDestinationevents:DescribeApiDestination

list

events:ListApiDestinations

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceEvents
Properties8
Required3
TaggingNot supported
Primary IDName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

Name

Related Resources

External Links