CfnApiDestinationProps

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

Bases: object

Properties for defining a CfnApiDestination.

Parameters:

connection_arn (str) – The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.
http_method (str) – The method to use for the request to the HTTP invocation endpoint.
invocation_endpoint (str) – The URL to the HTTP invocation endpoint for the API destination.
description (Optional[str]) – A description for the API destination to create.
invocation_rate_limit_per_second (Union[int, float, None]) – The maximum number of requests per second to send to the HTTP invocation endpoint.
name (Optional[str]) – The name for the API destination to create.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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"
)