Skip to content

ApiDestinationProps

Properties for defining a ApiDestination.

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

Initializer 

import { ApiDestinationProps } from '@alicloud/ros-cdk-eventbridge'
const apiDestinationProps: ApiDestinationProps = { ... }

Properties

Name Type Description
apiDestinationName string | @alicloud/ros-cdk-core.IResolvable Property apiDestinationName: The name of the api.
connectionName string | @alicloud/ros-cdk-core.IResolvable Property connectionName: The connection configuration name.
httpApiParameters @alicloud/ros-cdk-core.IResolvable | HttpApiParametersProperty Property httpApiParameters: Configuration information for API endpoints.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the api.

apiDestinationNameRequired 

public readonly apiDestinationName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property apiDestinationName: The name of the api.

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

connectionNameRequired 

public readonly connectionName: string | IResolvable;
  • Type: string | @alicloud/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.

httpApiParametersRequired 

public readonly httpApiParameters: IResolvable | HttpApiParametersProperty;

Property httpApiParameters: Configuration information for API endpoints.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the api.

It must be no more than 255 characters.