ALIYUN::ComputeNest::ServiceInstance リソースリファレンス - ROS

ALIYUN::ComputeNest::ServiceInstance タイプは、サービスインスタンスを作成およびデプロイするために使用されます。

構文

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

プロパティ

プロパティ	タイプ	必須	更新を許可	説明	制約
Service	Map	はい	いいえ	サービスの詳細。	詳細については、「Service のプロパティ」をご参照ください。
Commodity	Map	いいえ	いいえ	Alibaba Cloud Marketplace から購入するための注文情報。サービスが Alibaba Cloud Marketplace で利用できない場合、または従量課金方法を使用している場合、このパラメーターは不要です。	詳細については、「Commodity のプロパティ」をご参照ください。
ContactGroup	String	いいえ	いいえ	アラートを受信する Cloud Monitor 連絡先グループ。	なし
EnableInstanceOps	Boolean	いいえ	いいえ	サービスインスタンスの O&M 機能を有効にするかどうかを指定します。	有効な値: true: サービスインスタンスの O&M 機能が有効になります。 false: サービスインスタンスの O&M 機能は有効になりません。
EnableUserPrometheus	Boolean	いいえ	はい	Prometheus モニタリングを有効にするかどうかを指定します。	有効な値: true: 有効。 false: Prometheus モニタリングは無効になります。
OperationName	String	いいえ	いいえ	操作の名前。	なし
Parameters	Map	いいえ	はい	サービスインスタンスをデプロイするためのパラメーター。	例: `{"NodeCount": 3, "SystemDiskSize": 40, "InstancePassword": "******"}`
PredefinedParameterName	String	いいえ	はい	パッケージの名前。	なし
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし
SpecificationCode	String	いいえ	いいえ	商品コード。	なし
Tags	List	いいえ	いいえ	カスタムタグ。	`{'Length': {'Max': 20}}`
TemplateName	String	いいえ	いいえ	テンプレートの名前。	サービスが複数のテンプレートをサポートしている場合は、このパラメーターを指定する必要があります。
ServiceInstanceName	String	いいえ	いいえ	サービスインスタンスの名前。	なし
ResourceAutoPay	Boolean	いいえ	いいえ	リソースの自動支払いを有効にするかどうかを指定します。	有効な値: true: 自動支払いが有効になります。 false: 自動支払いは無効になります。
DryRun	Boolean	いいえ	いいえ	作成リクエストのドライランを実行するかどうかを指定します。	ドライランは権限とインスタンスのステータスをチェックします。有効な値: true: リクエストを送信しますが、サービスインスタンスは作成しません。 false: リクエストを送信し、チェックに合格した後にサービスインスタンスを作成します。

サービスの構文

"Service": {
  "ServiceInfos": List,
  "ServiceDocUrl": String,
  "DeployType": String,
  "ServiceProductUrl": String,
  "ServiceType": String,
  "SupplierUrl": String,
  "Status": String,
  "SupplierName": String,
  "PublishTime": String,
  "UpgradableServiceVersions": List,
  "DeployMetadata": String,
  "VersionName": String,
  "UpgradeMetadata": String,
  "Version": String,
  "ServiceId": String
}

サービスのプロパティ

プロパティ	タイプ	必須	更新を許可	説明	制約
ServiceInfos	List	いいえ	いいえ	サービスに関する情報。	詳細については、「ServiceInfos のプロパティ」をご参照ください。
ServiceDocUrl	String	いいえ	いいえ	プロダクトドキュメントの URL。	なし
DeployType	String	いいえ	いいえ	デプロイメントタイプ。	有効な値: ros: サービスは ROS を使用してデプロイされます。 terraform: サービスは Terraform を使用してデプロイされます。 ack: サービスは ACK を使用してデプロイされます。 spi: サービスは SPI を呼び出すことによってデプロイされます。 Operation: 運用保守 (O&M) のためのマネージドサービスデプロイメント。
Version	String	いいえ	いいえ	サービスプロバイダーのバージョン。	なし
ServiceId	String	はい	いいえ	サービス ID。	なし
ServiceProductUrl	String	いいえ	いいえ	製品ページの URL。	なし
ServiceType	String	いいえ	いいえ	サービスタイプ。	有効な値: private: サービスはユーザーのアカウントにデプロイされます。 managed: サービスはサービスプロバイダーのアカウントにデプロイされます。 operation: サービスは Alibaba Cloud マネージドサービスです。
SupplierUrl	String	いいえ	いいえ	サービスプロバイダーのアドレス。	なし
Status	String	いいえ	いいえ	サービスインスタンスのデプロイメントステータス。	有効な値: Created: サービスインスタンスが作成されました。 Deploying: サービスインスタンスはデプロイ中です。 DeployedFailed: サービスインスタンスのデプロイに失敗しました。 Deployed: サービスインスタンスがデプロイされました。 Upgrading: サービスインスタンスはアップグレード中です。 Deleting Deleted: 削除されました。 DeletedFailed: サービスインスタンスの削除に失敗しました。
SupplierName	String	いいえ	いいえ	サービスプロバイダーの名前。	なし
PublishTime	String	いいえ	いいえ	サービスが公開された時間。	なし
UpgradableServiceVersions	List	いいえ	いいえ	サービスをアップグレードできるサービスバージョンのリスト。	なし
DeployMetadata	String	いいえ	いいえ	サービスのデプロイメント構成に関する情報。	なし
VersionName	String	いいえ	いいえ	サービスプロバイダーによって定義されたカスタムバージョン名。	なし
UpgradeMetadata	String	いいえ	いいえ	アップグレードメタデータ。	なし

ServiceInfos の構文

"ServiceInfos": [
  {
    "Image": String,
    "Locale": String,
    "Name": String,
    "ShortDescription": String
  }
]

ServiceInfos のプロパティ

プロパティ	タイプ	必須	更新を許可	説明	制約
Image	String	いいえ	いいえ	サービスアイコンの URL。	なし
Locale	String	いいえ	いいえ	サービスインスタンスの言語。	なし
Name	String	いいえ	いいえ	サービスの名前。	なし
ShortDescription	String	いいえ	いいえ	サービスの説明。	なし

商品の構文

"Commodity": {
  "PayPeriod": Integer,
  "PayPeriodUnit": String,
  "AutoRenew": Boolean,
  "CouponId": String,
  "AutoPay": Boolean
}

商品プロパティ

プロパティ	タイプ	必須	更新を許可	説明	制約
PayPeriod	Integer	いいえ	いいえ	サブスクリプション期間。	なし
PayPeriodUnit	String	いいえ	いいえ	サブスクリプション期間の単位。	有効な値: Year Month Day
AutoRenew	Boolean	いいえ	いいえ	自動更新を有効にするかどうかを指定します。	有効な値: true: 自動更新が有効になります。 false: 自動更新は無効になります。
CouponId	String	いいえ	いいえ	クーポン ID。	なし
AutoPay	Boolean	いいえ	いいえ	注文の自動支払いを有効にするかどうかを指定します。	有効な値: true: 自動支払いが有効になります。 false: 自動支払いは無効になります。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	更新を許可	説明	制約
Key	String	はい	いいえ	タグのキー。	タグキーは 1～128 文字である必要があります。`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。
Value	String	いいえ	いいえ	タグの値。	タグ値は 0～128 文字である必要があります。`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。

戻り値

Fn::GetAtt

Progress: サービスインスタンスのデプロイメントの進行状況。

Parameters: サービスインスタンスのデプロイメントパラメーター。

ResourceGroupId: リソースグループの ID。

EnableInstanceOps: サービスインスタンスに対して運用保守 (O&M) 機能が有効になっているかどうかを示します。

CreateTime: サービスインスタンスが作成された時間。

NetworkConfig: ネットワーク構成。

Service: サービスの詳細。

PredefinedParameterName: パッケージの名前。

Source: サービスインスタンスのソース。

Components: Alibaba Cloud Marketplace の課金項目。

LicenseEndTime: ライセンスの有効期限が切れる時間。

ServiceInstanceId: サービスインスタンスの ID。

UserId: ユーザーの Alibaba Cloud アカウント ID。

EnableUserPrometheus: Prometheus モニタリングが有効になっているかどうかを示します。

ServiceType: サービスの種類。

StatusDetail: インスタンスのデプロイメントステータスの詳細。

UpdateTime: 最終更新の時間。

Outputs: サービスインスタンスの作成時に返されるフィールド。

TemplateName: テンプレートの名前。

IsOperated: サービスインスタンスに対して O&M 機能が有効になっているかどうかを示します。

SupplierUid: サービスプロバイダーの Alibaba Cloud アカウント ID。

Tags: カスタムタグ。

Output: サービスインスタンスの作成後に返される出力フィールド。

ServiceInstanceName: サービスインスタンスの名前。

MarketInstanceId: Alibaba Cloud Marketplace インスタンスの ID。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Parameters:
    Type: Json
    Description: サービスインスタンスをデプロイするためのパラメーター。
    Default:
      NodeCount: 3
      SystemDiskSize: 40
      InstancePassword: '******'
  Service:
    Type: Json
    Description: サービスの詳細。
    Default:
      Version: 1
      ServiceId: service-9c8a3522528b4fe8****
Resources:
  ExtensionResource:
    Type: ALIYUN::ComputeNest::ServiceInstance
    Properties:
      Parameters:
        Ref: Parameters
      Service:
        Ref: Service
Outputs:
  Progress:
    Description: サービスインスタンスのデプロイメントの進行状況。単位: %。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Progress
  Parameters:
    Description: サービスインスタンスをデプロイするためのパラメーター。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Parameters

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Parameters": {
      "Type": "Json",
      "Description": "サービスインスタンスをデプロイするためのパラメーター。",
      "Default": {
        "NodeCount": 3,
        "SystemDiskSize": 40,
        "InstancePassword": "******"
      }
    },
    "Service": {
      "Type": "Json",
      "Description": "サービスの詳細。",
      "Default": {
        "Version": 1,
        "ServiceId": "service-9c8a3522528b4fe8****"
      }
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ComputeNest::ServiceInstance",
      "Properties": {
        "Parameters": {
          "Ref": "Parameters"
        },
        "Service": {
          "Ref": "Service"
        }
      }
    }
  },
  "Outputs": {
    "Progress": {
      "Description": "サービスインスタンスのデプロイメントの進行状況。単位: %。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Progress"
        ]
      }
    },
    "Parameters": {
      "Description": "サービスインスタンスをデプロイするためのパラメーター。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Parameters"
        ]
      }
    }
  }
}