CfnApiDestinationProps

class aws_cdk.aws_events.CfnApiDestinationProps(*, connection_arn, description=None, http_method, invocation_endpoint, invocation_rate_limit_per_second=None, name=None)

Bases: object

Properties for defining a AWS::Events::ApiDestination.

Parameters
  • connection_arn (str) – AWS::Events::ApiDestination.ConnectionArn.

  • description (Optional[str]) – AWS::Events::ApiDestination.Description.

  • http_method (str) – AWS::Events::ApiDestination.HttpMethod.

  • invocation_endpoint (str) – AWS::Events::ApiDestination.InvocationEndpoint.

  • invocation_rate_limit_per_second (Union[int, float, None]) – AWS::Events::ApiDestination.InvocationRateLimitPerSecond.

  • name (Optional[str]) – AWS::Events::ApiDestination.Name.

Link

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

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_events as events

cfn_api_destination_props = events.CfnApiDestinationProps(
    connection_arn="connectionArn",
    http_method="httpMethod",
    invocation_endpoint="invocationEndpoint",

    # the properties below are optional
    description="description",
    invocation_rate_limit_per_second=123,
    name="name"
)

Attributes

connection_arn

AWS::Events::ApiDestination.ConnectionArn.

Link

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

Return type

str

description

AWS::Events::ApiDestination.Description.

Link

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

Return type

Optional[str]

http_method

AWS::Events::ApiDestination.HttpMethod.

Link

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

Return type

str

invocation_endpoint

AWS::Events::ApiDestination.InvocationEndpoint.

Link

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

Return type

str

invocation_rate_limit_per_second

AWS::Events::ApiDestination.InvocationRateLimitPerSecond.

Link

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

Return type

Union[int, float, None]

name

AWS::Events::ApiDestination.Name.

Link

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

Return type

Optional[str]