Class ApiDestinationProps
The event API Destination properties.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.AWS.Events.dll
Syntax (csharp)
public class ApiDestinationProps : Object, IApiDestinationProps
Syntax (vb)
Public Class ApiDestinationProps
Inherits Object
Implements 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
Constructors
ApiDestinationProps() |
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. |
Constructors
ApiDestinationProps()
public ApiDestinationProps()
Properties
ApiDestinationName
The name for the API destination.
public string ApiDestinationName { get; set; }
Property Value
System.String
Remarks
Default: - A unique name will be generated
Connection
The ARN of the connection to use for the API destination.
public IConnection Connection { get; set; }
Property Value
Description
A description for the API destination.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: - none
Endpoint
The URL to the HTTP invocation endpoint for the API destination..
public string Endpoint { get; set; }
Property Value
System.String
HttpMethod
The method to use for the request to the HTTP invocation endpoint.
public Nullable<HttpMethod> HttpMethod { get; set; }
Property Value
System.Nullable<HttpMethod>
Remarks
Default: HttpMethod.POST
RateLimitPerSecond
The maximum number of requests per second to send to the HTTP invocation endpoint.
public Nullable<double> RateLimitPerSecond { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - Not rate limited