ALIYUN::PaiDswApi::Instance リソースタイプ - ROS

ALIYUN::PaiDswApi::Instance は、Data Science Workshop（DSW）インスタンスを作成するために使用されます。

構文

{
  "Type": "ALIYUN::PaiDswApi::Instance",
  "Properties": {
    "Datasets": List,
    "InstanceName": String,
    "EnvironmentVariables": Map,
    "Accessibility": String,
    "WorkspaceId": String,
    "ImageUrl": String,
    "EcsSpec": String,
    "Labels": List,
    "SaveImage": Boolean,
    "UserVpc": Map
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Datasets	List	いいえ	はい	データセットのコレクション。	なし。
InstanceName	String	はい	はい	インスタンス名。	名前には、文字、数字、およびアンダースコア（_）のみを含めることができます。名前の長さは 27 文字までです。
EnvironmentVariables	Map	いいえ	いいえ	環境変数。	なし。
Accessibility	String	いいえ	はい	ワークスペースのアクセスレベル。	有効な値： PRIVATE：ワークスペースには管理者のみがアクセスできます。 PUBLIC：ワークスペースにはすべてのユーザーがアクセスできます。
WorkspaceId	String	いいえ	いいえ	ワークスペース ID。	なし。
ImageUrl	String	はい	はい	イメージ URL。	なし。
EcsSpec	String	はい	はい	Elastic Compute Service（ECS）インスタンスタイプ。	なし。
Labels	List	いいえ	いいえ	カスタムタグ。	なし。
SaveImage	Boolean	いいえ	いいえ	環境の保存後にインスタンスをシャットダウンするかどうかを指定します。	有効な値： true false
UserVpc	Map	いいえ	いいえ	仮想プライベートクラウド（VPC）構成。	なし。

Datasets 構文

"Datasets": [
  {
    "MountPath": String,
    "DatasetId": String
  }
]

Datasets プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
MountPath	String	いいえ	はい	コンテナ内のマウントパス。	なし。
DatasetId	String	いいえ	はい	データセット ID。	なし。

ラベルの構文

"Labels": [
  {
    "Value": String, // 値
    "Key": String // キー
  }
]

ラベルのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
値	文字列	いいえ	いいえ	ラベル値。	ラベル値は最大 128 文字で、`http://` または `https://` を含めることはできません。ラベル値は `aliyun` または `acs:` で始めることはできません。
キー	文字列	いいえ	いいえ	ラベルキー。	ラベルキーは 1 ～ 128 文字で、`http://` または `https://` を含めることはできません。ラベルキーは `aliyun` または `acs:` で始めることはできません。

Labels 構文

"UserVpc": {
  "VpcId": String, // VPC ID
  "SecurityGroupId": String // セキュリティグループ ID
}

UserVpc プロパティ

プロパティ	型	必須	編集可能	説明	制約
VpcId	String	いいえ	はい	VPC ID。	なし。
SecurityGroupId	String	いいえ	はい	セキュリティグループの ID。	なし。

戻り値

Fn::GetAtt

Datasets: データセットのコレクション。
InstanceName: インスタンス名。
EnvironmentVariables: 環境変数。
Accessibility: ワークスペースのアクセス可能性。
InstanceId: インスタンス ID。
WorkspaceIds: ワークスペース ID。
ImageUrl: イメージ URL。
PaymentType: 課金方法。
EcsSpec: ECS インスタンスタイプ。
Labels: インスタンスのカスタムタグ。
UserVpc: VPC の構成。
JupyterlabUrl: Jupyterlab URL。
TerminalUrl: ターミナル URL。
InstanceUrl: インスタンス URL。
WebIDEUrl: Web IDE URL。

Labels プロパティ

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  EcsSpec:
    Description: インスタンスの ECS 仕様。
    Type: String
    Default: ecs.gn5-c28g1.7xlarge
  ImageUrl:
    Description: ミラーアドレス。
    Type: String
    Default: registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0
  InstanceName:
    AllowedPattern: ^[_a-zA-Z0-9]{1,27}$
    Description: 'インスタンス名。形式の要件：

      - 文字、数字、アンダースコア (_) のみを含めることができます。

      - 27 文字を超えることはできません。'
    Type: String
Resources:
  ExtensionResource:
    Properties:
      EcsSpec:
        Ref: EcsSpec
      ImageUrl:
        Ref: ImageUrl
      InstanceName:
        Ref: InstanceName
    Type: ALIYUN::PaiDswApi::Instance
Outputs:
  Accessibility:
    Description: ワークスペースが他のユーザーに表示されるかどうか。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Accessibility
  Datasets:
    Description: データセットのコレクション。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Datasets
  EcsSpec:
    Description: インスタンスの ECS 仕様。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - EcsSpec
  EnvironmentVariables:
    Description: 環境変数。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - EnvironmentVariables
  ImageUrl:
    Description: ミラーアドレス。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ImageUrl
  InstanceId:
    Description: リソースの最初の ID。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - InstanceId
  InstanceName:
    Description: インスタンス名。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - InstanceName
  Labels:
    Description: ユーザー定義ラベル。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Labels
  PaymentType:
    Description: リソースの支払いタイプ。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - PaymentType
  UserVpc:
    Description: ユーザー VPC 構成。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - UserVpc
  WorkspaceId:
    Description: ワークスペースの ID。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - WorkspaceId

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "EcsSpec": {
      "Description": "インスタンスの ECS 仕様。", // The ECS specification of the instance.
      "Type": "String",
      "Default": "ecs.gn5-c28g1.7xlarge"
    },
    "ImageUrl": {
      "Description": "ミラーアドレス。", // The mirror address.
      "Type": "String",
      "Default": "registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0"
    },
    "InstanceName": {
      "AllowedPattern": "^[_a-zA-Z0-9]{1,27}$",
      "Description": "インスタンス名。形式の要件:\n- 文字、数字、アンダースコア (_) のみを含めることができます。\n- 27 文字を超えることはできません。", // The instance name. Format requirements:\n- Can only contain letters, numbers and underscores (_).\n- It cannot exceed 27 characters.
      "Type": "String"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Properties": {
        "EcsSpec": {
          "Ref": "EcsSpec"
        },
        "ImageUrl": {
          "Ref": "ImageUrl"
        },
        "InstanceName": {
          "Ref": "InstanceName"
        }
      },
      "Type": "ALIYUN::PaiDswApi::Instance"
    }
  },
  "Outputs": {
    "Accessibility": {
      "Description": "ワークスペースが他のユーザーに表示されるかどうか。", // Whether the workspace is visible to others.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Accessibility"
        ]
      }
    },
    "Datasets": {
      "Description": "データセットのコレクション。", // A collection of datasets.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Datasets"
        ]
      }
    },
    "EcsSpec": {
      "Description": "インスタンスの ECS 仕様。", // The ECS specification of the instance.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EcsSpec"
        ]
      }
    },
    "EnvironmentVariables": {
      "Description": "環境変数。", // Environment variable.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EnvironmentVariables"
        ]
      }
    },
    "ImageUrl": {
      "Description": "ミラーアドレス。", // The mirror address.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ImageUrl"
        ]
      }
    },
    "InstanceId": {
      "Description": "リソースの最初の ID。", // The first ID of the resource.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "InstanceId"
        ]
      }
    },
    "InstanceName": {
      "Description": "インスタンス名。", // The instance name.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "InstanceName"
        ]
      }
    },
    "Labels": {
      "Description": "ユーザー定義ラベル。", // User-defined labels.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Labels"
        ]
      }
    },
    "PaymentType": {
      "Description": "リソースの支払いタイプ。", // The payment type of the resource.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PaymentType"
        ]
      }
    },
    "UserVpc": {
      "Description": "ユーザー VPC 構成。", // User vpc configuration.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UserVpc"
        ]
      }
    },
    "WorkspaceId": {
      "Description": "ワークスペースの ID。", // The Id of the workspace.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WorkspaceId"
        ]
      }
    }
  }
}