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

PAI-DSW (Data Science Workshop) インスタンスを作成します。

構文

{
  "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	はい	はい	ECS インスタンスタイプです。	なし
Labels	List	いいえ	いいえ	カスタムタグです。	なし
SaveImage	Boolean	いいえ	いいえ	環境を保存した後にインスタンスを停止するかどうかを指定します。	有効値： true：環境を保存した後にインスタンスを停止します。 false：環境を保存した後もインスタンスを実行中のままにします。
UserVpc	Map	いいえ	いいえ	VPC 構成です。	なし

Datasets 構文

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

Datasets プロパティ

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

Labels 構文

"Labels": [
  {
    "Value": String,
    "Key": String
  }
]

Labels プロパティ

プロパティ名	タイプ	必須	更新可	説明	制約
Value	String	いいえ	いいえ	タグ値です。	0～128 文字。 `aliyun` または `acs:` で開始できません。`http://` または `https://` を含めることはできません。
Key	String	いいえ	いいえ	タグキーです。	1～128 文字。 `aliyun` または `acs:` で開始できません。`http://` または `https://` を含めることはできません。

UserVpc 構文

"UserVpc": {
  "VpcId": String,
  "SecurityGroupId": String
}

UserVpc プロパティ

プロパティ名	タイプ	必須	更新可	説明	制約
VpcId	String	いいえ	はい	VPC ID です。	なし
SecurityGroupId	String	いいえ	はい	セキュリティグループ ID です。	なし

戻り値

Fn::GetAtt

Datasets：マウントされたデータセット。
InstanceName：インスタンス名。
EnvironmentVariables：環境変数。
Accessibility：ワークスペース内の他のユーザーに対するインスタンスの表示可否。
InstanceId：インスタンス ID。
WorkspaceId：ワークスペース ID。
ImageUrl：コンテナイメージ URL。
PaymentType：課金方法。
EcsSpec：ECS インスタンスタイプ。
Labels：カスタムタグ。
UserVpc：VPC 構成。
JupyterlabUrl：JupyterLab URL。
TerminalUrl：ターミナル URL。
InstanceUrl：インスタンス URL。
WebIDEUrl：Web IDE URL。

例

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 仕様。",
      "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": "インスタンス名。フォーマット要件：\n- 英字、数字、アンダースコア (_) のみ使用できます。\n- 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"
        ]
      }
    }
  }
}