aws.cloudwatch.EventApiDestination
Explore with Pulumi AI
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"])
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
})
}
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 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}
Create EventApiDestination Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EventApiDestination(name: string, args: EventApiDestinationArgs, opts?: CustomResourceOptions);
@overload
def EventApiDestination(resource_name: str,
args: EventApiDestinationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def EventApiDestination(resource_name: str,
opts: Optional[ResourceOptions] = None,
connection_arn: Optional[str] = None,
http_method: Optional[str] = None,
invocation_endpoint: Optional[str] = None,
description: Optional[str] = None,
invocation_rate_limit_per_second: Optional[int] = None,
name: Optional[str] = None)
func NewEventApiDestination(ctx *Context, name string, args EventApiDestinationArgs, opts ...ResourceOption) (*EventApiDestination, error)
public EventApiDestination(string name, EventApiDestinationArgs args, CustomResourceOptions? opts = null)
public EventApiDestination(String name, EventApiDestinationArgs args)
public EventApiDestination(String name, EventApiDestinationArgs args, CustomResourceOptions options)
type: aws:cloudwatch:EventApiDestination
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args EventApiDestinationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EventApiDestinationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EventApiDestinationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EventApiDestinationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EventApiDestinationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var eventApiDestinationResource = new Aws.CloudWatch.EventApiDestination("eventApiDestinationResource", new()
{
ConnectionArn = "string",
HttpMethod = "string",
InvocationEndpoint = "string",
Description = "string",
InvocationRateLimitPerSecond = 0,
Name = "string",
});
example, err := cloudwatch.NewEventApiDestination(ctx, "eventApiDestinationResource", &cloudwatch.EventApiDestinationArgs{
ConnectionArn: pulumi.String("string"),
HttpMethod: pulumi.String("string"),
InvocationEndpoint: pulumi.String("string"),
Description: pulumi.String("string"),
InvocationRateLimitPerSecond: pulumi.Int(0),
Name: pulumi.String("string"),
})
var eventApiDestinationResource = new EventApiDestination("eventApiDestinationResource", EventApiDestinationArgs.builder()
.connectionArn("string")
.httpMethod("string")
.invocationEndpoint("string")
.description("string")
.invocationRateLimitPerSecond(0)
.name("string")
.build());
event_api_destination_resource = aws.cloudwatch.EventApiDestination("eventApiDestinationResource",
connection_arn="string",
http_method="string",
invocation_endpoint="string",
description="string",
invocation_rate_limit_per_second=0,
name="string")
const eventApiDestinationResource = new aws.cloudwatch.EventApiDestination("eventApiDestinationResource", {
connectionArn: "string",
httpMethod: "string",
invocationEndpoint: "string",
description: "string",
invocationRateLimitPerSecond: 0,
name: "string",
});
type: aws:cloudwatch:EventApiDestination
properties:
connectionArn: string
description: string
httpMethod: string
invocationEndpoint: string
invocationRateLimitPerSecond: 0
name: string
EventApiDestination Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The EventApiDestination resource accepts the following input properties:
- Connection
Arn string - ARN of the EventBridge Connection to use for the API Destination.
- Http
Method string - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- Invocation
Endpoint 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.
- Description string
- The description of the new API Destination. Maximum of 512 characters.
- Invocation
Rate intLimit Per Second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- Name 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, .,-,_.
- Connection
Arn string - ARN of the EventBridge Connection to use for the API Destination.
- Http
Method string - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- Invocation
Endpoint 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.
- Description string
- The description of the new API Destination. Maximum of 512 characters.
- Invocation
Rate intLimit Per Second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- Name 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, .,-,_.
- connection
Arn String - ARN of the EventBridge Connection to use for the API Destination.
- http
Method String - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- invocation
Endpoint 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.
- description String
- The description of the new API Destination. Maximum of 512 characters.
- invocation
Rate IntegerLimit Per Second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- name 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, .,-,_.
- connection
Arn string - ARN of the EventBridge Connection to use for the API Destination.
- http
Method string - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- invocation
Endpoint 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.
- description string
- The description of the new API Destination. Maximum of 512 characters.
- invocation
Rate numberLimit Per Second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- name 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, .,-,_.
- connection_
arn str - ARN of the EventBridge Connection to use for the API Destination.
- http_
method str - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- invocation_
endpoint str - 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.
- description str
- The description of the new API Destination. Maximum of 512 characters.
- invocation_
rate_ intlimit_ per_ second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- name str
- 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, .,-,_.
- connection
Arn String - ARN of the EventBridge Connection to use for the API Destination.
- http
Method String - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- invocation
Endpoint 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.
- description String
- The description of the new API Destination. Maximum of 512 characters.
- invocation
Rate NumberLimit Per Second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- name 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, .,-,_.
Outputs
All input properties are implicitly available as output properties. Additionally, the EventApiDestination resource produces the following output properties:
Look up Existing EventApiDestination Resource
Get an existing EventApiDestination resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: EventApiDestinationState, opts?: CustomResourceOptions): EventApiDestination
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
connection_arn: Optional[str] = None,
description: Optional[str] = None,
http_method: Optional[str] = None,
invocation_endpoint: Optional[str] = None,
invocation_rate_limit_per_second: Optional[int] = None,
name: Optional[str] = None) -> EventApiDestination
func GetEventApiDestination(ctx *Context, name string, id IDInput, state *EventApiDestinationState, opts ...ResourceOption) (*EventApiDestination, error)
public static EventApiDestination Get(string name, Input<string> id, EventApiDestinationState? state, CustomResourceOptions? opts = null)
public static EventApiDestination get(String name, Output<String> id, EventApiDestinationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The Amazon Resource Name (ARN) of the event API Destination.
- Connection
Arn string - ARN of the EventBridge Connection to use for the API Destination.
- Description string
- The description of the new API Destination. Maximum of 512 characters.
- Http
Method string - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- Invocation
Endpoint 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.
- Invocation
Rate intLimit Per Second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- Name 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, .,-,_.
- Arn string
- The Amazon Resource Name (ARN) of the event API Destination.
- Connection
Arn string - ARN of the EventBridge Connection to use for the API Destination.
- Description string
- The description of the new API Destination. Maximum of 512 characters.
- Http
Method string - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- Invocation
Endpoint 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.
- Invocation
Rate intLimit Per Second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- Name 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, .,-,_.
- arn String
- The Amazon Resource Name (ARN) of the event API Destination.
- connection
Arn String - ARN of the EventBridge Connection to use for the API Destination.
- description String
- The description of the new API Destination. Maximum of 512 characters.
- http
Method String - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- invocation
Endpoint 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.
- invocation
Rate IntegerLimit Per Second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- name 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, .,-,_.
- arn string
- The Amazon Resource Name (ARN) of the event API Destination.
- connection
Arn string - ARN of the EventBridge Connection to use for the API Destination.
- description string
- The description of the new API Destination. Maximum of 512 characters.
- http
Method string - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- invocation
Endpoint 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.
- invocation
Rate numberLimit Per Second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- name 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, .,-,_.
- arn str
- The Amazon Resource Name (ARN) of the event API Destination.
- connection_
arn str - ARN of the EventBridge Connection to use for the API Destination.
- description str
- The description of the new API Destination. Maximum of 512 characters.
- http_
method str - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- invocation_
endpoint str - 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.
- invocation_
rate_ intlimit_ per_ second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- name str
- 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, .,-,_.
- arn String
- The Amazon Resource Name (ARN) of the event API Destination.
- connection
Arn String - ARN of the EventBridge Connection to use for the API Destination.
- description String
- The description of the new API Destination. Maximum of 512 characters.
- http
Method String - Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
- invocation
Endpoint 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.
- invocation
Rate NumberLimit Per Second - Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
- name 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, .,-,_.
Import
Using pulumi import
, import EventBridge API Destinations using the name
. For example:
$ pulumi import aws:cloudwatch/eventApiDestination:EventApiDestination test api-destination
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.