Skip to content

Create Api Destination

eventbridge_create_api_destination R Documentation

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events

Description

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

API destinations do not support private destinations, such as interface VPC endpoints.

For more information, see API destinations in the EventBridge User Guide.

Usage

eventbridge_create_api_destination(Name, Description, ConnectionArn,
  InvocationEndpoint, HttpMethod, InvocationRateLimitPerSecond)

Arguments

Name

[required] The name for the API destination to create.

Description

A description for the API destination to create.

ConnectionArn

[required] The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

InvocationEndpoint

[required] The URL to the HTTP invocation endpoint for the API destination.

HttpMethod

[required] The method to use for the request to the HTTP invocation endpoint.

InvocationRateLimitPerSecond

The maximum number of requests per second to send to the HTTP invocation endpoint.

Value

A list with the following syntax: 

list(
  ApiDestinationArn = "string",
  ApiDestinationState = "ACTIVE"|"INACTIVE",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_api_destination(
  Name = "string",
  Description = "string",
  ConnectionArn = "string",
  InvocationEndpoint = "string",
  HttpMethod = "POST"|"GET"|"HEAD"|"OPTIONS"|"PUT"|"PATCH"|"DELETE",
  InvocationRateLimitPerSecond = 123
)