DATASOURCE::PAI::Workspace 属性リファレンス - ROS

DATASOURCE::PAI::Workspace は、Platform for AI (PAI) ワークスペースに関する情報をクエリするために使用されます。

構文

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

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

WorkspaceId

String

はい

PAI ワークスペースの ID。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースのリフレッシュポリシー。

有効な値:

Never (デフォルト): スタックの更新時にデータソースリソースをリフレッシュしません。
Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

IsDefault: ワークスペースがデフォルトのワークスペースであるかどうかを示します。
Description: ワークスペースの説明。
AdminNames: 管理者アカウントの名前。
DisplayName: 表示名。
WorkspaceId: ワークスペースの ID。
WorkspaceName: ワークスペースの名前。
ExtraInfos: 追加情報。TenantId (テナント ID) など。
Creator: ワークスペースを作成したユーザーの ID。
Users: ワークスペース所有者に関する情報。
EnvTypes: ワークスペースの環境情報。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  WorkspaceId:
    Type: String
    Description:
      en: The ID of the workspace.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PAI::Workspace
    Properties:
      WorkspaceId:
        Ref: WorkspaceId
Outputs:
  IsDefault:
    Description: デフォルト ワークスペース。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IsDefault
  Description:
    Description: ワークスペースの説明。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  AdminNames:
    Description: 管理者アカウント名のリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AdminNames
  DisplayName:
    Description: ワークスペースの表示名。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DisplayName
  WorkspaceId:
    Description: リソースの最初の ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - WorkspaceId
  WorkspaceName:
    Description: ワークスペースの名前。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - WorkspaceName
  ExtraInfos:
    Description: 追加情報。現在は TenantId (テナント ID) を含みます。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExtraInfos
  Creator:
    Description: 作成者のユーザー ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Creator
  Users:
    Description: ユーザーのリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Users
  EnvTypes:
    Description: ワークスペースの環境。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnvTypes

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "WorkspaceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the workspace."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PAI::Workspace",
      "Properties": {
        "WorkspaceId": {
          "Ref": "WorkspaceId"
        }
      }
    }
  },
  "Outputs": {
    "IsDefault": {
      "Description": "Default Workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IsDefault"
        ]
      }
    },
    "Description": {
      "Description": "The description of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "AdminNames": {
      "Description": "List of administrator account names.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AdminNames"
        ]
      }
    },
    "DisplayName": {
      "Description": "The display name of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DisplayName"
        ]
      }
    },
    "WorkspaceId": {
      "Description": "The first ID of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "WorkspaceId"
        ]
      }
    },
    "WorkspaceName": {
      "Description": "The name of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "WorkspaceName"
        ]
      }
    },
    "ExtraInfos": {
      "Description": "Additional information, currently including TenantId (tenant ID).",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExtraInfos"
        ]
      }
    },
    "Creator": {
      "Description": "The user ID of the creator.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Creator"
        ]
      }
    },
    "Users": {
      "Description": "List of users.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Users"
        ]
      }
    },
    "EnvTypes": {
      "Description": "The environments of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnvTypes"
        ]
      }
    }
  }
}