ALIYUN::PAI::Quota - Resource Orchestration Service - Alibaba Cloud Documentation Center

The ALIYUN::PAI::Quota type creates a resource quota.

Syntax

{
  "Type": "ALIYUN::PAI::Quota",
  "Properties": {
    "QuotaName": String,
    "AllocateStrategy": String,
    "ClusterSpec": Map,
    "Description": String,
    "Labels": List,
    "Min": Map,
    "ParentQuotaId": String,
    "QuotaConfig": Map,
    "QueueStrategy": String,
    "ResourceGroupIds": List,
    "ResourceType": String
  }
}

Properties

Parameter	Type	Required	Editable	Description	Constraint
QuotaName	String	Yes	Yes	The quota name.	None
AllocateStrategy	String	No	Yes	The allocation strategy.	Valid values: ByNodeSpecs
ClusterSpec	Map	No	Yes	The cluster specification.	None
Description	String	No	Yes	A description of the quota.	None
Labels	List	No	Yes	The labels for the quota.	For more information, see Labels properties.
Min	Map	No	Yes	The minimum resource allocation configuration.	For more information, see Min properties.
ParentQuotaId	String	No	No	The parent quota ID.	None
QueueStrategy	String	No	Yes	The queue strategy.	None
QuotaConfig	Map	No	Yes	The quota configuration.	None
ResourceGroupIds	List	No	Yes	The IDs of the resource groups.	None
ResourceType	String	No	No	The resource type.	Valid values: Lingjun ECS ACS

Min syntax

"Min": {
  "ResourceAmount": Map,
  "NodeSpecs": List
}

Min properties

Parameter	Type	Required	Editable	Description	Constraint
NodeSpecs	List	No	No	The node specifications.	None
ResourceAmount	Map	No	No	The resource amount.	None

Labels syntax

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

Labels properties

Parameter	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The label key.	None
Value	String	Yes	No	The label value.	None

Return values

Fn::GetAtt

QuotaId: The ID of the quota.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AllocateStrategy:
    AllowedValues:
      - ByNodeSpecs
    Description:
      en: The allocation strategy.
    Required: false
    Type: String
  ClusterSpec:
    Description:
      en: The cluster specification.
    Required: false
    Type: Json
  Description:
    AssociationProperty: TextArea
    Description:
      en: The description of the quota.
    Required: false
    Type: String
  Labels:
    AssociationProperty: List[Parameters]
    AssociationPropertyMetadata:
      Parameters:
        Key:
          Required: true
          Type: String
        Value:
          Required: true
          Type: String
    Description:
      en: The labels associated with the quota.
    Required: false
    Type: Json
  Min:
    AssociationPropertyMetadata:
      Parameters:
        NodeSpecs:
          AssociationProperty: List[Parameter]
          AssociationPropertyMetadata:
            Parameter:
              Required: false
              Type: Json
          Description:
            en: The node specifications.
          Required: false
          Type: Json
        ResourceAmount:
          Description:
            en: The resource amount.
          Required: false
          Type: Json
    Description:
      en: The minimum resource allocation configuration.
    Required: false
    Type: Json
  ParentQuotaId:
    Description:
      en: The ID of the parent quota.
    Required: false
    Type: String
  QueueStrategy:
    Description:
      en: The queue strategy.
    Required: false
    Type: String
  QuotaConfig:
    Description:
      en: The quota configuration.
    Required: false
    Type: Json
  QuotaName:
    Description:
      en: The name of the quota.
    Required: true
    Type: String
  ResourceGroupIds:
    AssociationProperty: List[Parameter]
    AssociationPropertyMetadata:
      Parameter:
        AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
        Required: false
        Type: String
    Description:
      en: The list of resource group IDs.
    Required: false
    Type: Json
  ResourceType:
    AllowedValues:
      - Lingjun
      - ECS
      - ACS
    Description:
      en: The type of the resource.
    Required: false
    Type: String
Resources:
  Quota:
    Properties:
      AllocateStrategy:
        Ref: AllocateStrategy
      ClusterSpec:
        Ref: ClusterSpec
      Description:
        Ref: Description
      Labels:
        Ref: Labels
      Min:
        Ref: Min
      ParentQuotaId:
        Ref: ParentQuotaId
      QueueStrategy:
        Ref: QueueStrategy
      QuotaConfig:
        Ref: QuotaConfig
      QuotaName:
        Ref: QuotaName
      ResourceGroupIds:
        Ref: ResourceGroupIds
      ResourceType:
        Ref: ResourceType
    Type: ALIYUN::PAI::Quota
Outputs:
  QuotaId:
    Description: The ID of the quota.
    Value:
      Fn::GetAtt:
        - Quota
        - QuotaId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "QuotaName": {
      "Type": "String",
      "Description": {
        "en": "The name of the quota."
      },
      "Required": true
    },
    "Min": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "ResourceAmount": {
            "Type": "Json",
            "Description": {
              "en": "The resource amount."
            },
            "Required": false
          },
          "NodeSpecs": {
            "AssociationPropertyMetadata": {
              "Parameter": {
                "Type": "Json",
                "Required": false
              }
            },
            "Type": "Json",
            "AssociationProperty": "List[Parameter]",
            "Description": {
              "en": "The node specifications."
            },
            "Required": false
          }
        }
      },
      "Type": "Json",
      "Description": {
        "en": "The minimum resource allocation configuration."
      },
      "Required": false
    },
    "Description": {
      "Type": "String",
      "AssociationProperty": "TextArea",
      "Description": {
        "en": "The description of the quota."
      },
      "Required": false
    },
    "ResourceGroupIds": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
          "Required": false
        }
      },
      "Type": "Json",
      "AssociationProperty": "List[Parameter]",
      "Description": {
        "en": "The list of resource group IDs."
      },
      "Required": false
    },
    "AllocateStrategy": {
      "Type": "String",
      "Description": {
        "en": "The allocation strategy."
      },
      "AllowedValues": [
        "ByNodeSpecs"
      ],
      "Required": false
    },
    "QuotaConfig": {
      "Type": "Json",
      "Description": {
        "en": "The quota configuration."
      },
      "Required": false
    },
    "ResourceType": {
      "Type": "String",
      "Description": {
        "en": "The type of the resource."
      },
      "AllowedValues": [
        "Lingjun",
        "ECS",
        "ACS"
      ],
      "Required": false
    },
    "Labels": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "Value": {
            "Type": "String",
            "Required": true
          },
          "Key": {
            "Type": "String",
            "Required": true
          }
        }
      },
      "Type": "Json",
      "AssociationProperty": "List[Parameters]",
      "Description": {
        "en": "The labels associated with the quota."
      },
      "Required": false
    },
    "ClusterSpec": {
      "Type": "Json",
      "Description": {
        "en": "The cluster specification."
      },
      "Required": false
    },
    "ParentQuotaId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the parent quota."
      },
      "Required": false
    },
    "QueueStrategy": {
      "Type": "String",
      "Description": {
        "en": "The queue strategy."
      },
      "Required": false
    }
  },
  "Resources": {
    "Quota": {
      "Type": "ALIYUN::PAI::Quota",
      "Properties": {
        "QuotaName": {
          "Ref": "QuotaName"
        },
        "Min": {
          "Ref": "Min"
        },
        "Description": {
          "Ref": "Description"
        },
        "ResourceGroupIds": {
          "Ref": "ResourceGroupIds"
        },
        "AllocateStrategy": {
          "Ref": "AllocateStrategy"
        },
        "QuotaConfig": {
          "Ref": "QuotaConfig"
        },
        "ResourceType": {
          "Ref": "ResourceType"
        },
        "Labels": {
          "Ref": "Labels"
        },
        "ClusterSpec": {
          "Ref": "ClusterSpec"
        },
        "ParentQuotaId": {
          "Ref": "ParentQuotaId"
        },
        "QueueStrategy": {
          "Ref": "QueueStrategy"
        }
      }
    }
  },
  "Outputs": {
    "QuotaId": {
      "Description": "The ID of the quota.",
      "Value": {
        "Fn::GetAtt": [
          "Quota",
          "QuotaId"
        ]
      }
    }
  }
}