EventApiDestinationArgs

data class EventApiDestinationArgs(val connectionArn: Output<String>? = null, val description: Output<String>? = null, val httpMethod: Output<String>? = null, val invocationEndpoint: Output<String>? = null, val invocationRateLimitPerSecond: Output<Int>? = null, val name: Output<String>? = null) : ConvertibleToJava<EventApiDestinationArgs>

Provides an EventBridge event API Destination resource.

Note: EventBridge was formerly known as CloudWatch Events. The functionality is identical.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.EventApiDestination;
import com.pulumi.aws.cloudwatch.EventApiDestinationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new EventApiDestination("test", EventApiDestinationArgs.builder()
.description("An API Destination")
.invocationEndpoint("https://api.destination.com/endpoint")
.httpMethod("POST")
.invocationRateLimitPerSecond(20)
.connectionArn(aws_cloudwatch_event_connection.test().arn())
.build());
}
}

Import

EventBridge API Destinations can be imported using the name, e.g., console

$ pulumi import aws:cloudwatch/eventApiDestination:EventApiDestination test api-destination

Constructors

Link copied to clipboard
constructor(connectionArn: Output<String>? = null, description: Output<String>? = null, httpMethod: Output<String>? = null, invocationEndpoint: Output<String>? = null, invocationRateLimitPerSecond: Output<Int>? = null, name: Output<String>? = null)

Properties

Link copied to clipboard
val connectionArn: Output<String>? = null

ARN of the EventBridge Connection to use for the API Destination.

Link copied to clipboard
val description: Output<String>? = null

The description of the new API Destination. Maximum of 512 characters.

Link copied to clipboard
val httpMethod: Output<String>? = null

Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.

Link copied to clipboard
val invocationEndpoint: Output<String>? = null

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.

Link copied to clipboard
val invocationRateLimitPerSecond: Output<Int>? = null

Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).

Link copied to clipboard
val name: Output<String>? = null

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, .,-,_.

Functions

Link copied to clipboard
open override fun toJava(): EventApiDestinationArgs