GatewayService

• Implements: IGatewayService

This class encapsulates and extends the ROS resource type ALIYUN::MSE::GatewayService.

Initializers

import ros_cdk_mse
ros_cdk_mse.GatewayService(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

gateway_unique_id^Required

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

Property gatewayUniqueId: Unique identifier of the gateway.

name^Required

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

Property name: Name of the service.

source_type^Required

• 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_list^Optional

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

Property dnsServerList: List of DNS servers.

fc_alias^Optional

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

Property fcAlias: Function Compute service alias.

Used when SourceType is FC.

fc_service_name^Optional

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

Property fcServiceName: Function Compute service name.

Required when SourceType is FC.

fc_version^Optional

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

Property fcVersion: Function Compute service version.

Used when SourceType is FC.

group_name^Optional

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

Property groupName: Group name of the service.

ips^Optional

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

Property ips: List of IPs.

namespace^Optional

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

Property namespace: Namespace of the service.

sae_app_id^Optional

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

Property saeAppId: SAE application ID.

service_port^Optional

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

Property servicePort: Port of the service.

service_protocol^Optional

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

Property serviceProtocol: Protocol of the service.

source_id^Optional

• 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_setting^Optional

• 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).

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_mse
ros_cdk_mse.GatewayService.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_name^Required

attr_name: typing.Union[str, IResolvable]

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

Attribute Name: The name of the service.

attr_service_id^Required

attr_service_id: typing.Union[str, IResolvable]

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

Attribute ServiceId: The ID of the gateway service.

props^Required

props: GatewayServiceProps

• Type: GatewayServiceProps