Interface IApiDestinationProps

The event API Destination properties.

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IApiDestinationProps

Syntax (vb)

Public Interface IApiDestinationProps

Remarks

ExampleMetadata: infused

Examples

var connection = new Connection(this, "Connection", new ConnectionProps {
                Authorization = Authorization.ApiKey("x-api-key", SecretValue.SecretsManager("ApiSecretName")),
                Description = "Connection with API Key x-api-key"
            });

            var destination = new ApiDestination(this, "Destination", new ApiDestinationProps {
                Connection = connection,
                Endpoint = "https://example.com",
                Description = "Calling example.com with API key x-api-key"
            });

            var rule = new Rule(this, "Rule", new RuleProps {
                Schedule = Schedule.Rate(Duration.Minutes(1)),
                Targets = new [] { new ApiDestination(destination) }
            });

Synopsis

Properties

ApiDestinationName	The name for the API destination.
Connection	The ARN of the connection to use for the API destination.
Description	A description for the API destination.
Endpoint	The URL to the HTTP invocation endpoint for the API destination..
HttpMethod	The method to use for the request to the HTTP invocation endpoint.
RateLimitPerSecond	The maximum number of requests per second to send to the HTTP invocation endpoint.

Properties

ApiDestinationName

The name for the API destination.

string? ApiDestinationName { get; }

Property Value

string

Remarks

Default: - A unique name will be generated

Connection

The ARN of the connection to use for the API destination.

IConnectionRef Connection { get; }

Property Value

IConnectionRef

Remarks

ExampleMetadata: infused

Description

A description for the API destination.

string? Description { get; }

Property Value

string

Remarks

Default: - none

Endpoint

The URL to the HTTP invocation endpoint for the API destination..

string Endpoint { get; }

Property Value

string

Remarks

ExampleMetadata: infused

HttpMethod

The method to use for the request to the HTTP invocation endpoint.

HttpMethod? HttpMethod { get; }

Property Value

HttpMethod?

Remarks

Default: HttpMethod.POST

RateLimitPerSecond

The maximum number of requests per second to send to the HTTP invocation endpoint.

double? RateLimitPerSecond { get; }

Property Value

double?

Remarks

Default: - Not rate limited