すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::FOAS::Cluster

最終更新日:Jan 16, 2025

ALIYUN::FOAS::Cluster は、排他モードで注文のクラスターを作成するために使用されます。

構文

{
  "Type": "ALIYUN::FOAS::Cluster",
  "Properties": {
    "OrderId": String,
    "Description": String,
    "ClusterName": String,
    "OssBucket": String,
    "VSwitchId": String,
    "Order": Map
  }
}

プロパティ

名前タイプ必須編集可能説明有効性
OrderIdStringいいえいいえ注文の ID。Order または OrderId のいずれかのみを指定できます。 OrderId を使用することをお勧めします。
DescriptionStringはいいいえクラスターの説明。なし。
ClusterNameStringはいいいえクラスターの名前。名前は 3 ~ 64 文字で、小文字、数字、アンダースコア (_) を使用できます。文字で始める必要があります。
OssBucketStringはいいいえOSS のバケット名。なし。
VSwitchIdStringはいはいvSwitch の ID。なし。
OrderMapいいえはい注文の詳細。AliyunBSSFullAccess ポリシーが StreamDefaultRole ロールにアタッチされている必要があります。注文はキャンセルできません。

Order 構文

"Order": {
  "PayModel": String,
  "SlaveSpec": String,
  "MasterSpec": String,
  "SlaveNumber": Integer,
  "Period": Integer,
  "MasterNumber": Integer
}

Order プロパティ

名前タイプ必須編集可能説明有効性
PayModelStringいいえいいえ請求方法。デフォルト値: post。有効な値:
  • pre: サブスクリプション。
  • post: 従量課金制。
SlaveSpecStringはいいいえSlave インスタンスタイプ。例: Ecs_8c32g。なし。
MasterSpecStringはいはいMaster インスタンスタイプ。例: Ecs_4c16g。なし。
SlaveNumberIntegerいいえはいSlave インスタンスの数。有効な値: 2 ~ 1000。デフォルト値: 2。
PeriodIntegerいいえいいえサブスクリプション期間。単位: 月。有効な値: 1 ~ 12。デフォルト値: 1。
MasterNumberIntegerいいえいいえMaster インスタンスの数。有効な値: 1 と 3。デフォルト値: 3。

レスポンスパラメーター

Fn::GetAtt

  • OrderId: 注文の ID。
  • MasterInstanceInfos: Master インスタンス情報。
  • SecurityGroupId: セキュリティグループの ID。
  • ClusterId: クラスターの ID。
  • VSwitchIds: vSwitch の ID。
  • State: クラスターの状態。
  • EngineVersions: エンジンバージョン。
  • SlaveInstanceInfos: Slave インスタンス情報。

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Cluster": {
      "Type": "ALIYUN::FOAS::Cluster",
      "Properties": {
        "OrderId": {
          "Ref": "OrderId"
        },
        "Description": {
          "Ref": "Description"
        },
        "ClusterName": {
          "Ref": "ClusterName"
        },
        "OssBucket": {
          "Ref": "OssBucket"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "Order": {
          "Ref": "Order"
        }
      }
    }
  },
  "Parameters": {
    "OrderId": {
      "MinLength": 1,
      "Type": "String",
      "Description": "注文 ID。プロパティ Order または OrderId のいずれか 1 つのみを指定できます。\nOrderId をお勧めします。" // Translated comment
    },
    "Description": {
      "MinLength": 1,
      "Type": "String",
      "Description": "クラスターの説明。" // Translated comment
    },
    "ClusterName": {
      "AllowedPattern": "[a-z][a-z0-9_]{2,63}",
      "Type": "String",
      "Description": "クラスター名。文字で始まり、小文字の英字、数字、アンダースコア(_)のみを含み、3 ~ 64 文字に制限されています。" // Translated comment
    },
    "OssBucket": {
      "MinLength": 1,
      "Type": "String",
      "Description": "OSS のバケット名。" // Translated comment
    },
    "VSwitchId": {
      "MinLength": 1,
      "Type": "String",
      "Description": "vSwitch ID。" // Translated comment
    },
    "Order": {
      "Type": "Json",
      "Description": "注文の詳細。プロパティ Order または OrderId のいずれか 1 つのみを指定できます。Order はお勧めしません。RAM コンソールで StreamDefaultRole にポリシー AliyunBSSFullAccess を付与する必要があります。注文はキャンセルできません。" // Translated comment
    }
  },
  "Outputs": {
    "OrderId": {
      "Description": "注文 ID。", // Translated comment
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "OrderId"
        ]
      }
    },
    "MasterInstanceInfos": {
      "Description": "Master インスタンス情報。", // Translated comment
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "MasterInstanceInfos"
        ]
      }
    },
    "SecurityGroupId": {
      "Description": "セキュリティグループ ID。", // Translated comment
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "SecurityGroupId"
        ]
      }
    },
    "ClusterId": {
      "Description": "クラスター ID。", // Translated comment
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ClusterId"
        ]
      }
    },
    "VSwitchIds": {
      "Description": "vSwitch ID。", // Translated comment
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "VSwitchIds"
        ]
      }
    },
    "State": {
      "Description": "クラスターの状態。", // Translated comment
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "State"
        ]
      }
    },
    "EngineVersions": {
      "Description": "エンジンバージョン。", // Translated comment
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "EngineVersions"
        ]
      }
    },
    "SlaveInstanceInfos": {
      "Description": "Slave インスタンス情報。", // Translated comment
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "SlaveInstanceInfos"
        ]
      }
    }
  }
}

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  Cluster:
    Type: ALIYUN::FOAS::Cluster
    Properties:
      OrderId:
        Ref: OrderId
      Description:
        Ref: Description
      ClusterName:
        Ref: ClusterName
      OssBucket:
        Ref: OssBucket
      VSwitchId:
        Ref: VSwitchId
      Order:
        Ref: Order
Parameters:
  OrderId:
    MinLength: 1
    Type: String
    Description: |-
      注文 ID。プロパティ Order または OrderId のいずれか 1 つのみを指定できます。
      OrderId をお勧めします。
  Description:
    MinLength: 1
    Type: String
    Description: クラスターの説明。
  ClusterName:
    AllowedPattern: "[a-z][a-z0-9_]{2,63}"
    Type: String
    Description: クラスター名。文字で始まり、小文字の英字、数字、アンダースコア(_)のみを含み、3 ~ 64 文字に制限されています。
  OssBucket:
    MinLength: 1
    Type: String
    Description: OSS のバケット名。
  VSwitchId:
    MinLength: 1
    Type: String
    Description: vSwitch ID。
  Order:
    Type: Json
    Description: |-
      注文の詳細。プロパティ Order または OrderId のいずれか 1 つのみを指定できます。Order はお勧めしません。RAM コンソールで StreamDefaultRole にポリシー AliyunBSSFullAccess を付与する必要があります。
      注文はキャンセルできません。
Outputs:
  OrderId:
    Description: 注文 ID。
    Value:
      Fn::GetAtt:
      - Cluster
      - OrderId
  MasterInstanceInfos:
    Description: Master インスタンス情報。
    Value:
      Fn::GetAtt:
      - Cluster
      - MasterInstanceInfos
  SecurityGroupId:
    Description: セキュリティグループ ID。
    Value:
      Fn::GetAtt:
      - Cluster
      - SecurityGroupId
  ClusterId:
    Description: クラスター ID。
    Value:
      Fn::GetAtt:
      - Cluster
      - ClusterId
  VSwitchIds:
    Description: vSwitch ID。
    Value:
      Fn::GetAtt:
      - Cluster
      - VSwitchIds
  State:
    Description: クラスターの状態。
    Value:
      Fn::GetAtt:
      - Cluster
      - State
  EngineVersions:
    Description: エンジンバージョン。
    Value:
      Fn::GetAtt:
      - Cluster
      - EngineVersions
  SlaveInstanceInfos:
    Description: Slave インスタンス情報。
    Value:
      Fn::GetAtt:
      - Cluster
      - SlaveInstanceInfos