メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::WorkSpaces::Workspace

AWS::WorkSpaces::Workspace リソースは、エンドユーザーのクラウドベースのデスクトップ体験である Amazon WorkSpaces ワークスペースを作成します。CloudFormation でワークスペースを作成する前に、Directory Service ディレクトリをワークスペースに登録する必要があります。このプロセスは、「Amazon WorkSpaces でのディレクトリの登録」に記載されています。詳細については、Amazon WorkSpaces Administration Guideを参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

Copy
{ "Type" : "AWS::WorkSpaces::Workspace", "Properties" : { "BundleId" : String, "DirectoryId" : String, "UserName" : String, "RootVolumeEncryptionEnabled" : Boolean, "UserVolumeEncryptionEnabled" : Boolean, "VolumeEncryptionKey" : String } }

YAML

Copy
Type: "AWS::WorkSpaces::Workspace" Properties: BundleId: String DirectoryId: String UserName: String RootVolumeEncryptionEnabled: Boolean UserVolumeEncryptionEnabled: Boolean VolumeEncryptionKey: String

プロパティ

BundleId

ワークスペースを作成するバンドルの識別子。バンドルは、インストールされているアプリケーションのサイズや、CPU、メモリ、およびストレージなどの、ワークスペースの詳細を指定します。「DescribeWorkspaceBundles」アクションを使用して、AWS が提供するバンドルを一覧します。

Required: Yes

Type: String

[Update requires]: アップデートはサポートされていません。. このプロパティを更新するには、UserName プロパティのような、置き換えをトリガーする別のプロパティを更新する必要があります。

DirectoryId

ワークスペースを作成する AWS Directory Service ディレクトリの識別子。ディレクトリはすでに Amazon WorkSpaces を使用して登録されている必要があります。「DescribeWorkspaceDirectories」アクションを使用して、使用可能なディレクトリを一覧します。

Required: Yes

Type: String

更新に伴う要件: 置換

UserName

ワークスペースが割り当てられているユーザーの名前。このユーザー名は、指定された AWS Directory Service ディレクトリ内にある必要があります。

Required: Yes

Type: String

更新に伴う要件: 置換

RootVolumeEncryptionEnabled

ルートボリューム (C: ドライブ) に保存されているデータを Amazon WorkSpaces が暗号化するかどうかを示します。

Required: No

Type: Boolean

[Update requires]: アップデートはサポートされていません。. このプロパティを更新するには、UserName プロパティのような、置き換えをトリガーする別のプロパティを更新する必要があります。

UserVolumeEncryptionEnabled

ユーザーボリューム (D: ドライブ) に保存されているデータを Amazon WorkSpaces が暗号化するかどうかを示します。

Required: No

Type: Boolean

[Update requires]: アップデートはサポートされていません。. このプロパティを更新するには、UserName プロパティのような、置き換えをトリガーする別のプロパティを更新する必要があります。

VolumeEncryptionKey

Amazon WorkSpaces がワークスペースに保存されたデータの暗号化に使用する AWS Key Management Service (AWS KMS) キー ID。

Required: No

Type: String

[Update requires]: アップデートはサポートされていません。. このプロパティを更新するには、UserName プロパティのような、置き換えをトリガーする別のプロパティを更新する必要があります。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりリソース名が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

次の例では、ユーザー test のワークスペースを作成します。バンドルおよびディレクトリの ID は同じテンプレートでパラメーターとして指定されます。

JSON

Copy
"workspace1" : { "Type" : "AWS::WorkSpaces::Workspace", "Properties" : { "BundleId" : {"Ref" : "BundleId"}, "DirectoryId" : {"Ref" : "DirectoryId"}, "UserName" : "test" } }

YAML

Copy
workspace1: Type: "AWS::WorkSpaces::Workspace" Properties: BundleId: Ref: "BundleId" DirectoryId: Ref: "DirectoryId" UserName: "test"

このページの内容: