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

Service syntax

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

Service properties

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

Commodity syntax

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

Commodity properties

Property

Type

Required

Editable

Description

Constraint

PayPeriod

Integer

The subscription duration.

None.

PayPeriodUnit

String

The unit of the subscription duration.

Valid values:

Year
Month
Day

Tags syntax

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

Tags properties

Property	Type	Required	Editable	Description	Constraint
Value	String	No	No	The value of the tag.	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:`.
Key	String	Yes	No	The key of the tag.	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:`.

Return values

Fn::GetAtt

Progress: the deployment progress of the service instance.
Parameters: the parameters that are specified by the customer 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 time when the service instance was created.
NetworkConfig: the network configurations.
Service: details of the service to which the service instance belongs.
PredefinedParameterName: the plan name.
Source: the source of the service instance.
Name: the name of the service instance.
Components: the additional Alibaba Cloud Marketplace billing items.
LicenseEndTime: the time when the license expires.
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 state details of the service instance.
UpdateTime: the time when the service instance was updated.
Outputs: the outputs that are returned for creating the service instance.
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 format

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 format

{
  "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"
        ]
      }
    }
  }
}