ALIYUN::DataWorks::Project を使用した DataWorks ワークスペースの作成 - ROS

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

構文

{
  "Type": "ALIYUN::DataWorks::Project",
  "Properties": {
    "ProjectIdentifier": String,
    "DisableDevelopment": Boolean,
    "IsAllowDownload": Boolean,
    "ProjectName": String,
    "ProjectDescription": String,
    "ProjectMode": Integer,
    "ResourceGroupId": String,
    "Tags": List
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ProjectIdentifier	String	はい	いいえ	ワークスペースの名前。	名前に使用できるのは、英字、数字、およびアンダースコア（_）のみです。英字または数字で始める必要があります。
DisableDevelopment	Boolean	いいえ	いいえ	開発エンジニアロールを無効にするかどうかを指定します。	有効な値： false（デフォルト）：開発エンジニアロールを無効にしません。 true：開発エンジニアロールを無効にします。
IsAllowDownload	Boolean	いいえ	いいえ	DataStudio からのクエリ結果のダウンロードを許可するかどうかを指定します。	有効な値： 1（デフォルト）：DataStudio からのクエリ結果のダウンロードを許可します。 0：DataStudio からのクエリ結果のダウンロードを許可しません。
ProjectName	String	いいえ	いいえ	ワークスペースの表示名。	なし
ProjectDescription	String	いいえ	いいえ	ワークスペースの説明。	なし
ProjectMode	Integer	いいえ	いいえ	ワークスペースのモード。	有効な値： 2（デフォルト）：基本モード 3：標準モード
ResourceGroupId	String	いいえ	いいえ	リソースグループの ID。	なし
Tags	List	いいえ	はい	ワークスペースに追加されるタグ。	詳細については、「タグのプロパティ」をご参照ください。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキー。	なし
Value	String	いいえ	いいえ	タグ値。	なし

戻り値

Fn::GetAtt

ProjectIdentifier: ワークスペースの名前。
IsDefault: ワークスペースがデフォルトのワークスペースかどうかを示します。
SchedulerMaxRetryTimes: エラー発生時のデフォルトの自動再実行回数。
ProtectedMode: ワークスペースが保護されているかどうかを示します。
ProjectId: ワークスペースの ID。
TablePrivacyMode: MaxCompute テーブルの表示権限。
EnvTypes: ワークスペースの環境情報。
ResidentArea: ワークスペースのタイプ。
SchedulerRetryInterval: エラー発生時の自動再実行のデフォルトの時間間隔。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ProjectIdentifier:
    Type: String
    Description:
      en: The name of the workspace. The name can contain letters, digits, and underscores (_) and must start with a letter or digit.
    AllowedPattern: ^[a-zA-Z][a-zA-Z0-9_]{2,27}$
    Required: true
    Default: test_project
Resources:
  Project:
    Type: ALIYUN::DataWorks::Project
    Properties:
      ProjectIdentifier:
        Ref: ProjectIdentifier
Outputs:
  ProjectIdentifier:
    Description: The name of the workspace. The name can contain letters, digits, and underscores (_) and must start with a letter or digit.
    Value:
      Fn::GetAtt:
        - Project
        - ProjectIdentifier
  IsDefault:
    Description: |-
      Indicates whether the workspace is the default workspace. Valid values:
      1: The workspace is the default workspace.
      0: The workspace is not the default workspace.
    Value:
      Fn::GetAtt:
        - Project
        - IsDefault
  SchedulerMaxRetryTimes:
    Description: The default maximum number of automatic reruns that are allowed after an error occurs.
    Value:
      Fn::GetAtt:
        - Project
        - SchedulerMaxRetryTimes
  ProtectedMode:
    Description: |-
      Indicates whether the workspace protection feature is enabled. Valid values:
      1: The workspace protection feature is enabled.
      0: The workspace protection feature is disabled.
    Value:
      Fn::GetAtt:
        - Project
        - ProtectedMode
  ProjectId:
    Description: The ID of the workspace.
    Value:
      Fn::GetAtt:
        - Project
        - ProjectId
  TablePrivacyMode:
    Description: |-
      Indicates whether the MaxCompute tables in the workspace are visible to the users within the tenant. Valid values:
      0: The MaxCompute tables are invisible to the users within a tenant.
      1: The MaxCompute tables are visible to the users within a tenant.
    Value:
      Fn::GetAtt:
        - Project
        - TablePrivacyMode
  EnvTypes:
    Description: |-
      The environment of the workspace. Valid values: PROD and DEV.
      The value PROD indicates the production environment. Workspaces in basic mode provide only the production environment.
      The value DEV indicates the development environment. Workspaces in standard mode provide both the development environment and the production environment.
    Value:
      Fn::GetAtt:
        - Project
        - EnvTypes
  ResidentArea:
    Description: 'The type of the workspace. Valid values: private and swap.'
    Value:
      Fn::GetAtt:
        - Project
        - ResidentArea
  SchedulerRetryInterval:
    Description: 'The interval between automatic reruns after an error occurs. Unit: milliseconds. The maximum interval is 30 minutes. You must pay attention to the conversion between units.'
    Value:
      Fn::GetAtt:
        - Project
        - SchedulerRetryInterval

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ProjectIdentifier": {
      "Type": "String",
      "Description": {
        "en": "The name of the workspace. The name can contain letters, digits, and underscores (_) and must start with a letter or digit."
      },
      "AllowedPattern": "^[a-zA-Z][a-zA-Z0-9_]{2,27}$",
      "Required": true,
      "Default": "test_project"
    }
  },
  "Resources": {
    "Project": {
      "Type": "ALIYUN::DataWorks::Project",
      "Properties": {
        "ProjectIdentifier": {
          "Ref": "ProjectIdentifier"
        }
      }
    }
  },
  "Outputs": {
    "ProjectIdentifier": {
      "Description": "ワークスペースの名前。名前に使用できるのは、英字、数字、およびアンダースコア（_）のみです。英字または数字で始める必要があります。",
      "Value": {
        "Fn::GetAtt": [
          "Project",
          "ProjectIdentifier"
        ]
      }
    },
    "IsDefault": {
      "Description": "ワークスペースがデフォルトのワークスペースかどうかを示します。有効な値：\n1: ワークスペースはデフォルトのワークスペースです。\n0: ワークスペースはデフォルトのワークスペースではありません。",
      "Value": {
        "Fn::GetAtt": [
          "Project",
          "IsDefault"
        ]
      }
    },
    "SchedulerMaxRetryTimes": {
      "Description": "エラー発生後に許可されるデフォルトの自動再実行の最大回数。",
      "Value": {
        "Fn::GetAtt": [
          "Project",
          "SchedulerMaxRetryTimes"
        ]
      }
    },
    "ProtectedMode": {
      "Description": "ワークスペース保護機能が有効になっているかどうかを示します。有効な値：\n1: ワークスペース保護機能が有効になっています。\n0: ワークスペース保護機能は無効になっています。",
      "Value": {
        "Fn::GetAtt": [
          "Project",
          "ProtectedMode"
        ]
      }
    },
    "ProjectId": {
      "Description": "ワークスペースの ID。",
      "Value": {
        "Fn::GetAtt": [
          "Project",
          "ProjectId"
        ]
      }
    },
    "TablePrivacyMode": {
      "Description": "ワークスペース内の MaxCompute テーブルがテナント内のユーザーに表示されるかどうかを示します。有効な値：\n0: MaxCompute テーブルはテナント内のユーザーに表示されません。\n1: MaxCompute テーブルはテナント内のユーザーに表示されます。",
      "Value": {
        "Fn::GetAtt": [
          "Project",
          "TablePrivacyMode"
        ]
      }
    },
    "EnvTypes": {
      "Description": "ワークスペースの環境。有効な値：PROD および DEV。\nPROD 値は本番環境を示します。基本モードのワークスペースは、本番環境のみを提供します。\nDEV 値は開発環境を示します。標準モードのワークスペースは、開発環境と本番環境の両方を提供します。",
      "Value": {
        "Fn::GetAtt": [
          "Project",
          "EnvTypes"
        ]
      }
    },
    "ResidentArea": {
      "Description": "ワークスペースのタイプ。有効な値：private および swap。",
      "Value": {
        "Fn::GetAtt": [
          "Project",
          "ResidentArea"
        ]
      }
    },
    "SchedulerRetryInterval": {
      "Description": "エラー発生後の自動再実行の間隔。単位：ミリ秒。最大間隔は 30 分です。単位の変換に注意する必要があります。",
      "Value": {
        "Fn::GetAtt": [
          "Project",
          "SchedulerRetryInterval"
        ]
      }
    }
  }
}

構文

プロパティ

タグの構文

タグのプロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式