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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.events.getApiDestination

Explore with Pulumi AI

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

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

Using getApiDestination

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApiDestination(args: GetApiDestinationArgs, opts?: InvokeOptions): Promise<GetApiDestinationResult>
function getApiDestinationOutput(args: GetApiDestinationOutputArgs, opts?: InvokeOptions): Output<GetApiDestinationResult>
Copy
def get_api_destination(name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetApiDestinationResult
def get_api_destination_output(name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetApiDestinationResult]
Copy
func LookupApiDestination(ctx *Context, args *LookupApiDestinationArgs, opts ...InvokeOption) (*LookupApiDestinationResult, error)
func LookupApiDestinationOutput(ctx *Context, args *LookupApiDestinationOutputArgs, opts ...InvokeOption) LookupApiDestinationResultOutput
Copy

> Note: This function is named LookupApiDestination in the Go SDK.

public static class GetApiDestination 
{
    public static Task<GetApiDestinationResult> InvokeAsync(GetApiDestinationArgs args, InvokeOptions? opts = null)
    public static Output<GetApiDestinationResult> Invoke(GetApiDestinationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApiDestinationResult> getApiDestination(GetApiDestinationArgs args, InvokeOptions options)
public static Output<GetApiDestinationResult> getApiDestination(GetApiDestinationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:events:getApiDestination
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Name of the apiDestination.
Name This property is required. string
Name of the apiDestination.
name This property is required. String
Name of the apiDestination.
name This property is required. string
Name of the apiDestination.
name This property is required. str
Name of the apiDestination.
name This property is required. String
Name of the apiDestination.

getApiDestination Result

The following output properties are available:

Arn string
The arn of the api destination.
ConnectionArn string
The arn of the connection.
Description string
A description for the API destination to create.
HttpMethod Pulumi.AwsNative.Events.ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.
InvocationEndpoint string
Url endpoint to invoke.
InvocationRateLimitPerSecond int
The maximum number of requests per second to send to the HTTP invocation endpoint.
Arn string
The arn of the api destination.
ConnectionArn string
The arn of the connection.
Description string
A description for the API destination to create.
HttpMethod ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.
InvocationEndpoint string
Url endpoint to invoke.
InvocationRateLimitPerSecond int
The maximum number of requests per second to send to the HTTP invocation endpoint.
arn String
The arn of the api destination.
connectionArn String
The arn of the connection.
description String
A description for the API destination to create.
httpMethod ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.
invocationEndpoint String
Url endpoint to invoke.
invocationRateLimitPerSecond Integer
The maximum number of requests per second to send to the HTTP invocation endpoint.
arn string
The arn of the api destination.
connectionArn string
The arn of the connection.
description string
A description for the API destination to create.
httpMethod ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.
invocationEndpoint string
Url endpoint to invoke.
invocationRateLimitPerSecond number
The maximum number of requests per second to send to the HTTP invocation endpoint.
arn str
The arn of the api destination.
connection_arn str
The arn of the connection.
description str
A description for the API destination to create.
http_method ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.
invocation_endpoint str
Url endpoint to invoke.
invocation_rate_limit_per_second int
The maximum number of requests per second to send to the HTTP invocation endpoint.
arn String
The arn of the api destination.
connectionArn String
The arn of the connection.
description String
A description for the API destination to create.
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.
invocationRateLimitPerSecond Number
The maximum number of requests per second to send to the HTTP invocation endpoint.

Supporting Types

ApiDestinationHttpMethod

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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native