Skip to content

Service

  • Implements: com.aliyun.ros.cdk.apig.datasource.IService

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

Initializers

import com.aliyun.ros.cdk.apig.datasource.Service;
Service.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .serviceId(java.lang.String)
    .serviceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
serviceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serviceId: The ID of the service.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

serviceIdRequired

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

Property serviceId: The ID of the service.


refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

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

addCount

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

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.apig.datasource.Service;
Service.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAddresses java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Addresses: A list of domain names or fixed addresses.
attrAiServiceConfig java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AiServiceConfig: AI service configuration when sourceType equals AI.
attrGatewayId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute GatewayId: The ID of the Cloud Native API Gateway.
attrGroupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute GroupName: The service group name.
attrNamespace java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Namespace: The namespace of the service:.
attrQualifier java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Qualifier: The function version or alias.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrServiceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ServiceId: The ID of the service.
attrServiceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ServiceName: The name of the Service, need to fill in manually when sourceType is VIP/DNS/AI.
attrSourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SourceType: The type of the service source, optional value is K8S/MSE_NACOS/FC3/SAE_K8S_SERVICE/VIP/DNS/AI.
props ServiceProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAddressesRequired

public java.lang.Object getAttrAddresses();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Addresses: A list of domain names or fixed addresses.


attrAiServiceConfigRequired

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.


attrGatewayIdRequired

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.


attrGroupNameRequired

public java.lang.Object getAttrGroupName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GroupName: The service group name.


attrNamespaceRequired

public java.lang.Object getAttrNamespace();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Namespace: The namespace of the service:.


attrQualifierRequired

public java.lang.Object getAttrQualifier();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Qualifier: The function version or alias.


attrResourceGroupIdRequired

public java.lang.Object getAttrResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attrServiceIdRequired

public java.lang.Object getAttrServiceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceId: The ID of the service.


attrServiceNameRequired

public java.lang.Object getAttrServiceName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceName: The name of the Service, need to fill in manually when sourceType is VIP/DNS/AI.


attrSourceTypeRequired

public java.lang.Object getAttrSourceType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SourceType: The type of the service source, optional value is K8S/MSE_NACOS/FC3/SAE_K8S_SERVICE/VIP/DNS/AI.


propsRequired

public ServiceProps getProps();