ALIYUN::FOAS::Cluster

Syntax

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

Properties

Name	Type	Required	Editable	Description	Validity
OrderId	String	No	No	The order ID.	Specify either Order or OrderId. OrderId is recommended.
Description	String	Yes	No	The cluster description.	None.
ClusterName	String	Yes	No	The cluster name.	3 to 64 characters. Lowercase letters, digits, and underscores (_). Must start with a letter.
OssBucket	String	Yes	No	The OSS bucket name.	None.
VSwitchId	String	Yes	Yes	The vSwitch ID.	None.
Order	Map	No	Yes	The order details.	The AliyunBSSFullAccess policy must be attached to the StreamDefaultRole role. The order cannot be canceled.

Order syntax

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

Order properties

Name	Type	Required	Editable	Description	Validity
PayModel	String	No	No	The billing method. Default: post.	Valid values: pre: subscription. post: pay-as-you-go.
SlaveSpec	String	Yes	No	The slave instance type. Example: Ecs_8c32g.	None.
MasterSpec	String	Yes	Yes	The master instance type. Example: Ecs_4c16g.	None.
SlaveNumber	Integer	No	Yes	The number of slave instances.	Valid values: 2 to 1000. Default: 2.
Period	Integer	No	No	The subscription duration, in months.	Valid values: 1 to 12. Default: 1.
MasterNumber	Integer	No	No	The number of master instances.	Valid values: 1 and 3. Default: 3.

Return values

Fn::GetAtt

OrderId: the order ID.
MasterInstanceInfos: the master instance information.
SecurityGroupId: the security group ID.
ClusterId: the cluster ID.
VSwitchIds: the vSwitch ID.
State: the cluster status.
EngineVersions: the engine version.
SlaveInstanceInfos: the slave instance information.

Examples

JSON format

{
  "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": "Order Id. Only one of property Order or OrderId can be specified.\nOrderId is suggested."
    },
    "Description": {
      "MinLength": 1,
      "Type": "String",
      "Description": "Cluster description."
    },
    "ClusterName": {
      "AllowedPattern": "[a-z][a-z0-9_]{2,63}",
      "Type": "String",
      "Description": "Cluster name. It begins with a letter, and contains only lowercase English letters, numbers, underscores (_), and is limited to 3-64 characters."
    },
    "OssBucket": {
      "MinLength": 1,
      "Type": "String",
      "Description": "Bucket name in your OSS."
    },
    "VSwitchId": {
      "MinLength": 1,
      "Type": "String",
      "Description": "vSwitch ID."
    },
    "Order": {
      "Type": "Json",
      "Description": "Order detail. Only one of property Order or OrderId can be specified. Order is not suggested. Policy AliyunBSSFullAccess must be granted to StreamDefaultRole in RAM console. The order can not be cancelled."
    }
  },
  "Outputs": {
    "OrderId": {
      "Description": "Order ID.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "OrderId"
        ]
      }
    },
    "MasterInstanceInfos": {
      "Description": "Master instance infos.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "MasterInstanceInfos"
        ]
      }
    },
    "SecurityGroupId": {
      "Description": "Security group Id.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "SecurityGroupId"
        ]
      }
    },
    "ClusterId": {
      "Description": "Cluster ID.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ClusterId"
        ]
      }
    },
    "VSwitchIds": {
      "Description": "VSwitch Ids.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "VSwitchIds"
        ]
      }
    },
    "State": {
      "Description": "Cluster status.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "State"
        ]
      }
    },
    "EngineVersions": {
      "Description": "Engine Versions.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "EngineVersions"
        ]
      }
    },
    "SlaveInstanceInfos": {
      "Description": "Slave instance infos.",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "SlaveInstanceInfos"
        ]
      }
    }
  }
}

YAML format

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: |-
      Order Id. Only one of property Order or OrderId can be specified.
      OrderId is suggested.
  Description:
    MinLength: 1
    Type: String
    Description: Cluster description.
  ClusterName:
    AllowedPattern: "[a-z][a-z0-9_]{2,63}"
    Type: String
    Description: Cluster name. It begins with a letter, and contains only lowercase
      English letters, numbers, underscores (_), and is limited to 3-64 characters.
  OssBucket:
    MinLength: 1
    Type: String
    Description: Bucket name in your OSS.
  VSwitchId:
    MinLength: 1
    Type: String
    Description: vSwitch ID.
  Order:
    Type: Json
    Description: Order detail. Only one of property Order or OrderId can be specified.
      Order is not suggested. Policy AliyunBSSFullAccess must be granted to StreamDefaultRole
      in RAM console.nThe order can not be cancelled.
Outputs:
  OrderId:
    Description: Order ID.
    Value:
      Fn::GetAtt:
      - Cluster
      - OrderId
  MasterInstanceInfos:
    Description: Master instance infos.
    Value:
      Fn::GetAtt:
      - Cluster
      - MasterInstanceInfos
  SecurityGroupId:
    Description: Security group Id.
    Value:
      Fn::GetAtt:
      - Cluster
      - SecurityGroupId
  ClusterId:
    Description: Cluster ID.
    Value:
      Fn::GetAtt:
      - Cluster
      - ClusterId
  VSwitchIds:
    Description: vSwitch Ids.
    Value:
      Fn::GetAtt:
      - Cluster
      - VSwitchIds
  State:
    Description: Cluster status.
    Value:
      Fn::GetAtt:
      - Cluster
      - State
  EngineVersions:
    Description: Engine Versions.
    Value:
      Fn::GetAtt:
      - Cluster
      - EngineVersions
  SlaveInstanceInfos:
    Description: Slave instance infos.
    Value:
      Fn::GetAtt:
      - Cluster
      - SlaveInstanceInfos