FOAS Project Resource Properties & Syntax in ROS - ROS - Alibaba Cloud - Resource Orchestration Service

The ALIYUN::FOAS::Project resource type creates a project in a cluster.

Syntax

{
  "Type": "ALIYUN::FOAS::Project",
  "Properties": {
    "OrderId": String,
    "DeployType": String,
    "Description": String,
    "ManagerIds": String,
    "ClusterId": String,
    "Name": String
  }
}

Properties

Property name	Type	Required	Updatable	Description	Constraints
OrderId	String	No	No	The instance ID for the shared mode.	Required only for shared mode.
DeployType	String	Yes	No	The cluster type.	Valid values: cell: dedicated cluster. public: shared cluster.
Description	String	No	No	The project description.	None.
ManagerIds	String	Yes	No	The account IDs of the managers.	Separate multiple account IDs with a comma (,).
ClusterId	String	No	No	The cluster ID.	None.
Name	String	Yes	No	The project name.	The name must be 3 to 64 characters in length. It must start with a lowercase letter and can contain only lowercase letters, digits, and underscores (_).

Return value

Fn::GetAtt

State: The state of the project.

Examples

JSON format:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Project": {
      "Type": "ALIYUN::FOAS::Project",
      "Properties": {
        "OrderId": {
          "Ref": "OrderId"
        },
        "DeployType": {
          "Ref": "DeployType"
        },
        "Description": {
          "Ref": "Description"
        },
        "ManagerIds": {
          "Ref": "ManagerIds"
        },
        "ClusterId": {
          "Ref": "ClusterId"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Parameters": {
    "OrderId": {
      "MinLength": 1,
      "Type": "String",
      "Description": "Order Id of Shared cluster."
    },
    "DeployType": {
      "Type": "String",
      "Description": "Cluster type: Exclusive cluster: cell. Shared cluster: public",
      "AllowedValues": [
        "cell",
        "public"
      ]
    },
    "Description": {
      "MinLength": 1,
      "Type": "String",
      "Description": "Project description."
    },
    "ManagerIds": {
      "MinLength": 1,
      "Type": "String",
      "Description": "Comma delimited account Id list of managers."
    },
    "ClusterId": {
      "MinLength": 1,
      "Type": "String",
      "Description": "Cluster ID."
    },
    "Name": {
      "AllowedPattern": "[a-z][a-z0-9_]{2,63}",
      "Type": "String",
      "Description": "Project name. It begins with a letter, and contains only lowercase English letters, numbers, underscores (_), and is limited to 3-64 characters."
    }
  },
  "Outputs": {
    "State": {
      "Description": "Project state.",
      "Value": {
        "Fn::GetAtt": [
          "Project",
          "State"
        ]
      }
    }
  }
}

YAML format:

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  Project:
    Type: ALIYUN::FOAS::Project
    Properties:
      OrderId:
        Ref: OrderId
      DeployType:
        Ref: DeployType
      Description:
        Ref: Description
      ManagerIds:
        Ref: ManagerIds
      ClusterId:
        Ref: ClusterId
      Name:
        Ref: Name
Parameters:
  OrderId:
    MinLength: 1
    Type: String
    Description: Order Id of Shared cluster.
  DeployType:
    Type: String
    Description: 'Cluster type: Exclusive cluster: cell. Shared cluster: public'
    AllowedValues:
    - cell
    - public
  Description:
    MinLength: 1
    Type: String
    Description: Project description.
  ManagerIds:
    MinLength: 1
    Type: String
    Description: Comma delimited account Id list of managers.
  ClusterId:
    MinLength: 1
    Type: String
    Description: Cluster ID.
  Name:
    AllowedPattern: "[a-z][a-z0-9_]{2,63}"
    Type: String
    Description: Project name. It begins with a letter, and contains only lowercase
      English letters, numbers, underscores (_), and is limited to 3-64 characters.
Outputs:
  State:
    Description: Project state.
    Value:
      Fn::GetAtt:
      - Project
      - State