Skip to content

ServiceProps

Properties for defining a Service.

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

Initializer 

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

Properties

Name Type Description
gatewayId string | @alicloud/ros-cdk-core.IResolvable Property gatewayId: The ID of the Cloud Native API Gateway.
addresses @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property addresses: Service Address List.
aiServiceConfig @alicloud/ros-cdk-core.IResolvable | AiServiceConfigProperty Property aiServiceConfig: AI service configuration when SourceType equals AI.
groupName string | @alicloud/ros-cdk-core.IResolvable Property groupName: The service group name.
namespace string | @alicloud/ros-cdk-core.IResolvable Property namespace: The namespace of the service: - SourceType is K8S, indicating the namespace of the K8S service.
qualifier string | @alicloud/ros-cdk-core.IResolvable Property qualifier: The function version or alias.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
serviceName string | @alicloud/ros-cdk-core.IResolvable Property serviceName: The name of the service, need to fill in manually when SourceType is VIP\/DNS\/AI.
sourceType string | @alicloud/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.

gatewayIdRequired 

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

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

addressesOptional 

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

Property addresses: Service Address List.

aiServiceConfigOptional 

public readonly aiServiceConfig: IResolvable | AiServiceConfigProperty;

Property aiServiceConfig: AI service configuration when SourceType equals AI.

groupNameOptional 

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

Property groupName: The service group name.

Required when SourceType is MSE_NACOS.

namespaceOptional 

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

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

Property qualifier: The function version or alias.

resourceGroupIdOptional 

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

Property resourceGroupId: The ID of the resource group.

serviceNameOptional 

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

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

sourceTypeOptional 

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