@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
158 lines (157 loc) • 6.89 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an EventBridge event API Destination resource.
*
* > **Note:** EventBridge was formerly known as CloudWatch Events. The functionality is identical.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = new aws.cloudwatch.EventApiDestination("test", {
* name: "api-destination",
* description: "An API Destination",
* invocationEndpoint: "https://api.destination.com/endpoint",
* httpMethod: "POST",
* invocationRateLimitPerSecond: 20,
* connectionArn: testAwsCloudwatchEventConnection.arn,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import EventBridge API Destinations using the `name`. For example:
*
* ```sh
* $ pulumi import aws:cloudwatch/eventApiDestination:EventApiDestination test api-destination
* ```
*/
export declare class EventApiDestination extends pulumi.CustomResource {
/**
* Get an existing EventApiDestination resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventApiDestinationState, opts?: pulumi.CustomResourceOptions): EventApiDestination;
/**
* Returns true if the given object is an instance of EventApiDestination. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is EventApiDestination;
/**
* The Amazon Resource Name (ARN) of the event API Destination.
*/
readonly arn: pulumi.Output<string>;
/**
* ARN of the EventBridge Connection to use for the API Destination.
*/
readonly connectionArn: pulumi.Output<string>;
/**
* The description of the new API Destination. Maximum of 512 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
*/
readonly httpMethod: pulumi.Output<string>;
/**
* URL endpoint to invoke as a target. This could be a valid endpoint generated by a partner service. You can include "*" as path parameters wildcards to be set from the Target HttpParameters.
*/
readonly invocationEndpoint: pulumi.Output<string>;
/**
* Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
*/
readonly invocationRateLimitPerSecond: pulumi.Output<number | undefined>;
/**
* The name of the new API Destination. The name must be unique for your account. Maximum of 64 characters consisting of numbers, lower/upper case letters, .,-,_.
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Create a EventApiDestination resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: EventApiDestinationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering EventApiDestination resources.
*/
export interface EventApiDestinationState {
/**
* The Amazon Resource Name (ARN) of the event API Destination.
*/
arn?: pulumi.Input<string>;
/**
* ARN of the EventBridge Connection to use for the API Destination.
*/
connectionArn?: pulumi.Input<string>;
/**
* The description of the new API Destination. Maximum of 512 characters.
*/
description?: pulumi.Input<string>;
/**
* Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
*/
httpMethod?: pulumi.Input<string>;
/**
* URL endpoint to invoke as a target. This could be a valid endpoint generated by a partner service. You can include "*" as path parameters wildcards to be set from the Target HttpParameters.
*/
invocationEndpoint?: pulumi.Input<string>;
/**
* Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
*/
invocationRateLimitPerSecond?: pulumi.Input<number>;
/**
* The name of the new API Destination. The name must be unique for your account. Maximum of 64 characters consisting of numbers, lower/upper case letters, .,-,_.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a EventApiDestination resource.
*/
export interface EventApiDestinationArgs {
/**
* ARN of the EventBridge Connection to use for the API Destination.
*/
connectionArn: pulumi.Input<string>;
/**
* The description of the new API Destination. Maximum of 512 characters.
*/
description?: pulumi.Input<string>;
/**
* Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
*/
httpMethod: pulumi.Input<string>;
/**
* URL endpoint to invoke as a target. This could be a valid endpoint generated by a partner service. You can include "*" as path parameters wildcards to be set from the Target HttpParameters.
*/
invocationEndpoint: pulumi.Input<string>;
/**
* Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
*/
invocationRateLimitPerSecond?: pulumi.Input<number>;
/**
* The name of the new API Destination. The name must be unique for your account. Maximum of 64 characters consisting of numbers, lower/upper case letters, .,-,_.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}