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 com.aliyun.ros.cdk.computenest.ServiceInstance;
ServiceInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .service(IResolvable)
    .service(ServiceProperty)
//  .commodity(IResolvable)
//  .commodity(CommodityProperty)
//  .contactGroup(java.lang.String)
//  .contactGroup(IResolvable)
//  .enableInstanceOps(java.lang.Boolean)
//  .enableInstanceOps(IResolvable)
//  .enableUserPrometheus(java.lang.Boolean)
//  .enableUserPrometheus(IResolvable)
//  .marketInstanceId(java.lang.String)
//  .marketInstanceId(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .operationName(java.lang.String)
//  .operationName(IResolvable)
//  .parameters(IResolvable)
//  .parameters(java.util.Map<java.lang.String, java.lang.Object>)
//  .predefinedParameterName(java.lang.String)
//  .predefinedParameterName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .specificationCode(java.lang.String)
//  .specificationCode(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .templateName(java.lang.String)
//  .templateName(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.
service com.aliyun.ros.cdk.core.IResolvable OR ServiceProperty Property service: Service details.
commodity com.aliyun.ros.cdk.core.IResolvable OR CommodityProperty Property commodity: Cloud market commodity purchase parameters.
contactGroup java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property contactGroup: Alarm Contact Group.
enableInstanceOps java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableInstanceOps: Whether the service instance has the O & M function.
enableUserPrometheus java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableUserPrometheus: Whether Prometheus monitoring is enabled.
marketInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property marketInstanceId: The ID of the cloud marketplace instance.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the service instance.
operationName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property operationName: Change operation name.
parameters com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property parameters: The parameters entered by the deployment service instance.
predefinedParameterName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property predefinedParameterName: Package name.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
specificationCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property specificationCode: Commodity specification Code.
tags java.util.List<TagsProperty> Property tags: Tags of service instance.
templateName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property templateName: Template name.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

serviceRequired

Property service: Service details.

commodityOptional

Property commodity: Cloud market commodity purchase parameters.

contactGroupOptional

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

Property contactGroup: Alarm Contact Group.

enableInstanceOpsOptional

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

Property enableInstanceOps: Whether the service instance has the O & M function.

Possible values:

  • true: The service instance has a generation O & M function.
  • false: The service instance does not have the O & M function.

enableUserPrometheusOptional

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

Property enableUserPrometheus: Whether Prometheus monitoring is enabled.

Possible values:

  • true: enabled.
  • false: not enabled.

marketInstanceIdOptional

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

Property marketInstanceId: The ID of the cloud marketplace instance.

nameOptional

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

Property name: The name of the service instance.

operationNameOptional

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

Property operationName: Change operation name.

parametersOptional

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

Property parameters: The parameters entered by the deployment service instance.

predefinedParameterNameOptional

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

Property predefinedParameterName: Package name.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group.

specificationCodeOptional

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

Property specificationCode: Commodity specification Code.

tagsOptional

Property tags: Tags of service instance.

templateNameOptional

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

Property templateName: Template name.

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

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.computenest.ServiceInstance;
ServiceInstance.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.
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.
attrComponents com.aliyun.ros.cdk.core.IResolvable Attribute Components: Additional billing items.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: Creation time.
attrEnableInstanceOps com.aliyun.ros.cdk.core.IResolvable Attribute EnableInstanceOps: Whether the service instance has the O & M function.
attrEnableUserPrometheus com.aliyun.ros.cdk.core.IResolvable Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.
attrIsOperated com.aliyun.ros.cdk.core.IResolvable Attribute IsOperated: Whether the generation O & M function of the service instance is enabled.
attrLicenseEndTime com.aliyun.ros.cdk.core.IResolvable Attribute LicenseEndTime: License expiration time.
attrName com.aliyun.ros.cdk.core.IResolvable Attribute Name: The name of the service instance.
attrNetworkConfig com.aliyun.ros.cdk.core.IResolvable Attribute NetworkConfig: Network configuration information.
attrOutputs com.aliyun.ros.cdk.core.IResolvable Attribute Outputs: Create the output Field returned by the service instance.
attrParameters com.aliyun.ros.cdk.core.IResolvable Attribute Parameters: The parameters entered by the deployment service instance.
attrPredefinedParameterName com.aliyun.ros.cdk.core.IResolvable Attribute PredefinedParameterName: Package name.
attrProgress com.aliyun.ros.cdk.core.IResolvable Attribute Progress: The deployment progress of the service instance.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrService com.aliyun.ros.cdk.core.IResolvable Attribute Service: Service details.
attrServiceInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute ServiceInstanceId: The ID of the service instance.
attrServiceType com.aliyun.ros.cdk.core.IResolvable Attribute ServiceType: Service type.
attrSource com.aliyun.ros.cdk.core.IResolvable Attribute Source: The source of the service instance.
attrStatusDetail com.aliyun.ros.cdk.core.IResolvable Attribute StatusDetail: The status description of the deployment instance.
attrSupplierUid com.aliyun.ros.cdk.core.IResolvable Attribute SupplierUid: Service provider AliUid.
attrTags com.aliyun.ros.cdk.core.IResolvable Attribute Tags: User-defined labels.
attrTemplateName com.aliyun.ros.cdk.core.IResolvable Attribute TemplateName: Template name.
attrUpdateTime com.aliyun.ros.cdk.core.IResolvable Attribute UpdateTime: Update time.
attrUserId com.aliyun.ros.cdk.core.IResolvable Attribute UserId: AliUid of the user.

nodeRequired 

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

The construct tree node associated with this construct.

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

attrComponentsRequired 

public IResolvable getAttrComponents();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Components: Additional billing items.

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: Creation time.

attrEnableInstanceOpsRequired 

public IResolvable getAttrEnableInstanceOps();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrEnableUserPrometheusRequired 

public IResolvable getAttrEnableUserPrometheus();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.

attrIsOperatedRequired 

public IResolvable getAttrIsOperated();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrLicenseEndTimeRequired 

public IResolvable getAttrLicenseEndTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LicenseEndTime: License expiration time.

attrNameRequired 

public IResolvable getAttrName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Name: The name of the service instance.

attrNetworkConfigRequired 

public IResolvable getAttrNetworkConfig();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute NetworkConfig: Network configuration information.

attrOutputsRequired 

public IResolvable getAttrOutputs();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrParametersRequired 

public IResolvable getAttrParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrPredefinedParameterNameRequired 

public IResolvable getAttrPredefinedParameterName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PredefinedParameterName: Package name.

attrProgressRequired 

public IResolvable getAttrProgress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Progress: The deployment progress of the service instance.

Unit:%.

attrResourceGroupIdRequired 

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrServiceRequired 

public IResolvable getAttrService();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Service: Service details.

attrServiceInstanceIdRequired 

public IResolvable getAttrServiceInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceInstanceId: The ID of the service instance.

attrServiceTypeRequired 

public IResolvable getAttrServiceType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceType: Service type.

attrSourceRequired 

public IResolvable getAttrSource();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Source: The source of the service instance.

attrStatusDetailRequired 

public IResolvable getAttrStatusDetail();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StatusDetail: The status description of the deployment instance.

attrSupplierUidRequired 

public IResolvable getAttrSupplierUid();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SupplierUid: Service provider AliUid.

attrTagsRequired 

public IResolvable getAttrTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: User-defined labels.

attrTemplateNameRequired 

public IResolvable getAttrTemplateName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TemplateName: Template name.

attrUpdateTimeRequired 

public IResolvable getAttrUpdateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UpdateTime: Update time.

attrUserIdRequired 

public IResolvable getAttrUserId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UserId: AliUid of the user.