All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::MaxCompute::Project

Last Updated:Feb 06, 2024

ALIYUN::MaxCompute::Project is used to create a MaxCompute project.

Syntax

{
  "Type": "ALIYUN::MaxCompute::Project",
  "Properties": {
    "Comment": String,
    "DefaultQuota": String,
    "ChargeType": String,
    "IpWhiteList": Map,
    "Properties": Map,
    "Name": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Comment

String

No

No

The description.

None.

DefaultQuota

String

No

No

The default computing quota.

None.

ChargeType

String

No

No

The billing method.

Valid values:

  • Prepaid

  • Postpaid

IpWhiteList

Map

No

Yes

The information about the IP address whitelists.

For more information, see IpWhiteList properties.

Properties

Map

No

No

The properties of the project.

For more information, see Properties properties.

Name

String

Yes

No

The project name.

The name must start with a lowercase letter and contain lowercase letters, digits, and underscores (-). It must be 3 to 28 characters in length.

IpWhiteList syntax

"IpWhiteList": {
  "VpcIpList": String,
  "IpList": String
}

IpWhiteList properties

Property

Type

Required

Editable

Description

Constraint

VpcIpList

String

No

No

The IP address whitelists of the virtual private cloud (VPC) type.

None.

IpList

String

No

No

The IP address whitelists.

None.

Properties syntax

"Properties": {
  "SqlMeteringMax": Integer,
  "TypeSystem": String,
  "RetentionDays": Integer,
  "Encryption": Map,
  "AllowFullScan": Boolean,
  "EnableDecimal2": Boolean
}

Properties properties

Property

Type

Required

Editable

Description

Constraint

SqlMeteringMax

Integer

No

No

The upper limit for the resources that are consumed by an SQL statement.

None.

TypeSystem

String

No

No

The data type edition.

Valid values:

  • 1: MaxCompute V1.0 data type edition

  • 2: MaxCompute V2.0 data type edition

  • hive: Hive-compatible data type edition

RetentionDays

Integer

No

No

The maximum number of days for which backup data can be retained.

None.

Encryption

Map

No

No

The information about storage encryption.

For more information, see Encryption properties.

AllowFullScan

Boolean

No

No

Specifies whether to enable a full table scan.

Valid values:

  • true

  • false

EnableDecimal2

Boolean

No

No

Specifies whether to enable the DECIMAL data type in the MaxCompute V2.0 data type edition.

Valid values:

  • true

  • false

Encryption syntax

"Encryption": {
  "Enable": Boolean,
  "Algorithm": String,
  "Key": String
}

Encryption properties

Property

Type

Required

Editable

Description

Constraint

Enable

Boolean

No

No

Specifies whether to enable storage encryption.

None.

Algorithm

String

No

No

The name of the encryption algorithm.

Example: SHA1.

Key

String

No

No

The key of the encryption algorithm.

None.

Return values

Fn::GetAtt

Name: the project name.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ChargeType:
        AllowedValues:
        - PayAsYouGo
        - Subscription
        Description:
          en: Quota payment type, support PayAsYouGo, Subscription.
        Required: false
        Type: String
      Comment:
        Description:
          en: The comments of project.
        Required: false
        Type: String
      DefaultQuota:
        Description:
          en: Default Computing Resource Group.
        Required: false
        Type: String
      IpWhiteList:
        AssociationPropertyMetadata:
          Parameters:
            IpList:
              Description:
                en: Classic network IP white list. Separate multiple items with commas.
              Required: false
              Type: String
            VpcIpList:
              Description:
                en: VPC network whitelist. Separate multiple items with commas.
              Required: false
              Type: String
        Description:
          en: IP whitelist.
        Required: false
        Type: Json
      Name:
        AllowedPattern: ^[a-z][a-z0-9_]{2,27}$
        Description:
          en: 'The name of the project.
    
            It must start with a lower-case letter and contain lower-case letters, digits,
            and underscores (_). The value must contain 3 to 28 characters'
        Required: true
        Type: String
      Properties:
        AssociationPropertyMetadata:
          Parameters:
            AllowFullScan:
              Description:
                en: Whether to allow full table scan.
              Required: false
              Type: Boolean
            EnableDecimal2:
              Description:
                en: Whether to turn on Decimal2.0.
              Required: false
              Type: Boolean
            Encryption:
              AssociationPropertyMetadata:
                Parameters:
                  Algorithm:
                    Description:
                      en: Encryption Algorithm.
                    Required: false
                    Type: String
                  Enable:
                    Description:
                      en: Whether to open encryption.
                    Required: false
                    Type: Boolean
                  Key:
                    Description:
                      en: Encryption algorithm key.
                    Required: false
                    Type: String
              Description:
                en: Whether encryption is turned on.
              Required: false
              Type: Json
            RetentionDays:
              Description:
                en: Job default retention time.
              Required: false
              Type: Number
            SqlMeteringMax:
              Description:
                en: SQL charge limit.
              Required: false
              Type: Number
            TypeSystem:
              AllowedValues:
              - '1'
              - '2'
              - hive
              Description:
                en: Type system.
              Required: false
              Type: String
        Description:
          en: Project base attributes.
        Required: false
        Type: Json
    Resources:
      Project:
        Properties:
          ChargeType:
            Ref: ChargeType
          Comment:
            Ref: Comment
          DefaultQuota:
            Ref: DefaultQuota
          IpWhiteList:
            Ref: IpWhiteList
          Name:
            Ref: Name
          Properties:
            Ref: Properties
        Type: ALIYUN::MaxCompute::Project
    Outputs:
      Name:
        Description: The name of the project.
        Value:
          Fn::GetAtt:
          - Project
          - Name
                            
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "Comment": {
          "Type": "String",
          "Description": {
            "en": "The comments of project."
          },
          "Required": false
        },
        "DefaultQuota": {
          "Type": "String",
          "Description": {
            "en": "Default Computing Resource Group."
          },
          "Required": false
        },
        "ChargeType": {
          "Type": "String",
          "Description": {
            "en": "Quota payment type, support PayAsYouGo, Subscription."
          },
          "AllowedValues": [
            "PayAsYouGo",
            "Subscription"
          ],
          "Required": false
        },
        "IpWhiteList": {
          "AssociationPropertyMetadata": {
            "Parameters": {
              "VpcIpList": {
                "Type": "String",
                "Description": {
                  "en": "VPC network whitelist. Separate multiple items with commas."
                },
                "Required": false
              },
              "IpList": {
                "Type": "String",
                "Description": {
                  "en": "Classic network IP white list. Separate multiple items with commas."
                },
                "Required": false
              }
            }
          },
          "Type": "Json",
          "Description": {
            "en": "IP whitelist."
          },
          "Required": false
        },
        "Properties": {
          "AssociationPropertyMetadata": {
            "Parameters": {
              "SqlMeteringMax": {
                "Type": "Number",
                "Description": {
                  "en": "SQL charge limit."
                },
                "Required": false
              },
              "TypeSystem": {
                "Type": "String",
                "Description": {
                  "en": "Type system."
                },
                "AllowedValues": [
                  "1",
                  "2",
                  "hive"
                ],
                "Required": false
              },
              "RetentionDays": {
                "Type": "Number",
                "Description": {
                  "en": "Job default retention time."
                },
                "Required": false
              },
              "Encryption": {
                "AssociationPropertyMetadata": {
                  "Parameters": {
                    "Enable": {
                      "Type": "Boolean",
                      "Description": {
                        "en": "Whether to open encryption."
                      },
                      "Required": false
                    },
                    "Algorithm": {
                      "Type": "String",
                      "Description": {
                        "en": "Encryption Algorithm."
                      },
                      "Required": false
                    },
                    "Key": {
                      "Type": "String",
                      "Description": {
                        "en": "Encryption algorithm key."
                      },
                      "Required": false
                    }
                  }
                },
                "Type": "Json",
                "Description": {
                  "en": "Whether encryption is turned on."
                },
                "Required": false
              },
              "AllowFullScan": {
                "Type": "Boolean",
                "Description": {
                  "en": "Whether to allow full table scan."
                },
                "Required": false
              },
              "EnableDecimal2": {
                "Type": "Boolean",
                "Description": {
                  "en": "Whether to turn on Decimal2.0."
                },
                "Required": false
              }
            }
          },
          "Type": "Json",
          "Description": {
            "en": "Project base attributes."
          },
          "Required": false
        },
        "Name": {
          "Type": "String",
          "Description": {
            "en": "The name of the project.\nIt must start with a lower-case letter and contain lower-case letters, digits, and underscores (_). The value must contain 3 to 28 characters"
          },
          "AllowedPattern": "^[a-z][a-z0-9_]{2,27}$",
          "Required": true
        }
      },
      "Resources": {
        "Project": {
          "Type": "ALIYUN::MaxCompute::Project",
          "Properties": {
            "Comment": {
              "Ref": "Comment"
            },
            "DefaultQuota": {
              "Ref": "DefaultQuota"
            },
            "ChargeType": {
              "Ref": "ChargeType"
            },
            "IpWhiteList": {
              "Ref": "IpWhiteList"
            },
            "Properties": {
              "Ref": "Properties"
            },
            "Name": {
              "Ref": "Name"
            }
          }
        }
      },
      "Outputs": {
        "Name": {
          "Description": "The name of the project.",
          "Value": {
            "Fn::GetAtt": [
              "Project",
              "Name"
            ]
          }
        }
      }
    }