EventApiDestination class
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/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "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 = testAwsCloudwatchEventConnection.arn
}
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.ArrayList;
import java.util.Arrays;
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
Identity Schema
Required
name(String) Name of the API destination.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import API Destinations using name. For example:
$ pulumi import aws:cloudwatch/eventApiDestination:EventApiDestination example example-destination
Constructors
- EventApiDestination(String name, {EventApiDestinationArgs? args, CustomResourceOptions? options})
-
Creates a new EventApiDestination.
nameThe Pulumi resource name.argsArguments used to configure this EventApiDestination. The set of arguments for EventApiDestination.optionsResource options controlling this resource's behavior. - EventApiDestination.reference(String urn)
- Creates a typed reference to an existing EventApiDestination resource.
Properties
-
arn
↔ Output<
String> -
ARN of the event API Destination.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
connectionArn
↔ Output<
String> -
ARN of the EventBridge Connection to use for the API Destination.
latefinal
-
description
↔ Output<
String?> -
The description of the new API Destination. Maximum of 512 characters.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
httpMethod
↔ Output<
String> -
Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
-
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.
latefinal
-
invocationRateLimitPerSecond
↔ Output<
int?> -
Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
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, .,-,_.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {EventApiDestinationState? state, CustomResourceOptions? options}) → EventApiDestination -
Gets an existing EventApiDestination resource's state with the given
nameandid.