Interface ICfnApiDestinationProps

Properties for defining a CfnApiDestination.

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnApiDestinationProps

Syntax (vb)

Public Interface ICfnApiDestinationProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html

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

string

Remarks

The destination endpoint must support the authorization type specified for the connection.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn

Description

A description for the API destination to create.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description

HttpMethod

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

string HttpMethod { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod

InvocationEndpoint

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

string InvocationEndpoint { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint

InvocationRateLimitPerSecond

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

double? InvocationRateLimitPerSecond { get; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond

Name

The name for the API destination to create.

string? Name { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name