Interface ICfnApiDestinationProps
Properties for defining a CfnApiDestination
.
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.AWS.Events.dll
Syntax (csharp)
public interface ICfnApiDestinationProps
Syntax (vb)
Public Interface ICfnApiDestinationProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;
var cfnApiDestinationProps = new CfnApiDestinationProps {
ConnectionArn = "connectionArn",
HttpMethod = "httpMethod",
InvocationEndpoint = "invocationEndpoint",
// the properties below are optional
Description = "description",
InvocationRateLimitPerSecond = 123,
Name = "name"
};
Synopsis
Properties
ConnectionArn | The ARN of the connection to use for the API destination. |
Description | A description for the API destination to create. |
HttpMethod | The method to use for the request to the HTTP invocation endpoint. |
InvocationEndpoint | The URL to the HTTP invocation endpoint for the API destination. |
InvocationRateLimitPerSecond | The maximum number of requests per second to send to the HTTP invocation endpoint. |
Name | The name for the API destination to create. |
Properties
ConnectionArn
The ARN of the connection to use for the API destination.
string ConnectionArn { get; }
Property Value
System.String
Remarks
The destination endpoint must support the authorization type specified for the connection.
Description
A description for the API destination to create.
virtual string Description { get; }
Property Value
System.String
Remarks
HttpMethod
The method to use for the request to the HTTP invocation endpoint.
string HttpMethod { get; }
Property Value
System.String
Remarks
InvocationEndpoint
The URL to the HTTP invocation endpoint for the API destination.
string InvocationEndpoint { get; }
Property Value
System.String
Remarks
InvocationRateLimitPerSecond
The maximum number of requests per second to send to the HTTP invocation endpoint.
virtual Nullable<double> InvocationRateLimitPerSecond { get; }
Property Value
System.Nullable<System.Double>
Remarks
Name
The name for the API destination to create.
virtual string Name { get; }
Property Value
System.String