pulumi-aws-kotlin/com.pulumi.aws.cloudwatch.kotlin/EventApiDestination

EventApiDestination

class EventApiDestination : KotlinCustomResource

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

Properties

arn

val arn: Output<String>

The Amazon Resource Name (ARN) of the event API Destination.

connectionArn

val connectionArn: Output<String>

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

description

val description: Output<String>?

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

httpMethod

val httpMethod: Output<String>

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

val id: Output<String>

invocationEndpoint

val invocationEndpoint: 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.

invocationRateLimitPerSecond

val invocationRateLimitPerSecond: Output<Int>?

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

name

val name: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

urn

val urn: Output<String>