Skip to content

ApiAttachmentProps

Properties for defining a ApiAttachment.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-apiattachment

Initializer 

import { ApiAttachmentProps } from '@alicloud/ros-cdk-apig'
const apiAttachmentProps: ApiAttachmentProps = { ... }

Properties

Name Type Description
backendScene string | @alicloud/ros-cdk-core.IResolvable Property backendScene: API release scenario.
environmentId string | @alicloud/ros-cdk-core.IResolvable Property environmentId: The ID of the environment to which the API is to deploy.
httpApiId string | @alicloud/ros-cdk-core.IResolvable Property httpApiId: The ID of the HTTP API.
serviceConfigs @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ServiceConfigsProperty[] Property serviceConfigs: Services associated with API publishing and their configurations.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of publication.
domainIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property domainIds: The list of user domain names associated with API publishing.
routeId string | @alicloud/ros-cdk-core.IResolvable Property routeId: The route ID.

backendSceneRequired 

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

Property backendScene: API release scenario.

environmentIdRequired 

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

Property environmentId: The ID of the environment to which the API is to deploy.

httpApiIdRequired 

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

Property httpApiId: The ID of the HTTP API.

serviceConfigsRequired 

public readonly serviceConfigs: IResolvable | IResolvable | ServiceConfigsProperty[];

Property serviceConfigs: Services associated with API publishing and their configurations.

descriptionOptional 

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

Property description: The description of publication.

domainIdsOptional 

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

Property domainIds: The list of user domain names associated with API publishing.

routeIdOptional 

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

Property routeId: The route ID.

When publishing an HTTP API route, it must be passed in.