Skip to content

ServiceInstance

This class encapsulates and extends the ROS resource type ALIYUN::ComputeNest::ServiceInstance, which is used to create and deploy a service instance.

Initializers 

import { ServiceInstance } from '@alicloud/ros-cdk-computenest'
new ServiceInstance(scope: Construct, id: string, props: ServiceInstanceProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props ServiceInstanceProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

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

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

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.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount 

public addCount(count: number | IResolvable): void

countRequired

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

addDependency 

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

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

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

import { ServiceInstance } from '@alicloud/ros-cdk-computenest'
ServiceInstance.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrComponents @alicloud/ros-cdk-core.IResolvable Attribute Components: Additional billing items.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: Creation time.
attrEnableInstanceOps @alicloud/ros-cdk-core.IResolvable Attribute EnableInstanceOps: Whether the service instance has the O & M function.
attrEnableUserPrometheus @alicloud/ros-cdk-core.IResolvable Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.
attrIsOperated @alicloud/ros-cdk-core.IResolvable Attribute IsOperated: Whether the generation O & M function of the service instance is enabled.
attrLicenseEndTime @alicloud/ros-cdk-core.IResolvable Attribute LicenseEndTime: License expiration time.
attrName @alicloud/ros-cdk-core.IResolvable Attribute Name: The name of the service instance.
attrNetworkConfig @alicloud/ros-cdk-core.IResolvable Attribute NetworkConfig: Network configuration information.
attrOutputs @alicloud/ros-cdk-core.IResolvable Attribute Outputs: Create the output Field returned by the service instance.
attrParameters @alicloud/ros-cdk-core.IResolvable Attribute Parameters: The parameters entered by the deployment service instance.
attrPredefinedParameterName @alicloud/ros-cdk-core.IResolvable Attribute PredefinedParameterName: Package name.
attrProgress @alicloud/ros-cdk-core.IResolvable Attribute Progress: The deployment progress of the service instance.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrService @alicloud/ros-cdk-core.IResolvable Attribute Service: Service details.
attrServiceInstanceId @alicloud/ros-cdk-core.IResolvable Attribute ServiceInstanceId: The ID of the service instance.
attrServiceType @alicloud/ros-cdk-core.IResolvable Attribute ServiceType: Service type.
attrSource @alicloud/ros-cdk-core.IResolvable Attribute Source: The source of the service instance.
attrStatusDetail @alicloud/ros-cdk-core.IResolvable Attribute StatusDetail: The status description of the deployment instance.
attrSupplierUid @alicloud/ros-cdk-core.IResolvable Attribute SupplierUid: Service provider AliUid.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: User-defined labels.
attrTemplateName @alicloud/ros-cdk-core.IResolvable Attribute TemplateName: Template name.
attrUpdateTime @alicloud/ros-cdk-core.IResolvable Attribute UpdateTime: Update time.
attrUserId @alicloud/ros-cdk-core.IResolvable Attribute UserId: AliUid of the user.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrComponentsRequired 

public readonly attrComponents: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Components: Additional billing items.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: Creation time.

attrEnableInstanceOpsRequired 

public readonly attrEnableInstanceOps: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnableInstanceOps: Whether the service instance has the O & M function.

attrEnableUserPrometheusRequired 

public readonly attrEnableUserPrometheus: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.

attrIsOperatedRequired 

public readonly attrIsOperated: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IsOperated: Whether the generation O & M function of the service instance is enabled.

attrLicenseEndTimeRequired 

public readonly attrLicenseEndTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute LicenseEndTime: License expiration time.

attrNameRequired 

public readonly attrName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Name: The name of the service instance.

attrNetworkConfigRequired 

public readonly attrNetworkConfig: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NetworkConfig: Network configuration information.

attrOutputsRequired 

public readonly attrOutputs: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Outputs: Create the output Field returned by the service instance.

attrParametersRequired 

public readonly attrParameters: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Parameters: The parameters entered by the deployment service instance.

attrPredefinedParameterNameRequired 

public readonly attrPredefinedParameterName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PredefinedParameterName: Package name.

attrProgressRequired 

public readonly attrProgress: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Progress: The deployment progress of the service instance.

Unit:%.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrServiceRequired 

public readonly attrService: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Service: Service details.

attrServiceInstanceIdRequired 

public readonly attrServiceInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ServiceInstanceId: The ID of the service instance.

attrServiceTypeRequired 

public readonly attrServiceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ServiceType: Service type.

attrSourceRequired 

public readonly attrSource: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Source: The source of the service instance.

attrStatusDetailRequired 

public readonly attrStatusDetail: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StatusDetail: The status description of the deployment instance.

attrSupplierUidRequired 

public readonly attrSupplierUid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SupplierUid: Service provider AliUid.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: User-defined labels.

attrTemplateNameRequired 

public readonly attrTemplateName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute TemplateName: Template name.

attrUpdateTimeRequired 

public readonly attrUpdateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute UpdateTime: Update time.

attrUserIdRequired 

public readonly attrUserId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute UserId: AliUid of the user.