We recommend new projects start with resources from the AWS provider.
aws-native.events.ApiDestination
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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 string
- The unique name of the resource.
- args ApiDestinationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args ApiDestinationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiDestinationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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 string
- The arn of the connection.
- HttpMethod Pulumi.Aws Native. Events. Api Destination Http Method 
- The method to use for the request to the HTTP invocation endpoint.
- InvocationEndpoint string
- Url endpoint to invoke.
- Description string
- A description for the API destination to create.
- InvocationRate intLimit Per Second 
- The maximum number of requests per second to send to the HTTP invocation endpoint.
- Name string
- Name of the apiDestination.
- ConnectionArn string
- The arn of the connection.
- HttpMethod ApiDestination Http Method 
- The method to use for the request to the HTTP invocation endpoint.
- InvocationEndpoint string
- Url endpoint to invoke.
- Description string
- A description for the API destination to create.
- InvocationRate intLimit Per Second 
- The maximum number of requests per second to send to the HTTP invocation endpoint.
- Name string
- Name of the apiDestination.
- connectionArn String
- The arn of the connection.
- httpMethod ApiDestination Http Method 
- The method to use for the request to the HTTP invocation endpoint.
- invocationEndpoint String
- Url endpoint to invoke.
- description String
- A description for the API destination to create.
- invocationRate IntegerLimit Per Second 
- The maximum number of requests per second to send to the HTTP invocation endpoint.
- name String
- Name of the apiDestination.
- connectionArn string
- The arn of the connection.
- httpMethod ApiDestination Http Method 
- The method to use for the request to the HTTP invocation endpoint.
- invocationEndpoint string
- Url endpoint to invoke.
- description string
- A description for the API destination to create.
- invocationRate numberLimit Per Second 
- The maximum number of requests per second to send to the HTTP invocation endpoint.
- name string
- Name of the apiDestination.
- connection_arn str
- The arn of the connection.
- http_method ApiDestination Http Method 
- The method to use for the request to the HTTP invocation endpoint.
- invocation_endpoint str
- Url endpoint to invoke.
- description str
- A description for the API destination to create.
- invocation_rate_ intlimit_ per_ second 
- The maximum number of requests per second to send to the HTTP invocation endpoint.
- name str
- Name of the apiDestination.
- connectionArn String
- The arn of the connection.
- httpMethod "GET" | "HEAD" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "PATCH"
- The method to use for the request to the HTTP invocation endpoint.
- invocationEndpoint String
- Url endpoint to invoke.
- description String
- A description for the API destination to create.
- invocationRate NumberLimit Per Second 
- 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:
Supporting Types
ApiDestinationHttpMethod, ApiDestinationHttpMethodArgs        
- Get
- GET
- Head
- HEAD
- Post
- POST
- Options
- OPTIONS
- Put
- PUT
- Delete
- DELETE
- Patch
- PATCH
- ApiDestination Http Method Get 
- GET
- ApiDestination Http Method Head 
- HEAD
- ApiDestination Http Method Post 
- POST
- ApiDestination Http Method Options 
- OPTIONS
- ApiDestination Http Method Put 
- PUT
- ApiDestination Http Method Delete 
- DELETE
- ApiDestination Http Method 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
- "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.