Service

• Implements: IService

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Service.

Initializers

import com.aliyun.ros.cdk.apig.Service;
Service.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .gatewayId(java.lang.String)
    .gatewayId(IResolvable)
//  .addresses(IResolvable)
//  .addresses(java.util.List<java.lang.String)
//  .addresses(IResolvable>)
//  .aiServiceConfig(IResolvable)
//  .aiServiceConfig(AiServiceConfigProperty)
//  .groupName(java.lang.String)
//  .groupName(IResolvable)
//  .namespace(java.lang.String)
//  .namespace(IResolvable)
//  .qualifier(java.lang.String)
//  .qualifier(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .serviceName(java.lang.String)
//  .serviceName(IResolvable)
//  .sourceType(java.lang.String)
//  .sourceType(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

gatewayId^Required

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

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

addresses^Optional

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

Property addresses: Service Address List.

aiServiceConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR AiServiceConfigProperty

Property aiServiceConfig: AI service configuration when SourceType equals AI.

groupName^Optional

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

Property groupName: The service group name.

Required when SourceType is MSE_NACOS.

namespace^Optional

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

qualifier^Optional

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

Property qualifier: The function version or alias.

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the resource group.

serviceName^Optional

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

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

sourceType^Optional

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

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.apig.Service;
Service.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

attrAddresses^Required

public java.lang.Object getAttrAddresses();

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

Attribute Addresses: Service Address List.

attrAiServiceConfig^Required

public java.lang.Object getAttrAiServiceConfig();

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

Attribute AiServiceConfig: AI service configuration when SourceType equals AI.

attrGatewayId^Required

public java.lang.Object getAttrGatewayId();

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

Attribute GatewayId: The ID of the Cloud Native API Gateway.

attrGroupName^Required

public java.lang.Object getAttrGroupName();

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

Attribute GroupName: The service group name.

attrNamespace^Required

public java.lang.Object getAttrNamespace();

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

Attribute Namespace: The namespace of the service:.

attrQualifier^Required

public java.lang.Object getAttrQualifier();

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

Attribute Qualifier: The function version or alias.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

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

Attribute ResourceGroupId: The ID of the resource group.

attrServiceId^Required

public java.lang.Object getAttrServiceId();

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

Attribute ServiceId: The ID of the service.

attrServiceName^Required

public java.lang.Object getAttrServiceName();

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

Attribute ServiceName: Service Name, need to fill in manually when SourceType is VIP/DNS/AI.

props^Required

public ServiceProps getProps();

• Type: ServiceProps