ApiAttachmentProps
Properties for defining a ApiAttachment
.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-apiattachment
Initializer
import ros_cdk_apig
ros_cdk_apig.ApiAttachmentProps(
backend_scene: typing.Union[str, IResolvable],
environment_id: typing.Union[str, IResolvable],
http_api_id: typing.Union[str, IResolvable],
service_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServiceConfigsProperty]]],
description: typing.Union[str, IResolvable] = None,
domain_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
route_id: typing.Union[str, IResolvable] = None
)
Properties
Name | Type | Description |
---|---|---|
backend_scene |
typing.Union[str, ros_cdk_core.IResolvable] |
Property backendScene: API release scenario. |
environment_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property environmentId: The ID of the environment to which the API is to deploy. |
http_api_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property httpApiId: The ID of the HTTP API. |
service_configs |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServiceConfigsProperty]]] |
Property serviceConfigs: Services associated with API publishing and their configurations. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: The description of publication. |
domain_ids |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
Property domainIds: The list of user domain names associated with API publishing. |
route_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property routeId: The route ID. |
backend_scene
Required
backend_scene: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property backendScene: API release scenario.
environment_id
Required
environment_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property environmentId: The ID of the environment to which the API is to deploy.
http_api_id
Required
http_api_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property httpApiId: The ID of the HTTP API.
service_configs
Required
service_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServiceConfigsProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServiceConfigsProperty]]]
Property serviceConfigs: Services associated with API publishing and their configurations.
description
Optional
description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of publication.
domain_ids
Optional
domain_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property domainIds: The list of user domain names associated with API publishing.
route_id
Optional
route_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property routeId: The route ID.
When publishing an HTTP API route, it must be passed in.