ALIYUN::PAI::Workspace リソースタイプリファレンス - ROS

ALIYUN::PAI::Workspace は、ワークスペースを作成するために使用されます。

構文

{
  "Type": "ALIYUN::PAI::Workspace",
  "Properties": {
    "Description": String,
    "DisplayName": String,
    "WorkspaceName": String,
    "EnvTypes": List
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Description	String	はい	はい	ワークスペースの説明。	説明は最大 80 文字です。
DisplayName	String	いいえ	はい	ワークスペースの表示名。	ワークスペースを区別するために、ワークスペースの目的に基づいて表示名を構成することをお勧めします。このプロパティを空のままにすると、ワークスペースの名前が使用されます。名前は、次の形式要件を満たしている必要があります。 3 ～ 23 文字で、文字、アンダースコア（_）、数字を含めることができます。文字で始める必要があります。現在のリージョンで一意である必要があります。
WorkspaceName	String	はい	いいえ	ワークスペースの名前。	名前は、次の形式要件を満たしている必要があります。 3 ～ 23 文字で、文字、アンダースコア（_）、数字を含めることができます。文字で始める必要があります。現在のリージョンで一意である必要があります。
EnvTypes	List	はい	いいえ	ワークスペースの環境。	有効な値：prod および dev。pro は本番環境を指定します。dev は開発環境を指定します。ベーシックモードのワークスペースは、本番環境でのみ実行できます。標準モードのワークスペースは、開発環境と本番環境の両方で実行できます。例： `["dev", "prod"]`

戻り値

Fn::GetAtt

所有者: ワークスペース所有者の ID です。
Description：ワークスペースの説明。説明は最大 80 文字です。
AdminNames：管理者アカウントの名前。
DisplayName：ワークスペースの表示名。
WorkspaceId：ワークスペースの ID。
WorkspaceName: ワークスペースの名前です。
ExtraInfos：TenantId（テナント ID）を含む追加情報。
Creator：作成者のユーザー ID。
Users：ユーザー。
EnvTypes: ワークスペースの環境です。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DisplayName:
    AllowedPattern: ^[a-zA-Z][_a-zA-Z0-9]{2,22}$
    Description: 'ワークスペースの目的を識別するために、ビジネス属性に基づいてワークスペースに名前を付けることをお勧めします。構成されていない場合、デフォルト値はワークスペース名です。形式は次のとおりです。
      - 長さは 3 ～ 23 文字で、文字、アンダースコア、または数字を含めることができます。
      - 大文字または小文字で始める必要があります。
      - 現在のリージョンで一意です。'
    Type: String
  EnvTypes:
    Description: 'ワークスペースに含まれる環境：
      - シンプルモードのみ本番環境（prod）。
      - 標準モードには、開発環境（dev）と本番環境（prod）が含まれます。'
    Type: Json
  WorkspaceName:
    AllowedPattern: ^[a-zA-Z][_a-zA-Z0-9]{2,22}$
    Description: 'ワークスペース名。形式は次のとおりです。
      - 長さは 3 ～ 23 文字で、文字、アンダースコア、または数字を含めることができます。
      - 大文字または小文字で始める必要があります。
      - 現在のリージョンで一意です。'
    Type: String
Resources:
  ExtensionResource:
    Properties:
      DisplayName:
        Ref: DisplayName
      EnvTypes:
        Ref: EnvTypes
      WorkspaceName:
        Ref: WorkspaceName
    Type: ALIYUN::PAI::Workspace
Outputs:
  AdminNames:
    Description: 管理者アカウント名のリスト。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - AdminNames
  Creator:
    Description: 作成者のユーザー ID。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Creator
  Description:
    Description: ワークスペースの説明。80 文字以下。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Description
  DisplayName:
    Description: ワークスペースの目的を識別するために、ビジネス属性に基づいてワークスペースに名前を付けることをお勧めします。構成されていない場合、デフォルト値はワークスペース名です。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - DisplayName
  EnvTypes:
    Description: ワークスペースに含まれる環境。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - EnvTypes
  ExtraInfos:
    Description: 追加情報。現在、TenantId（テナント ID）が含まれています。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ExtraInfos
  Owner:
    Description: ワークスペース所有者 ID。Verbose が true の場合に表示されます。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Owner
  Users:
    Description: ユーザーのリスト。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Users
  WorkspaceId:
    Description: ワークスペースの ID。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - WorkspaceId
  WorkspaceName:
    Description: ワークスペース名。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - WorkspaceName

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DisplayName": {
      "Type": "String",
      "Description": "ワークスペースの目的を識別するために、ビジネス属性に基づいてワークスペースに名前を付けることをお勧めします。構成されていない場合、デフォルト値はワークスペース名です。形式は次のとおりです。\n- 長さは 3 ～ 23 文字で、文字、アンダースコア、または数字を含めることができます。\n- 大文字または小文字で始める必要があります。\n- 現在のリージョンで一意です。",
      "AllowedPattern": "^[a-zA-Z][_a-zA-Z0-9]{2,22}$"
    },
    "WorkspaceName": {
      "Type": "String",
      "Description": "ワークスペース名。形式は次のとおりです。\n- 長さは 3 ～ 23 文字で、文字、アンダースコア、または数字を含めることができます。\n- 大文字または小文字で始める必要があります。\n- 現在のリージョンで一意です。",
      "AllowedPattern": "^[a-zA-Z][_a-zA-Z0-9]{2,22}$"
    },
    "EnvTypes": {
      "Type": "Json",
      "Description": "ワークスペースに含まれる環境：\n- シンプルモードのみ本番環境（prod）。\n- 標準モードには、開発環境（dev）と本番環境（prod）が含まれます。"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::PAI::Workspace",
      "Properties": {
        "DisplayName": {
          "Ref": "DisplayName"
        },
        "WorkspaceName": {
          "Ref": "WorkspaceName"
        },
        "EnvTypes": {
          "Ref": "EnvTypes"
        }
      }
    }
  },
  "Outputs": {
    "Owner": {
      "Description": "ワークスペース所有者 ID。Verbose が true の場合に表示されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Owner"
        ]
      }
    },
    "Description": {
      "Description": "ワークスペースの説明。 80 文字以下。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "AdminNames": {
      "Description": "管理者アカウント名のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AdminNames"
        ]
      }
    },
    "DisplayName": {
      "Description": "ワークスペースの目的を識別するために、ビジネス属性に基づいてワークスペースに名前を付けることをお勧めします。構成されていない場合、デフォルト値はワークスペース名です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DisplayName"
        ]
      }
    },
    "WorkspaceId": {
      "Description": "ワークスペースの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WorkspaceId"
        ]
      }
    },
    "WorkspaceName": {
      "Description": "ワークスペース名。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WorkspaceName"
        ]
      }
    },
    "ExtraInfos": {
      "Description": "追加情報。現在、TenantId（テナント ID）が含まれています。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ExtraInfos"
        ]
      }
    },
    "Creator": {
      "Description": "作成者のユーザー ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Creator"
        ]
      }
    },
    "Users": {
      "Description": "ユーザーのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Users"
        ]
      }
    },
    "EnvTypes": {
      "Description": "ワークスペースに含まれる環境。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EnvTypes"
        ]
      }
    }
  }
}