Skip to content

ApiDestinationProps

Properties for defining a ApiDestination.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-eventbridge-apidestination

Initializer 

import ros_cdk_eventbridge
ros_cdk_eventbridge.ApiDestinationProps(
  api_destination_name: typing.Union[str, IResolvable],
  connection_name: typing.Union[str, IResolvable],
  http_api_parameters: typing.Union[IResolvable, HttpApiParametersProperty],
  description: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
api_destination_name typing.Union[str, ros_cdk_core.IResolvable] Property apiDestinationName: The name of the api.
connection_name typing.Union[str, ros_cdk_core.IResolvable] Property connectionName: The connection configuration name.
http_api_parameters typing.Union[ros_cdk_core.IResolvable, HttpApiParametersProperty] Property httpApiParameters: Configuration information for API endpoints.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the api.

api_destination_nameRequired 

api_destination_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property apiDestinationName: The name of the api.

The maximum length is 127 characters. Minimum length 2 characters.

connection_nameRequired 

connection_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property connectionName: The connection configuration name.

The maximum length is 127 characters. Minimum length 2 characters.

  • Tip: You must first call the Connection interface to create a Connection configuration. Enter the name of the existing Connection.

http_api_parametersRequired 

http_api_parameters: typing.Union[IResolvable, HttpApiParametersProperty]

Property httpApiParameters: Configuration information for API endpoints.

descriptionOptional 

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the api.

It must be no more than 255 characters.