All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::PAI::UserConfig

Last Updated:Jul 05, 2026

The ALIYUN::PAI::UserConfig resource updates a user configuration in Platform for AI (PAI).

Syntax

{
  "Type": "ALIYUN::PAI::UserConfig",
  "Properties": {
    "ConfigKey": String,
    "CategoryName": String,
    "Configs": List
  }
}

Properties

Parameter

Type

Required

Updatable

Description

Constraint

CategoryName

String

Yes

No

The configuration category.

None

ConfigKey

String

Yes

No

The configuration key.

None

Configs

List

No

No

The configuration list.

The list can contain up to 20 items. For more information, see Configs properties.

Configs syntax

"Configs": [
  {
    "ConfigValue": String
  }
]

Configs properties

Parameter

Type

Required

Updatable

Description

Constraint

ConfigValue

String

No

No

The configuration value.

None

Return values

The following return values are available when you use Fn::GetAtt.

  • ConfigKey: The configuration key.

  • Configs: The configuration list.

  • CategoryName: The configuration category.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Configs:
    Description:
      en: The configuration list.
    Required: false
    Default: Null
    Type: Json
    MaxLength: 20
    AssociationProperty: List[Parameters]
    AssociationPropertyMetadata:
      Parameters:
        ConfigValue:
          Type: String
          Description:
            en: The configuration value.
          Default: Null
          Required: false
  CategoryName:
    Type: String
    Description:
      en: The configuration category.
    Required: true
  ConfigKey:
    Type: String
    Description:
      en: The configuration key.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::PAI::UserConfig
    Properties:
      Configs:
        Ref: Configs
      CategoryName:
        Ref: CategoryName
      ConfigKey:
        Ref: ConfigKey
Outputs:
  Configs:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Configs
    Description: The configuration list.
  CategoryName:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CategoryName
    Description: The configuration category.
  ConfigKey:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ConfigKey
    Description: The configuration key.
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Configs": {
      "Description": {
        "en": "The configuration list."
      },
      "Required": false,
      "Default": null,
      "Type": "Json",
      "MaxLength": 20,
      "AssociationProperty": "List[Parameters]",
      "AssociationPropertyMetadata": {
        "Parameters": {
          "ConfigValue": {
            "Type": "String",
            "Description": {
              "en": "The configuration value."
            },
            "Default": null,
            "Required": false
          }
        }
      }
    },
    "CategoryName": {
      "Type": "String",
      "Description": {
        "en": "The configuration category."
      },
      "Required": true
    },
    "ConfigKey": {
      "Type": "String",
      "Description": {
        "en": "The configuration key."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::PAI::UserConfig",
      "Properties": {
        "Configs": {
          "Ref": "Configs"
        },
        "CategoryName": {
          "Ref": "CategoryName"
        },
        "ConfigKey": {
          "Ref": "ConfigKey"
        }
      }
    }
  },
  "Outputs": {
    "Configs": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Configs"
        ]
      },
      "Description": "The configuration list."
    },
    "CategoryName": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CategoryName"
        ]
      },
      "Description": "The configuration category."
    },
    "ConfigKey": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ConfigKey"
        ]
      },
      "Description": "The configuration key."
    }
  }
}