Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. events
  5. ApiDestination

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.events.ApiDestination

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

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

Create ApiDestination Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ApiDestination(name: string, args: ApiDestinationArgs, opts?: CustomResourceOptions);
@overload
def ApiDestination(resource_name: str,
                   args: ApiDestinationArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ApiDestination(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   connection_arn: Optional[str] = None,
                   http_method: Optional[ApiDestinationHttpMethod] = None,
                   invocation_endpoint: Optional[str] = None,
                   description: Optional[str] = None,
                   invocation_rate_limit_per_second: Optional[int] = None,
                   name: Optional[str] = None)
func NewApiDestination(ctx *Context, name string, args ApiDestinationArgs, opts ...ResourceOption) (*ApiDestination, error)
public ApiDestination(string name, ApiDestinationArgs args, CustomResourceOptions? opts = null)
public ApiDestination(String name, ApiDestinationArgs args)
public ApiDestination(String name, ApiDestinationArgs args, CustomResourceOptions options)

type: aws-native:events:ApiDestination
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApiDestinationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApiDestinationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApiDestinationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiDestinationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApiDestinationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ApiDestination Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ApiDestination resource accepts the following input properties:

ConnectionArn This property is required. string
The arn of the connection.
HttpMethod This property is required. Pulumi.AwsNative.Events.ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.
InvocationEndpoint This property is required. string
Url endpoint to invoke.
Description string
A description for the API destination to create.
InvocationRateLimitPerSecond int
The maximum number of requests per second to send to the HTTP invocation endpoint.
Name string
Name of the apiDestination.
ConnectionArn This property is required. string
The arn of the connection.
HttpMethod This property is required. ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.
InvocationEndpoint This property is required. string
Url endpoint to invoke.
Description string
A description for the API destination to create.
InvocationRateLimitPerSecond int
The maximum number of requests per second to send to the HTTP invocation endpoint.
Name string
Name of the apiDestination.
connectionArn This property is required. String
The arn of the connection.
httpMethod This property is required. ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.
invocationEndpoint This property is required. String
Url endpoint to invoke.
description String
A description for the API destination to create.
invocationRateLimitPerSecond Integer
The maximum number of requests per second to send to the HTTP invocation endpoint.
name String
Name of the apiDestination.
connectionArn This property is required. string
The arn of the connection.
httpMethod This property is required. ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.
invocationEndpoint This property is required. string
Url endpoint to invoke.
description string
A description for the API destination to create.
invocationRateLimitPerSecond number
The maximum number of requests per second to send to the HTTP invocation endpoint.
name string
Name of the apiDestination.
connection_arn This property is required. str
The arn of the connection.
http_method This property is required. ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.
invocation_endpoint This property is required. str
Url endpoint to invoke.
description str
A description for the API destination to create.
invocation_rate_limit_per_second int
The maximum number of requests per second to send to the HTTP invocation endpoint.
name str
Name of the apiDestination.
connectionArn This property is required. String
The arn of the connection.
httpMethod This property is required. "GET" | "HEAD" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "PATCH"
The method to use for the request to the HTTP invocation endpoint.
invocationEndpoint This property is required. String
Url endpoint to invoke.
description String
A description for the API destination to create.
invocationRateLimitPerSecond Number
The maximum number of requests per second to send to the HTTP invocation endpoint.
name String
Name of the apiDestination.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiDestination resource produces the following output properties:

Arn string
The arn of the api destination.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The arn of the api destination.
Id string
The provider-assigned unique ID for this managed resource.
arn String
The arn of the api destination.
id String
The provider-assigned unique ID for this managed resource.
arn string
The arn of the api destination.
id string
The provider-assigned unique ID for this managed resource.
arn str
The arn of the api destination.
id str
The provider-assigned unique ID for this managed resource.
arn String
The arn of the api destination.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

ApiDestinationHttpMethod
, ApiDestinationHttpMethodArgs

Get
GET
Head
HEAD
Post
POST
Options
OPTIONS
Put
PUT
Delete
DELETE
Patch
PATCH
ApiDestinationHttpMethodGet
GET
ApiDestinationHttpMethodHead
HEAD
ApiDestinationHttpMethodPost
POST
ApiDestinationHttpMethodOptions
OPTIONS
ApiDestinationHttpMethodPut
PUT
ApiDestinationHttpMethodDelete
DELETE
ApiDestinationHttpMethodPatch
PATCH
Get
GET
Head
HEAD
Post
POST
Options
OPTIONS
Put
PUT
Delete
DELETE
Patch
PATCH
Get
GET
Head
HEAD
Post
POST
Options
OPTIONS
Put
PUT
Delete
DELETE
Patch
PATCH
GET
GET
HEAD
HEAD
POST
POST
OPTIONS
OPTIONS
PUT
PUT
DELETE
DELETE
PATCH
PATCH
"GET"
GET
"HEAD"
HEAD
"POST"
POST
"OPTIONS"
OPTIONS
"PUT"
PUT
"DELETE"
DELETE
"PATCH"
PATCH

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native