DATASOURCE::PaiDswApi::Instances による DSW インスタンスのクエリ - ROS

DATASOURCE::PaiDswApi::Instances は、Data Science Workshop（DSW）インスタンスに関する基本情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::PaiDswApi::Instances",
  "Properties": {
    "InstanceName": String,
    "Accessibility": String,
    "InstanceId": String,
    "WorkspaceId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
InstanceName	String	いいえ	はい	インスタンス名。	名前の形式は、次の要件を満たしている必要があります。名前には、英字、数字、およびアンダースコア（_）のみを含めることができます。最大 27 文字まで使用できます。
Accessibility	String	いいえ	はい	ワークスペースのアクセスレベル。	有効な値： PRIVATE：ワークスペースには、管理者と自分だけがアクセスできます。 PUBLIC：ワークスペースには、すべてのユーザーがアクセスできます。
InstanceId	String	いいえ	はい	インスタンス ID。	なし。
WorkspaceId	String	いいえ	はい	ワークスペース ID。	なし。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースの更新ポリシー。	有効な値： Never（デフォルト）：スタックの更新時にデータソースリソースを更新しません。 Always：スタックの更新時にデータソースリソースを更新します。

戻り値

Fn::GetAtt

Instances：インスタンスの詳細。
InstanceIds：インスタンスの ID。

プロパティ	タイプ	説明	制約
InstanceIds	List	インスタンスの ID。	なし。
Instances	List	インスタンスの詳細。	なし。
Labels	List	カスタムタグ。	なし。
WorkspaceId	String	ワークスペース ID。	なし。
Accessibility	String	ワークスペースのアクセスレベル。	なし。
Status	String	インスタンスのステータス。	なし。
InstanceId	String	インスタンス ID。	なし。
UserVpc	String	仮想プライベートクラウド（VPC）構成。	なし。
ImageUrl	String	イメージのアドレス。	なし。
Datasets	String	データセットのコレクション。	なし。
EcsSpec	String	Elastic Compute Service（ECS）インスタンスタイプ。	なし。
InstanceName	String	インスタンス名。	なし。
PaymentType	String	インスタンスの支払いタイプ。	なし。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PaiDswApi::Instances
Outputs:
  InstanceIds:
    Description: インスタンス ID のリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceIds
  Instances:
    Description: インスタンスのリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Instances

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PaiDswApi::Instances"
    }
  },
  "Outputs": {
    "Instances": {
      "Description": "インスタンスのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Instances"
        ]
      }
    },
    "InstanceIds": {
      "Description": "インスタンス ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceIds"
        ]
      }
    }
  }
}