1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. events
  6. ApiDestination

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    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.
    
    
    resource "aws-native_events_api_destination" "name" {
        # resource properties
    }

    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.AwsNative.Events.ApiDestinationHttpMethod
    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.
    InvocationRateLimitPerSecond int
    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 ApiDestinationHttpMethod
    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.
    InvocationRateLimitPerSecond int
    The maximum number of requests per second to send to the HTTP invocation endpoint.
    Name string
    Name of the apiDestination.
    connection_arn string
    The arn of the connection.
    http_method "GET" | "HEAD" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "PATCH"
    The method to use for the request to the HTTP invocation endpoint.
    invocation_endpoint string
    Url endpoint to invoke.
    description string
    A description for the API destination to create.
    invocation_rate_limit_per_second number
    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 ApiDestinationHttpMethod
    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.
    invocationRateLimitPerSecond Integer
    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 ApiDestinationHttpMethod
    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.
    invocationRateLimitPerSecond number
    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 ApiDestinationHttpMethod
    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_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 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.
    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.
    ArnForPolicy string
    The arn of the api destination to be used in IAM policies.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The arn of the api destination.
    ArnForPolicy string
    The arn of the api destination to be used in IAM policies.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn string
    The arn of the api destination.
    arn_for_policy string
    The arn of the api destination to be used in IAM policies.
    id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The arn of the api destination.
    arnForPolicy String
    The arn of the api destination to be used in IAM policies.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The arn of the api destination.
    arnForPolicy string
    The arn of the api destination to be used in IAM policies.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The arn of the api destination.
    arn_for_policy str
    The arn of the api destination to be used in IAM policies.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The arn of the api destination.
    arnForPolicy String
    The arn of the api destination to be used in IAM policies.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApiDestination Resource

    Get an existing ApiDestination resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): ApiDestination
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> ApiDestination
    func GetApiDestination(ctx *Context, name string, id IDInput, state *ApiDestinationState, opts ...ResourceOption) (*ApiDestination, error)
    public static ApiDestination Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static ApiDestination get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingApiDestination:    type: aws-native:events:ApiDestination    get:      id: ${id}
    import {
      to = aws-native_events_api_destination.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state ApiDestinationState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    ApiDestinationHttpMethod, ApiDestinationHttpMethodArgs

    The method to use for the request to the HTTP invocation endpoint.
    NameValue
    GetGET
    HeadHEAD
    PostPOST
    OptionsOPTIONS
    PutPUT
    DeleteDELETE
    PatchPATCH
    NameValue
    ApiDestinationHttpMethodGetGET
    ApiDestinationHttpMethodHeadHEAD
    ApiDestinationHttpMethodPostPOST
    ApiDestinationHttpMethodOptionsOPTIONS
    ApiDestinationHttpMethodPutPUT
    ApiDestinationHttpMethodDeleteDELETE
    ApiDestinationHttpMethodPatchPATCH
    Value
    GET
    HEAD
    POST
    OPTIONS
    PUT
    DELETE
    PATCH
    NameValue
    GetGET
    HeadHEAD
    PostPOST
    OptionsOPTIONS
    PutPUT
    DeleteDELETE
    PatchPATCH
    NameValue
    GetGET
    HeadHEAD
    PostPOST
    OptionsOPTIONS
    PutPUT
    DeleteDELETE
    PatchPATCH
    NameValue
    GETGET
    HEADHEAD
    POSTPOST
    OPTIONSOPTIONS
    PUTPUT
    DELETEDELETE
    PATCHPATCH
    Value
    GET
    HEAD
    POST
    OPTIONS
    PUT
    DELETE
    PATCH

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

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

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial