Service

• Implements: @alicloud/ros-cdk-apig.datasource.IService

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

Initializers

import { datasource } from '@alicloud/ros-cdk-apig'
new datasource.Service(scope: Construct, id: string, props: ServiceProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: ServiceProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { datasource } from '@alicloud/ros-cdk-apig'
datasource.Service.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrAddresses^Required

public readonly attrAddresses: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrAiServiceConfig^Required

public readonly attrAiServiceConfig: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AiServiceConfig: AI service configuration when sourceType equals AI.

attrGatewayId^Required

public readonly attrGatewayId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrGroupName^Required

public readonly attrGroupName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute GroupName: The service group name.

attrNamespace^Required

public readonly attrNamespace: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Namespace: The namespace of the service:.

attrQualifier^Required

public readonly attrQualifier: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Qualifier: The function version or alias.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrServiceId^Required

public readonly attrServiceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ServiceId: The ID of the service.

attrServiceName^Required

public readonly attrServiceName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrSourceType^Required

public readonly attrSourceType: string | IResolvable;

• Type: string | @alicloud/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^Required

public readonly props: ServiceProps;

• Type: ServiceProps