Skip to content

CreateApiDestinationRequest

Source code in docs_src/capo_eventbridge/types/create_api_destination_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class CreateApiDestinationRequest(TypedDict, closed=True):
    name: "capo_eventbridge.types.api_destination_name.ApiDestinationName"
    """<p>The name for the API destination to create.</p>"""
    description: NotRequired[
        "capo_eventbridge.types.api_destination_description.ApiDestinationDescription"
    ]
    """<p>A description for the API destination to create.</p>"""
    connection_arn: "capo_eventbridge.types.connection_arn.ConnectionArn"
    """<p>The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.</p>"""
    invocation_endpoint: "capo_eventbridge.types.https_endpoint.HttpsEndpoint"
    """<p>The URL to the HTTP invocation endpoint for the API destination.</p>"""
    http_method: (
        "capo_eventbridge.types.api_destination_http_method.ApiDestinationHttpMethod"
    )
    """<p>The method to use for the request to the HTTP invocation endpoint.</p>"""
    invocation_rate_limit_per_second: NotRequired[
        "capo_eventbridge.types.api_destination_invocation_rate_limit_per_second.ApiDestinationInvocationRateLimitPerSecond"
    ]
    """<p>The maximum number of requests per second to send to the HTTP invocation endpoint.</p>"""

connection_arn instance-attribute 

connection_arn: ConnectionArn

The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

description instance-attribute 

description: NotRequired[ApiDestinationDescription]

A description for the API destination to create.

http_method instance-attribute 

http_method: ApiDestinationHttpMethod

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

invocation_endpoint instance-attribute 

invocation_endpoint: HttpsEndpoint

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

invocation_rate_limit_per_second instance-attribute 

invocation_rate_limit_per_second: NotRequired[
    ApiDestinationInvocationRateLimitPerSecond
]

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

name instance-attribute 

name: ApiDestinationName

The name for the API destination to create.