Use ALIYUN::ComputeNest::ServiceInstance of Compute Nest to create a service instance - Resource Orchestration Service

ALIYUN::ComputeNest::ServiceInstance is used to create and deploy a service instance.

Syntax

{
  "Type": "ALIYUN::ComputeNest::ServiceInstance",
  "Properties": {
    "SpecificationCode": String,
    "Parameters": Map,
    "ResourceGroupId": String,
    "OperationName": String,
    "EnableInstanceOps": Boolean,
    "Service": Map,
    "PredefinedParameterName": String,
    "Name": String,
    "Commodity": Map,
    "EnableUserPrometheus": Boolean,
    "TemplateName": String,
    "MarketInstanceId": String,
    "ContactGroup": String,
    "Tags": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
Service	Map	Yes	No	The service details.	For more information, see Service properties.
Commodity	Map	No	No	The information about the order in Alibaba Cloud Marketplace. You do not need to specify this property when the service is not published in Alibaba Cloud Marketplace or uses the pay-as-you-go billing method.	For more information, see Commodity properties.
ContactGroup	String	No	No	The CloudMonitor contact group that receives alerts.	None.
EnableInstanceOps	Boolean	No	No	Specifies whether the service instance supports the hosted O&M feature.	Valid values: true false
EnableUserPrometheus	Boolean	No	No	Specifies whether to enable the Prometheus monitoring feature.	Valid values: true false
MarketInstanceId	String	No	No	The instance ID in Alibaba Cloud Marketplace.	None.
Name	String	No	No	The service name.	None.
OperationName	String	No	No	The operation name.	None.
Parameters	Map	No	No	The parameters that the customer specifies to deploy the service instance.	Example: `{"NodeCount": 3, "SystemDiskSize": 40, "InstancePassword": "******"}`
PredefinedParameterName	String	No	No	The plan name.	None.
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.
SpecificationCode	String	No	No	The specification code of the product.	None.
Tags	List	No	Yes	The custom tags that the customer adds to the service instance.	`{'Length': {'Max': 20}}`
TemplateName	String	No	No	The template name.	You must specify this property when the service supports multiple templates.

Service syntax

"Service": {
  "Version": String,
  "ServiceId": String
}

Service properties

Property	Type	Required	Editable	Description	Constraint
ServiceId	String	Yes	No	The service ID.	None.
Version	String	No	No	The service version.	None.

Commodity syntax

"Commodity": {
  "PayPeriod": Integer,
  "PayPeriodUnit": String
}

Commodity properties

Property

Type

Required

Editable

Description

Constraint

PayPeriod

Integer

The billing cycle.

None.

PayPeriodUnit

String

The unit of the billing cycle.

Valid values:

Year
Month
Day

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

Property	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The tag key.	The tag key must be 1 to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.
Value	String	No	No	The tag value.	The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.

Return values

Fn::GetAtt

Progress: the deployment progress of the service instance.

Parameters: the parameters that are specified to deploy the service instance.

ResourceGroupId: the ID of the resource group.

EnableInstanceOps: indicates whether the service instance supports the hosted O&M feature.

CreateTime: the creation time.

NetworkConfig: the network configurations.

Service: the service details.

PredefinedParameterName: the plan name.

Source: the source of the service instance.

Name: the name of the service instance.

Components: the additional Alibaba Cloud Marketplace billable items.

LicenseEndTime: the expiration time of the license.

ServiceInstanceId: the ID of the service instance.

UserId: the Alibaba Cloud user ID of the customer.

EnableUserPrometheus: indicates whether the Prometheus monitoring feature is enabled.

ServiceType: the service type.

StatusDetail: the deployment status details of the service instance.

UpdateTime: the update time.

Outputs: the outputs that are returned after the service instance is created.

TemplateName: the template name.

IsOperated: indicates whether the hosted O&M feature is enabled for the service instance.

SupplierUid: the Alibaba Cloud user ID of the service provider.

Tags: the custom tags that the customer adds to the service instance.

Examples

`YAML`

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Parameters:
    Type: Json
    Description: The parameters entered by the deployment service instance.
    Default:
      NodeCount: 3
      SystemDiskSize: 40
      InstancePassword: '******'
  Service:
    Type: Json
    Description: Service details.
    Default:
      Version: 1
      ServiceId: service-9c8a3522528b4fe8****
  Name:
    Type: String
    Description: The name of the service instance.
    Default: test
Resources:
  ExtensionResource:
    Type: ALIYUN::ComputeNest::ServiceInstance
    Properties:
      Parameters:
        Ref: Parameters
      Service:
        Ref: Service
      Name:
        Ref: Name
Outputs:
  Progress:
    Description: The deployment progress of the service instance. Unit:%.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Progress
  Parameters:
    Description: The parameters entered by the deployment service instance.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Parameters

`JSON`

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Parameters": {
      "Type": "Json",
      "Description": "The parameters entered by the deployment service instance.",
      "Default": {
        "NodeCount": 3,
        "SystemDiskSize": 40,
        "InstancePassword": "******"
      }
    },
    "Service": {
      "Type": "Json",
      "Description": "Service details.",
      "Default": {
        "Version": 1,
        "ServiceId": "service-9c8a3522528b4fe8****"
      }
    },
    "Name": {
      "Type": "String",
      "Description": "The name of the service instance.",
      "Default": "test"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ComputeNest::ServiceInstance",
      "Properties": {
        "Parameters": {
          "Ref": "Parameters"
        },
        "Service": {
          "Ref": "Service"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "Progress": {
      "Description": "The deployment progress of the service instance. Unit:%.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Progress"
        ]
      }
    },
    "Parameters": {
      "Description": "The parameters entered by the deployment service instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Parameters"
        ]
      }
    }
  }
}