Skip to content

GatewayServiceProps

Properties for defining a GatewayService.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-mse-gatewayservice

Initializer

import ros_cdk_mse
ros_cdk_mse.GatewayServiceProps(
  gateway_unique_id: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  source_type: typing.Union[str, IResolvable],
  dns_server_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  fc_alias: typing.Union[str, IResolvable] = None,
  fc_service_name: typing.Union[str, IResolvable] = None,
  fc_version: typing.Union[str, IResolvable] = None,
  group_name: typing.Union[str, IResolvable] = None,
  ips: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  namespace: typing.Union[str, IResolvable] = None,
  sae_app_id: typing.Union[str, IResolvable] = None,
  service_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  service_protocol: typing.Union[str, IResolvable] = None,
  source_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  tls_setting: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None
)

Properties

Name Type Description
gateway_unique_id typing.Union[str, ros_cdk_core.IResolvable] Property gatewayUniqueId: Unique identifier of the gateway.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: Name of the service.
source_type typing.Union[str, ros_cdk_core.IResolvable] Property sourceType: Type of service source.
dns_server_list typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property dnsServerList: List of DNS servers.
fc_alias typing.Union[str, ros_cdk_core.IResolvable] Property fcAlias: Function Compute service alias.
fc_service_name typing.Union[str, ros_cdk_core.IResolvable] Property fcServiceName: Function Compute service name.
fc_version typing.Union[str, ros_cdk_core.IResolvable] Property fcVersion: Function Compute service version.
group_name typing.Union[str, ros_cdk_core.IResolvable] Property groupName: Group name of the service.
ips typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property ips: List of IPs.
namespace typing.Union[str, ros_cdk_core.IResolvable] Property namespace: Namespace of the service.
sae_app_id typing.Union[str, ros_cdk_core.IResolvable] Property saeAppId: SAE application ID.
service_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property servicePort: Port of the service.
service_protocol typing.Union[str, ros_cdk_core.IResolvable] Property serviceProtocol: Protocol of the service.
source_id typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property sourceId: Source ID of the service.
tls_setting typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property tlsSetting: The TLS settings, specified as a JSON string.

gateway_unique_idRequired

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

Property gatewayUniqueId: Unique identifier of the gateway.


nameRequired

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

Property name: Name of the service.


source_typeRequired

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

Property sourceType: Type of service source.

Valid values:

  • MSE: MSE-NACOS
  • K8s: ACK container service
  • VIP: Fixed address
  • DNS: DNS domain name
  • FC: Function Compute
  • EDAS: EDAS
  • MSE_ZK: MSE-Zookeeper
  • SAE: SAE

dns_server_listOptional

dns_server_list: 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 dnsServerList: List of DNS servers.


fc_aliasOptional

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

Property fcAlias: Function Compute service alias.

Used when SourceType is FC.


fc_service_nameOptional

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

Property fcServiceName: Function Compute service name.

Required when SourceType is FC.


fc_versionOptional

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

Property fcVersion: Function Compute service version.

Used when SourceType is FC.


group_nameOptional

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

Property groupName: Group name of the service.


ipsOptional

ips: 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 ips: List of IPs.


namespaceOptional

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

Property namespace: Namespace of the service.


sae_app_idOptional

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

Property saeAppId: SAE application ID.


service_portOptional

service_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property servicePort: Port of the service.


service_protocolOptional

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

Property serviceProtocol: Protocol of the service.


source_idOptional

source_id: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property sourceId: Source ID of the service.

Used when specifying a source to add services.


tls_settingOptional

tls_setting: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property tlsSetting: The TLS settings, specified as a JSON string.

The following fields are supported:

  • mode: The TLS mode.
  • certId: The certificate ID.
  • caCertId: The CA certificate ID.
  • caCertContent: The public key of the CA certificate.
  • sni: The Server Name Indication (SNI).