All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::PAI::WorkspaceResourceDlcs

Last Updated:Oct 14, 2024

DATASOURCE::PAI::WorkspaceResourceDlcs is used to query a list of Deep Learning Containers (DLC) resources that are associated with a Platform for AI (PAI) workspace.

Syntax

{
  "Type": "DATASOURCE::PAI::WorkspaceResourceDlcs",
  "Properties": {
    "WorkspaceId": String,
    "GroupName": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

WorkspaceId

String

Yes

Yes

The ID of the workspace.

None.

GroupName

String

No

Yes

The name of the resource group.

None.

RefreshOptions

String

No

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

  • Never (default): does not refresh data source resources when the stack is updated.

  • Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

  • GroupNames: the names of resource groups.

  • WorkspaceResourceDlcs: the resources.

Property

Type

Description

Constraint

GroupNames

List

The names of resource groups.

None

WorkspaceResourceDlcs

List

The resources.

None

IsDefault

String

Indicates whether the resources are default resources.

None

GroupName

String

The name of the resource group.

None

CreateTime

String

The time when the resource was created. The time follows the ISO 8601 standard and is displayed in UTC.

None

Resources

String

The resources.

None

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  WorkspaceId:
    Type: String
    Description:
      en: The ID of the workspace to which the workspace belongs.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PAI::WorkspaceResourceDlcs
    Properties:
      WorkspaceId:
        Ref: WorkspaceId
Outputs:
  GroupNames:
    Description: The list of group names.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GroupNames
  WorkspaceResourceDlcs:
    Description: The list of workspace resource dlcs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - WorkspaceResourceDlcs
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "WorkspaceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the workspace to which the workspace belongs."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PAI::WorkspaceResourceDlcs",
      "Properties": {
        "WorkspaceId": {
          "Ref": "WorkspaceId"
        }
      }
    }
  },
  "Outputs": {
    "GroupNames": {
      "Description": "The list of group names.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GroupNames"
        ]
      }
    },
    "WorkspaceResourceDlcs": {
      "Description": "The list of workspace resource dlcs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "WorkspaceResourceDlcs"
        ]
      }
    }
  }
}