DATASOURCE::PAI::Workspaces による PAI ワークスペースのクエリ - ROS

DATASOURCE::PAI::Workspaces は、ワークスペースに関する基本情報を照会するために使用されます。

構文

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

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
WorkspaceId	String	いいえ	はい	ワークスペース ID。	なし。
WorkspaceName	String	いいえ	はい	ワークスペース名。	名前の形式は、次の要件を満たしている必要があります。名前は 3 ～ 23 文字で、文字、アンダースコア（_）、および数字を含めることができます。文字で始まる必要があります。現在のリージョン内で一意である必要があります。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値： Never（デフォルト）：スタックが更新されたときにデータソースリソースを更新しません。 Always：スタックが更新されたときにデータソースリソースを更新します。

戻り値

Fn::GetAtt

WorkspaceIds：ワークスペースの ID。
Workspaces：ワークスペースの詳細。

プロパティ	タイプ	説明	制約
WorkspaceIds	List	ワークスペースの ID。	なし。
Workspaces	List	ワークスペースの詳細。	なし。
WorkspaceName	String	ワークスペース名。	なし。
WorkspaceId	String	ワークスペース ID。	なし。
DisplayName	String	表示名。	なし。
EnvTypes	String	ワークスペース内の環境。	なし。
Description	String	ワークスペースの説明。	説明は最大 80 文字です。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  WorkspaceName:
    Description: 'ワークスペース名。形式は次のとおりです。

      - 3 ～ 23 文字で、文字、アンダースコア、または数字を含めることができます。

      - 大文字または小文字で始める必要があります。

      - 現在のリージョン内で一意です。'
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      WorkspaceName:
        Ref: WorkspaceName
    Type: DATASOURCE::PAI::Workspaces
Outputs:
  WorkspaceIds:
    Description: ワークスペース ID のリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - WorkspaceIds
  Workspaces:
    Description: ワークスペースのリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Workspaces

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "WorkspaceName": {
      "Type": "String",
      "Description": "ワークスペース名。形式は次のとおりです。\n- 3 ～ 23 文字で、文字、アンダースコア、または数字を含めることができます。\n- 大文字または小文字で始める必要があります。\n- 現在のリージョン内で一意です。"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PAI::Workspaces",
      "Properties": {
        "WorkspaceName": {
          "Ref": "WorkspaceName"
        }
      }
    }
  },
  "Outputs": {
    "WorkspaceIds": {
      "Description": "ワークスペース ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "WorkspaceIds"
        ]
      }
    },
    "Workspaces": {
      "Description": "ワークスペースのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Workspaces"
        ]
      }
    }
  }
}