ServiceInstance

• Implements: IServiceInstance

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

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)
//  .dryRun(java.lang.Boolean)
//  .dryRun(IResolvable)
//  .enableInstanceOps(java.lang.Boolean)
//  .enableInstanceOps(IResolvable)
//  .enableUserPrometheus(java.lang.Boolean)
//  .enableUserPrometheus(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)
//  .resourceAutoPay(java.lang.Boolean)
//  .resourceAutoPay(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .serviceInstanceName(java.lang.String)
//  .serviceInstanceName(IResolvable)
//  .specificationCode(java.lang.String)
//  .specificationCode(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .templateName(java.lang.String)
//  .templateName(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

service^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR ServiceProperty

Property service: Service details.

commodity^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR CommodityProperty

Property commodity: The purchase order information of the cloud market does not need to be transmitted if the service is not on the cloud market or charged by volume.

contactGroup^Optional

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

Property contactGroup: Alarm Contact Group.

dryRun^Optional

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

Property dryRun: Whether to perform PreCheck on the creation request, including permissions and instance status verification.

Possible values:

• true: The request is sent without creating a service instance.
• false: Sends the request and creates a service instance after the check is passed.

enableInstanceOps^Optional

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

enableUserPrometheus^Optional

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

operationName^Optional

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

Property operationName: Change operation name.

parameters^Optional

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

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

predefinedParameterName^Optional

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

Property predefinedParameterName: Package name.

resourceAutoPay^Optional

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

Property resourceAutoPay: Whether the resource is automatically deducted from the balance.

Value:

• true: automatic payment.
• false: Do not pay automatically.

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the resource group.

serviceInstanceName^Optional

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

Property serviceInstanceName: The name of the service instance.

specificationCode^Optional

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

Property specificationCode: Commodity specification Code.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags of service instance.

templateName^Optional

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

Property templateName: Template name.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.computenest.ServiceInstance;
ServiceInstance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrComponents^Required

public java.lang.Object getAttrComponents();

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

Attribute Components: Additional billing items.

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

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

Attribute CreateTime: Creation time.

attrEnableInstanceOps^Required

public java.lang.Object getAttrEnableInstanceOps();

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

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

attrEnableUserPrometheus^Required

public java.lang.Object getAttrEnableUserPrometheus();

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

Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.

attrIsOperated^Required

public java.lang.Object getAttrIsOperated();

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

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

attrLicenseEndTime^Required

public java.lang.Object getAttrLicenseEndTime();

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

Attribute LicenseEndTime: License expiration time.

attrMarketInstanceId^Required

public java.lang.Object getAttrMarketInstanceId();

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

Attribute MarketInstanceId: The ID of the cloud marketplace instance.

attrNetworkConfig^Required

public java.lang.Object getAttrNetworkConfig();

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

Attribute NetworkConfig: Network configuration information.

attrOutput^Required

public java.lang.Object getAttrOutput();

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

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

attrOutputs^Required

public java.lang.Object getAttrOutputs();

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

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

attrParameters^Required

public java.lang.Object getAttrParameters();

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

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

attrPredefinedParameterName^Required

public java.lang.Object getAttrPredefinedParameterName();

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

Attribute PredefinedParameterName: Package name.

attrProgress^Required

public java.lang.Object getAttrProgress();

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

Attribute Progress: The deployment progress of the service instance.

Unit:%.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

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

Attribute ResourceGroupId: The ID of the resource group.

attrService^Required

public java.lang.Object getAttrService();

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

Attribute Service: Service details.

attrServiceInstanceId^Required

public java.lang.Object getAttrServiceInstanceId();

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

Attribute ServiceInstanceId: The ID of the service instance.

attrServiceInstanceName^Required

public java.lang.Object getAttrServiceInstanceName();

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

Attribute ServiceInstanceName: The name of the resource.

attrServiceType^Required

public java.lang.Object getAttrServiceType();

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

Attribute ServiceType: Service type.

attrSource^Required

public java.lang.Object getAttrSource();

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

Attribute Source: The source of the service instance.

attrStatusDetail^Required

public java.lang.Object getAttrStatusDetail();

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

Attribute StatusDetail: The status description of the deployment instance.

attrSupplierUid^Required

public java.lang.Object getAttrSupplierUid();

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

Attribute SupplierUid: Service provider AliUid.

attrTags^Required

public java.lang.Object getAttrTags();

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

Attribute Tags: User-defined labels.

attrTemplateName^Required

public java.lang.Object getAttrTemplateName();

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

Attribute TemplateName: Template name.

attrUpdateTime^Required

public java.lang.Object getAttrUpdateTime();

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

Attribute UpdateTime: Update time.

attrUserId^Required

public java.lang.Object getAttrUserId();

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

Attribute UserId: AliUid of the user.

props^Required

public ServiceInstanceProps getProps();

• Type: ServiceInstanceProps