AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::WorkSpaces::Workspace

AWS::WorkSpaces::Workspace 资源创建 Amazon WorkSpaces 工作区(面向最终用户的基于云的桌面体验)。在 CloudFormation 中创建 Workspaces 之前,您必须向 Workspaces 注册一个 Directory Service 目录。有关操作过程的说明,请参阅向 Amazon WorkSpaces 注册目录。有关更多信息,请参阅 Amazon WorkSpaces Administration Guide

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

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

YAML

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

更新要求:不支持更新。. 要更新此属性,您还必须更新触发替换的属性,如 UserName 属性。

DirectoryId

要在其中创建工作区的 AWS Directory Service 目录的标识符。此目录必须已在 Amazon WorkSpaces 中注册。使用 DescribeWorkspaceDirectories 操作可列出可用的目录。

Required: Yes

Type: String

更新要求替换

UserName

要为其分配工作区的用户的名称。此用户名称必须存在于指定的 AWS Directory Service 目录中。

Required: Yes

Type: String

更新要求替换

RootVolumeEncryptionEnabled

指示 Amazon WorkSpaces 是否加密存储在根卷(C: 驱动器)上的数据。

Required: No

Type: Boolean

更新要求:不支持更新。. 要更新此属性,您还必须更新触发替换的属性,如 UserName 属性。

UserVolumeEncryptionEnabled

指示 Amazon WorkSpaces 是否加密存储在用户卷(D: 驱动器)上的数据。

Required: No

Type: Boolean

更新要求:不支持更新。. 要更新此属性,您还必须更新触发替换的属性,如 UserName 属性。

VolumeEncryptionKey

Amazon WorkSpaces 用于加密存储在您的工作区上的数据的 AWS Key Management Service (AWS KMS) 密钥 ID。

Required: No

Type: String

更新要求:不支持更新。. 要更新此属性,您还必须更新触发替换的属性,如 UserName 属性。

返回值

Ref

当该资源的逻辑 ID 提供给 Ref内部函数时,Ref 将返回资源名称。

有关使用 Ref 功能的更多信息,请参阅参考

示例

下面的示例为 test 用户创建一个工作区。捆绑和目录 ID 是在同一个模板中指定为参数的。

JSON

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

YAML

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

本页内容: