Skip to content

ServiceInstance

This class encapsulates and extends the ROS resource type ALIYUN::ComputeNest::ServiceInstance.

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

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.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
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 string | @alicloud/ros-cdk-core.IResolvable Attribute Components: Additional billing items.
attrCreateTime string | @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: Creation time.
attrEnableInstanceOps string | @alicloud/ros-cdk-core.IResolvable Attribute EnableInstanceOps: Whether the service instance has the O & M function.
attrEnableUserPrometheus string | @alicloud/ros-cdk-core.IResolvable Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.
attrIsOperated string | @alicloud/ros-cdk-core.IResolvable Attribute IsOperated: Whether the generation O & M function of the service instance is enabled.
attrLicenseEndTime string | @alicloud/ros-cdk-core.IResolvable Attribute LicenseEndTime: License expiration time.
attrMarketInstanceId string | @alicloud/ros-cdk-core.IResolvable Attribute MarketInstanceId: The ID of the cloud marketplace instance.
attrNetworkConfig string | @alicloud/ros-cdk-core.IResolvable Attribute NetworkConfig: Network configuration information.
attrOutput string | @alicloud/ros-cdk-core.IResolvable Attribute Output: Create the output Field returned by the service instance.
attrOutputs string | @alicloud/ros-cdk-core.IResolvable Attribute Outputs: Create the output Field returned by the service instance.
attrParameters string | @alicloud/ros-cdk-core.IResolvable Attribute Parameters: The parameters entered by the deployment service instance.
attrPredefinedParameterName string | @alicloud/ros-cdk-core.IResolvable Attribute PredefinedParameterName: Package name.
attrProgress string | @alicloud/ros-cdk-core.IResolvable Attribute Progress: The deployment progress of the service instance.
attrResourceGroupId string | @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrService string | @alicloud/ros-cdk-core.IResolvable Attribute Service: Service details.
attrServiceInstanceId string | @alicloud/ros-cdk-core.IResolvable Attribute ServiceInstanceId: The ID of the service instance.
attrServiceInstanceName string | @alicloud/ros-cdk-core.IResolvable Attribute ServiceInstanceName: The name of the resource.
attrServiceType string | @alicloud/ros-cdk-core.IResolvable Attribute ServiceType: Service type.
attrSource string | @alicloud/ros-cdk-core.IResolvable Attribute Source: The source of the service instance.
attrStatusDetail string | @alicloud/ros-cdk-core.IResolvable Attribute StatusDetail: The status description of the deployment instance.
attrSupplierUid string | @alicloud/ros-cdk-core.IResolvable Attribute SupplierUid: Service provider AliUid.
attrTags string | @alicloud/ros-cdk-core.IResolvable Attribute Tags: User-defined labels.
attrTemplateName string | @alicloud/ros-cdk-core.IResolvable Attribute TemplateName: Template name.
attrUpdateTime string | @alicloud/ros-cdk-core.IResolvable Attribute UpdateTime: Update time.
attrUserId string | @alicloud/ros-cdk-core.IResolvable Attribute UserId: AliUid of the user.
props ServiceInstanceProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

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.


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: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Components: Additional billing items.


attrCreateTimeRequired

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

Attribute CreateTime: Creation time.


attrEnableInstanceOpsRequired

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

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


attrEnableUserPrometheusRequired

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

Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.


attrIsOperatedRequired

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

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


attrLicenseEndTimeRequired

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

Attribute LicenseEndTime: License expiration time.


attrMarketInstanceIdRequired

public readonly attrMarketInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MarketInstanceId: The ID of the cloud marketplace instance.


attrNetworkConfigRequired

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

Attribute NetworkConfig: Network configuration information.


attrOutputRequired

public readonly attrOutput: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrOutputsRequired

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

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


attrParametersRequired

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

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


attrPredefinedParameterNameRequired

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

Attribute PredefinedParameterName: Package name.


attrProgressRequired

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

Attribute Progress: The deployment progress of the service instance.

Unit:%.


attrResourceGroupIdRequired

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

Attribute ResourceGroupId: The ID of the resource group.


attrServiceRequired

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

Attribute Service: Service details.


attrServiceInstanceIdRequired

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

Attribute ServiceInstanceId: The ID of the service instance.


attrServiceInstanceNameRequired

public readonly attrServiceInstanceName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ServiceInstanceName: The name of the resource.


attrServiceTypeRequired

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

Attribute ServiceType: Service type.


attrSourceRequired

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

Attribute Source: The source of the service instance.


attrStatusDetailRequired

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

Attribute StatusDetail: The status description of the deployment instance.


attrSupplierUidRequired

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

Attribute SupplierUid: Service provider AliUid.


attrTagsRequired

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

Attribute Tags: User-defined labels.


attrTemplateNameRequired

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

Attribute TemplateName: Template name.


attrUpdateTimeRequired

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

Attribute UpdateTime: Update time.


attrUserIdRequired

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

Attribute UserId: AliUid of the user.


propsRequired

public readonly props: ServiceInstanceProps;