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

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 pulumi
import pulumi_aws as aws
test = aws.cloudwatch.EventApiDestination("test",
name="api-destination",
description="An API Destination",
invocation_endpoint="https://api.destination.com/endpoint",
http_method="POST",
invocation_rate_limit_per_second=20,
connection_arn=test_aws_cloudwatch_event_connection["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.CloudWatch.EventApiDestination("test", new()
{
Name = "api-destination",
Description = "An API Destination",
InvocationEndpoint = "https://api.destination.com/endpoint",
HttpMethod = "POST",
InvocationRateLimitPerSecond = 20,
ConnectionArn = testAwsCloudwatchEventConnection.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewEventApiDestination(ctx, "test", &cloudwatch.EventApiDestinationArgs{
Name: pulumi.String("api-destination"),
Description: pulumi.String("An API Destination"),
InvocationEndpoint: pulumi.String("https://api.destination.com/endpoint"),
HttpMethod: pulumi.String("POST"),
InvocationRateLimitPerSecond: pulumi.Int(20),
ConnectionArn: pulumi.Any(testAwsCloudwatchEventConnection.Arn),
})
if err != nil {
return err
}
return nil
})
}
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()
.name("api-destination")
.description("An API Destination")
.invocationEndpoint("https://api.destination.com/endpoint")
.httpMethod("POST")
.invocationRateLimitPerSecond(20)
.connectionArn(testAwsCloudwatchEventConnection.arn())
.build());
}
}
resources:
test:
type: aws:cloudwatch:EventApiDestination
properties:
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:

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

Properties

Link copied to clipboard
val arn: Output<String>

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

Link copied to clipboard
val connectionArn: Output<String>

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

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

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

Link copied to clipboard
val httpMethod: Output<String>

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

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

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

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>

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>