GatewayService

• Implements: IGatewayService

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

Initializers

import com.aliyun.ros.cdk.mse.GatewayService;
GatewayService.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .gatewayUniqueId(java.lang.String)
    .gatewayUniqueId(IResolvable)
    .name(java.lang.String)
    .name(IResolvable)
    .sourceType(java.lang.String)
    .sourceType(IResolvable)
//  .dnsServerList(IResolvable)
//  .dnsServerList(java.util.List<java.lang.String)
//  .dnsServerList(IResolvable>)
//  .fcAlias(java.lang.String)
//  .fcAlias(IResolvable)
//  .fcServiceName(java.lang.String)
//  .fcServiceName(IResolvable)
//  .fcVersion(java.lang.String)
//  .fcVersion(IResolvable)
//  .groupName(java.lang.String)
//  .groupName(IResolvable)
//  .ips(IResolvable)
//  .ips(java.util.List<java.lang.String)
//  .ips(IResolvable>)
//  .namespace(java.lang.String)
//  .namespace(IResolvable)
//  .saeAppId(java.lang.String)
//  .saeAppId(IResolvable)
//  .servicePort(java.lang.Number)
//  .servicePort(IResolvable)
//  .serviceProtocol(java.lang.String)
//  .serviceProtocol(IResolvable)
//  .sourceId(java.lang.Number)
//  .sourceId(IResolvable)
//  .tlsSetting(IResolvable)
//  .tlsSetting(java.util.Map<java.lang.String, java.lang.Object>)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

gatewayUniqueId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property gatewayUniqueId: Unique identifier of the gateway.

name^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property name: Name of the service.

sourceType^Required

• Type: java.lang.String OR com.aliyun.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

dnsServerList^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property dnsServerList: List of DNS servers.

fcAlias^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property fcAlias: Function Compute service alias.

Used when SourceType is FC.

fcServiceName^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property fcServiceName: Function Compute service name.

Required when SourceType is FC.

fcVersion^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property fcVersion: Function Compute service version.

Used when SourceType is FC.

groupName^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property groupName: Group name of the service.

ips^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property ips: List of IPs.

namespace^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property namespace: Namespace of the service.

saeAppId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property saeAppId: SAE application ID.

servicePort^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property servicePort: Port of the service.

serviceProtocol^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property serviceProtocol: Protocol of the service.

sourceId^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property sourceId: Source ID of the service.

Used when specifying a source to add services.

tlsSetting^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

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

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.mse.GatewayService;
GatewayService.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrName^Required

public java.lang.Object getAttrName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Name: The name of the service.

attrServiceId^Required

public java.lang.Object getAttrServiceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceId: The ID of the gateway service.

props^Required

public GatewayServiceProps getProps();

• Type: GatewayServiceProps