Skip to content

ServiceProps

Properties for defining a Service.

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

Initializer 

import ros_cdk_apig
ros_cdk_apig.ServiceProps(
  gateway_id: typing.Union[str, IResolvable],
  addresses: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  ai_service_config: typing.Union[IResolvable, AiServiceConfigProperty] = None,
  group_name: typing.Union[str, IResolvable] = None,
  namespace: typing.Union[str, IResolvable] = None,
  qualifier: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  service_name: typing.Union[str, IResolvable] = None,
  source_type: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
gateway_id typing.Union[str, ros_cdk_core.IResolvable] Property gatewayId: The ID of the Cloud Native API Gateway.
addresses typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property addresses: Service Address List.
ai_service_config typing.Union[ros_cdk_core.IResolvable, AiServiceConfigProperty] Property aiServiceConfig: AI service configuration when SourceType equals AI.
group_name typing.Union[str, ros_cdk_core.IResolvable] Property groupName: The service group name.
namespace typing.Union[str, ros_cdk_core.IResolvable] Property namespace: The namespace of the service: - SourceType is K8S, indicating the namespace of the K8S service.
qualifier typing.Union[str, ros_cdk_core.IResolvable] Property qualifier: The function version or alias.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
service_name typing.Union[str, ros_cdk_core.IResolvable] Property serviceName: The name of the service, need to fill in manually when SourceType is VIP\/DNS\/AI.
source_type typing.Union[str, ros_cdk_core.IResolvable] Property sourceType: The type of the service source, optional value is K8S\/MSE_NACOS\/FC3\/SAE_K8S_SERVICE\/VIP\/DNS\/AI.

gateway_idRequired 

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

Property gatewayId: The ID of the Cloud Native API Gateway.

addressesOptional 

addresses: 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 addresses: Service Address List.

ai_service_configOptional 

ai_service_config: typing.Union[IResolvable, AiServiceConfigProperty]

Property aiServiceConfig: AI service configuration when SourceType equals AI.

group_nameOptional 

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

Property groupName: The service group name.

Required when SourceType is MSE_NACOS.

namespaceOptional 

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

Property namespace: The namespace of the service: - SourceType is K8S, indicating the namespace of the K8S service.

When-SourceType is set to MSE_NACOS, it indicates the namespace in Nacos. When the SourceType is K8S and MSE_NACOS, it needs to be specified.

qualifierOptional 

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

Property qualifier: The function version or alias.

resource_group_idOptional 

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

Property resourceGroupId: The ID of the resource group.

service_nameOptional 

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

Property serviceName: The name of the service, need to fill in manually when SourceType is VIP\/DNS\/AI.

source_typeOptional 

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

Property sourceType: The type of the service source, optional value is K8S\/MSE_NACOS\/FC3\/SAE_K8S_SERVICE\/VIP\/DNS\/AI.