This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# Amazon WorkSpaces
<a name="AWS_WorkSpaces"></a>

**Resource types**
+ [AWS::WorkSpaces::ConnectionAlias](aws-resource-workspaces-connectionalias.md)
+ [AWS::WorkSpaces::Workspace](aws-resource-workspaces-workspace.md)
+ [AWS::WorkSpaces::WorkspacesPool](aws-resource-workspaces-workspacespool.md)

# AWS::WorkSpaces::ConnectionAlias
<a name="aws-resource-workspaces-connectionalias"></a>

The `AWS::WorkSpaces::ConnectionAlias` resource specifies a connection alias. Connection aliases are used for cross-Region redirection. For more information, see [ Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

## Syntax
<a name="aws-resource-workspaces-connectionalias-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-workspaces-connectionalias-syntax.json"></a>

```
{
  "Type" : "AWS::WorkSpaces::ConnectionAlias",
  "Properties" : {
      "[ConnectionString](#cfn-workspaces-connectionalias-connectionstring)" : String,
      "[Tags](#cfn-workspaces-connectionalias-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-workspaces-connectionalias-syntax.yaml"></a>

```
Type: AWS::WorkSpaces::ConnectionAlias
Properties:
  [ConnectionString](#cfn-workspaces-connectionalias-connectionstring): 
    String
  [Tags](#cfn-workspaces-connectionalias-tags): 
    - Tag
```

## Properties
<a name="aws-resource-workspaces-connectionalias-properties"></a>

`ConnectionString`  <a name="cfn-workspaces-connectionalias-connectionstring"></a>
The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as `www.example.com`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[.0-9a-zA-Z\-]{1,255}$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-workspaces-connectionalias-tags"></a>
The tags to associate with the connection alias.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-workspaces-connectionalias-tag.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-workspaces-connectionalias-return-values"></a>

### Ref
<a name="aws-resource-workspaces-connectionalias-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-workspaces-connectionalias-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-workspaces-connectionalias-return-values-fn--getatt-fn--getatt"></a>

`AliasId`  <a name="AliasId-fn::getatt"></a>
The identifier of the connection alias, returned as a string.

`Associations`  <a name="Associations-fn::getatt"></a>
The association status of the connection alias.

`ConnectionAliasState`  <a name="ConnectionAliasState-fn::getatt"></a>
The current state of the connection alias, returned as a string.

## See also
<a name="aws-resource-workspaces-connectionalias--seealso"></a>
+ [ConnectionAlias](https://docs.aws.amazon.com/workspaces/latest/api/API_ConnectionAlias.html) in the *Amazon WorkSpaces API Reference*
+ [Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) in the *Amazon WorkSpaces Administration Guide*



# AWS::WorkSpaces::ConnectionAlias ConnectionAliasAssociation
<a name="aws-properties-workspaces-connectionalias-connectionaliasassociation"></a>

Describes a connection alias association that is used for cross-Region redirection. For more information, see [ Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

## Syntax
<a name="aws-properties-workspaces-connectionalias-connectionaliasassociation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspaces-connectionalias-connectionaliasassociation-syntax.json"></a>

```
{
  "[AssociatedAccountId](#cfn-workspaces-connectionalias-connectionaliasassociation-associatedaccountid)" : String,
  "[AssociationStatus](#cfn-workspaces-connectionalias-connectionaliasassociation-associationstatus)" : String,
  "[ConnectionIdentifier](#cfn-workspaces-connectionalias-connectionaliasassociation-connectionidentifier)" : String,
  "[ResourceId](#cfn-workspaces-connectionalias-connectionaliasassociation-resourceid)" : String
}
```

### YAML
<a name="aws-properties-workspaces-connectionalias-connectionaliasassociation-syntax.yaml"></a>

```
  [AssociatedAccountId](#cfn-workspaces-connectionalias-connectionaliasassociation-associatedaccountid): String
  [AssociationStatus](#cfn-workspaces-connectionalias-connectionaliasassociation-associationstatus): String
  [ConnectionIdentifier](#cfn-workspaces-connectionalias-connectionaliasassociation-connectionidentifier): String
  [ResourceId](#cfn-workspaces-connectionalias-connectionaliasassociation-resourceid): String
```

## Properties
<a name="aws-properties-workspaces-connectionalias-connectionaliasassociation-properties"></a>

`AssociatedAccountId`  <a name="cfn-workspaces-connectionalias-connectionaliasassociation-associatedaccountid"></a>
The identifier of the AWS account that associated the connection alias with a directory.  
*Required*: No  
*Type*: String  
*Pattern*: `^\d{12}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AssociationStatus`  <a name="cfn-workspaces-connectionalias-connectionaliasassociation-associationstatus"></a>
The association status of the connection alias.  
*Required*: No  
*Type*: String  
*Allowed values*: `NOT_ASSOCIATED | PENDING_ASSOCIATION | ASSOCIATED_WITH_OWNER_ACCOUNT | ASSOCIATED_WITH_SHARED_ACCOUNT | PENDING_DISASSOCIATION`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectionIdentifier`  <a name="cfn-workspaces-connectionalias-connectionaliasassociation-connectionidentifier"></a>
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]+$`  
*Minimum*: `1`  
*Maximum*: `20`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceId`  <a name="cfn-workspaces-connectionalias-connectionaliasassociation-resourceid"></a>
The identifier of the directory associated with a connection alias.  
*Required*: No  
*Type*: String  
*Pattern*: `.+`  
*Minimum*: `1`  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpaces::ConnectionAlias Tag
<a name="aws-properties-workspaces-connectionalias-tag"></a>

Describes a tag.

## Syntax
<a name="aws-properties-workspaces-connectionalias-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspaces-connectionalias-tag-syntax.json"></a>

```
{
  "[Key](#cfn-workspaces-connectionalias-tag-key)" : String,
  "[Value](#cfn-workspaces-connectionalias-tag-value)" : String
}
```

### YAML
<a name="aws-properties-workspaces-connectionalias-tag-syntax.yaml"></a>

```
  [Key](#cfn-workspaces-connectionalias-tag-key): String
  [Value](#cfn-workspaces-connectionalias-tag-value): String
```

## Properties
<a name="aws-properties-workspaces-connectionalias-tag-properties"></a>

`Key`  <a name="cfn-workspaces-connectionalias-tag-key"></a>
The key of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-workspaces-connectionalias-tag-value"></a>
The value of the tag.  
*Required*: Yes  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::WorkSpaces::Workspace
<a name="aws-resource-workspaces-workspace"></a>

The `AWS::WorkSpaces::Workspace` resource specifies a WorkSpace.

Updates are not supported for the `BundleId`, `RootVolumeEncryptionEnabled`, `UserVolumeEncryptionEnabled`, or `VolumeEncryptionKey` properties. To update these properties, you must also update a property that triggers a replacement, such as the `UserName` property.

## Syntax
<a name="aws-resource-workspaces-workspace-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-workspaces-workspace-syntax.json"></a>

```
{
  "Type" : "AWS::WorkSpaces::Workspace",
  "Properties" : {
      "[BundleId](#cfn-workspaces-workspace-bundleid)" : String,
      "[DirectoryId](#cfn-workspaces-workspace-directoryid)" : String,
      "[RootVolumeEncryptionEnabled](#cfn-workspaces-workspace-rootvolumeencryptionenabled)" : Boolean,
      "[Tags](#cfn-workspaces-workspace-tags)" : [ Tag, ... ],
      "[UserName](#cfn-workspaces-workspace-username)" : String,
      "[UserVolumeEncryptionEnabled](#cfn-workspaces-workspace-uservolumeencryptionenabled)" : Boolean,
      "[VolumeEncryptionKey](#cfn-workspaces-workspace-volumeencryptionkey)" : String,
      "[WorkspaceProperties](#cfn-workspaces-workspace-workspaceproperties)" : WorkspaceProperties
    }
}
```

### YAML
<a name="aws-resource-workspaces-workspace-syntax.yaml"></a>

```
Type: AWS::WorkSpaces::Workspace
Properties:
  [BundleId](#cfn-workspaces-workspace-bundleid): String
  [DirectoryId](#cfn-workspaces-workspace-directoryid): String
  [RootVolumeEncryptionEnabled](#cfn-workspaces-workspace-rootvolumeencryptionenabled): Boolean
  [Tags](#cfn-workspaces-workspace-tags): 
    - Tag
  [UserName](#cfn-workspaces-workspace-username): String
  [UserVolumeEncryptionEnabled](#cfn-workspaces-workspace-uservolumeencryptionenabled): Boolean
  [VolumeEncryptionKey](#cfn-workspaces-workspace-volumeencryptionkey): String
  [WorkspaceProperties](#cfn-workspaces-workspace-workspaceproperties): 
    WorkspaceProperties
```

## Properties
<a name="aws-resource-workspaces-workspace-properties"></a>

`BundleId`  <a name="cfn-workspaces-workspace-bundleid"></a>
The identifier of the bundle for the WorkSpace.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^wsb-[0-9a-z]{8,63}$`  
*Update requires*: Updates are not supported.

`DirectoryId`  <a name="cfn-workspaces-workspace-directoryid"></a>
The identifier of the Directory Service directory for the WorkSpace.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)`  
*Minimum*: `10`  
*Maximum*: `65`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RootVolumeEncryptionEnabled`  <a name="cfn-workspaces-workspace-rootvolumeencryptionenabled"></a>
Indicates whether the data stored on the root volume is encrypted.  
*Required*: No  
*Type*: Boolean  
*Update requires*: Updates are not supported.

`Tags`  <a name="cfn-workspaces-workspace-tags"></a>
The tags for the WorkSpace.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-workspaces-workspace-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserName`  <a name="cfn-workspaces-workspace-username"></a>
The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UserVolumeEncryptionEnabled`  <a name="cfn-workspaces-workspace-uservolumeencryptionenabled"></a>
Indicates whether the data stored on the user volume is encrypted.  
*Required*: No  
*Type*: Boolean  
*Update requires*: Updates are not supported.

`VolumeEncryptionKey`  <a name="cfn-workspaces-workspace-volumeencryptionkey"></a>
The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.  
*Required*: No  
*Type*: String  
*Update requires*: Updates are not supported.

`WorkspaceProperties`  <a name="cfn-workspaces-workspace-workspaceproperties"></a>
The WorkSpace properties.  
*Required*: No  
*Type*: [WorkspaceProperties](aws-properties-workspaces-workspace-workspaceproperties.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-workspaces-workspace-return-values"></a>

### Ref
<a name="aws-resource-workspaces-workspace-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-workspaces-workspace-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

 

#### 
<a name="aws-resource-workspaces-workspace-return-values-fn--getatt-fn--getatt"></a>

`Id`  <a name="Id-fn::getatt"></a>
The identifier of the WorkSpace, returned as a string.

`WorkspaceId`  <a name="WorkspaceId-fn::getatt"></a>
The identifier of the WorkSpace.

## See also
<a name="aws-resource-workspaces-workspace--seealso"></a>
+ [CreateWorkspaces](https://docs.aws.amazon.com/workspaces/latest/api/API_CreateWorkspaces.html) in the *Amazon WorkSpaces API Reference*
+ [Launch a Virtual Desktop Using Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html) in the *Amazon WorkSpaces Administration Guide*



# AWS::WorkSpaces::Workspace Tag
<a name="aws-properties-workspaces-workspace-tag"></a>

Describes a tag.

## Syntax
<a name="aws-properties-workspaces-workspace-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspaces-workspace-tag-syntax.json"></a>

```
{
  "[Key](#cfn-workspaces-workspace-tag-key)" : String,
  "[Value](#cfn-workspaces-workspace-tag-value)" : String
}
```

### YAML
<a name="aws-properties-workspaces-workspace-tag-syntax.yaml"></a>

```
  [Key](#cfn-workspaces-workspace-tag-key): String
  [Value](#cfn-workspaces-workspace-tag-value): String
```

## Properties
<a name="aws-properties-workspaces-workspace-tag-properties"></a>

`Key`  <a name="cfn-workspaces-workspace-tag-key"></a>
The key of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-workspaces-workspace-tag-value"></a>
The value of the tag.  
*Required*: Yes  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpaces::Workspace WorkspaceProperties
<a name="aws-properties-workspaces-workspace-workspaceproperties"></a>

Information about a WorkSpace.

## Syntax
<a name="aws-properties-workspaces-workspace-workspaceproperties-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspaces-workspace-workspaceproperties-syntax.json"></a>

```
{
  "[ComputeTypeName](#cfn-workspaces-workspace-workspaceproperties-computetypename)" : String,
  "[RootVolumeSizeGib](#cfn-workspaces-workspace-workspaceproperties-rootvolumesizegib)" : Integer,
  "[RunningMode](#cfn-workspaces-workspace-workspaceproperties-runningmode)" : String,
  "[RunningModeAutoStopTimeoutInMinutes](#cfn-workspaces-workspace-workspaceproperties-runningmodeautostoptimeoutinminutes)" : Integer,
  "[UserVolumeSizeGib](#cfn-workspaces-workspace-workspaceproperties-uservolumesizegib)" : Integer
}
```

### YAML
<a name="aws-properties-workspaces-workspace-workspaceproperties-syntax.yaml"></a>

```
  [ComputeTypeName](#cfn-workspaces-workspace-workspaceproperties-computetypename): String
  [RootVolumeSizeGib](#cfn-workspaces-workspace-workspaceproperties-rootvolumesizegib): Integer
  [RunningMode](#cfn-workspaces-workspace-workspaceproperties-runningmode): String
  [RunningModeAutoStopTimeoutInMinutes](#cfn-workspaces-workspace-workspaceproperties-runningmodeautostoptimeoutinminutes): Integer
  [UserVolumeSizeGib](#cfn-workspaces-workspace-workspaceproperties-uservolumesizegib): Integer
```

## Properties
<a name="aws-properties-workspaces-workspace-workspaceproperties-properties"></a>

`ComputeTypeName`  <a name="cfn-workspaces-workspace-workspaceproperties-computetypename"></a>
The compute type. For more information, see [Amazon WorkSpaces Bundles](https://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles).  
*Required*: No  
*Type*: String  
*Allowed values*: `VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GENERALPURPOSE_4XLARGE | GENERALPURPOSE_8XLARGE | GRAPHICSPRO | GRAPHICS_G4DN | GRAPHICSPRO_G4DN | GRAPHICS_G6_XLARGE | GRAPHICS_G6_2XLARGE | GRAPHICS_G6_4XLARGE | GRAPHICS_G6_8XLARGE | GRAPHICS_G6_16XLARGE | GRAPHICS_GR6_4XLARGE | GRAPHICS_GR6_8XLARGE | GRAPHICS_G6F_LARGE | GRAPHICS_G6F_XLARGE | GRAPHICS_G6F_2XLARGE | GRAPHICS_G6F_4XLARGE | GRAPHICS_GR6F_4XLARGE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RootVolumeSizeGib`  <a name="cfn-workspaces-workspace-workspaceproperties-rootvolumesizegib"></a>
The size of the root volume. For important information about how to modify the size of the root and user volumes, see [Modify a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html).  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RunningMode`  <a name="cfn-workspaces-workspace-workspaceproperties-runningmode"></a>
The running mode. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html).  
*Required*: No  
*Type*: String  
*Allowed values*: `AUTO_STOP | ALWAYS_ON | MANUAL`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RunningModeAutoStopTimeoutInMinutes`  <a name="cfn-workspaces-workspace-workspaceproperties-runningmodeautostoptimeoutinminutes"></a>
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserVolumeSizeGib`  <a name="cfn-workspaces-workspace-workspaceproperties-uservolumesizegib"></a>
The size of the user storage. For important information about how to modify the size of the root and user volumes, see [Modify a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html).  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-workspaces-workspace-workspaceproperties--seealso"></a>
+ [WorkspaceProperties](https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html) in the *Amazon WorkSpaces API Reference*



# AWS::WorkSpaces::WorkspacesPool
<a name="aws-resource-workspaces-workspacespool"></a>

Describes a pool of WorkSpaces.

## Syntax
<a name="aws-resource-workspaces-workspacespool-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-workspaces-workspacespool-syntax.json"></a>

```
{
  "Type" : "AWS::WorkSpaces::WorkspacesPool",
  "Properties" : {
      "[ApplicationSettings](#cfn-workspaces-workspacespool-applicationsettings)" : ApplicationSettings,
      "[BundleId](#cfn-workspaces-workspacespool-bundleid)" : String,
      "[Capacity](#cfn-workspaces-workspacespool-capacity)" : Capacity,
      "[Description](#cfn-workspaces-workspacespool-description)" : String,
      "[DirectoryId](#cfn-workspaces-workspacespool-directoryid)" : String,
      "[PoolName](#cfn-workspaces-workspacespool-poolname)" : String,
      "[RunningMode](#cfn-workspaces-workspacespool-runningmode)" : String,
      "[TimeoutSettings](#cfn-workspaces-workspacespool-timeoutsettings)" : TimeoutSettings
    }
}
```

### YAML
<a name="aws-resource-workspaces-workspacespool-syntax.yaml"></a>

```
Type: AWS::WorkSpaces::WorkspacesPool
Properties:
  [ApplicationSettings](#cfn-workspaces-workspacespool-applicationsettings): 
    ApplicationSettings
  [BundleId](#cfn-workspaces-workspacespool-bundleid): String
  [Capacity](#cfn-workspaces-workspacespool-capacity): 
    Capacity
  [Description](#cfn-workspaces-workspacespool-description): String
  [DirectoryId](#cfn-workspaces-workspacespool-directoryid): String
  [PoolName](#cfn-workspaces-workspacespool-poolname): String
  [RunningMode](#cfn-workspaces-workspacespool-runningmode): String
  [TimeoutSettings](#cfn-workspaces-workspacespool-timeoutsettings): 
    TimeoutSettings
```

## Properties
<a name="aws-resource-workspaces-workspacespool-properties"></a>

`ApplicationSettings`  <a name="cfn-workspaces-workspacespool-applicationsettings"></a>
The persistent application settings for users of the pool.  
*Required*: No  
*Type*: [ApplicationSettings](aws-properties-workspaces-workspacespool-applicationsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BundleId`  <a name="cfn-workspaces-workspacespool-bundleid"></a>
The identifier of the bundle used by the pool.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^wsb-[0-9a-z]{8,63}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Capacity`  <a name="cfn-workspaces-workspacespool-capacity"></a>
Describes the user capacity for the pool.  
*Required*: Yes  
*Type*: [Capacity](aws-properties-workspaces-workspacespool-capacity.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-workspaces-workspacespool-description"></a>
The description of the pool.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_./() -]+$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DirectoryId`  <a name="cfn-workspaces-workspacespool-directoryid"></a>
The identifier of the directory used by the pool.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^wsd-[0-9a-z]{8,63}$`  
*Minimum*: `10`  
*Maximum*: `65`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PoolName`  <a name="cfn-workspaces-workspacespool-poolname"></a>
The name of the pool.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RunningMode`  <a name="cfn-workspaces-workspacespool-runningmode"></a>
The running mode of the pool.  
*Required*: No  
*Type*: String  
*Allowed values*: `ALWAYS_ON | AUTO_STOP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutSettings`  <a name="cfn-workspaces-workspacespool-timeoutsettings"></a>
The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.  
*Required*: No  
*Type*: [TimeoutSettings](aws-properties-workspaces-workspacespool-timeoutsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-workspaces-workspacespool-return-values"></a>

### Ref
<a name="aws-resource-workspaces-workspacespool-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-workspaces-workspacespool-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-workspaces-workspacespool-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The time the pool was created.

`PoolArn`  <a name="PoolArn-fn::getatt"></a>
The Amazon Resource Name (ARN) for the pool.

`PoolId`  <a name="PoolId-fn::getatt"></a>
The identifier of the pool.

# AWS::WorkSpaces::WorkspacesPool ApplicationSettings
<a name="aws-properties-workspaces-workspacespool-applicationsettings"></a>

The persistent application settings for users in the pool.

## Syntax
<a name="aws-properties-workspaces-workspacespool-applicationsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspaces-workspacespool-applicationsettings-syntax.json"></a>

```
{
  "[SettingsGroup](#cfn-workspaces-workspacespool-applicationsettings-settingsgroup)" : String,
  "[Status](#cfn-workspaces-workspacespool-applicationsettings-status)" : String
}
```

### YAML
<a name="aws-properties-workspaces-workspacespool-applicationsettings-syntax.yaml"></a>

```
  [SettingsGroup](#cfn-workspaces-workspacespool-applicationsettings-settingsgroup): String
  [Status](#cfn-workspaces-workspacespool-applicationsettings-status): String
```

## Properties
<a name="aws-properties-workspaces-workspacespool-applicationsettings-properties"></a>

`SettingsGroup`  <a name="cfn-workspaces-workspacespool-applicationsettings-settingsgroup"></a>
The path prefix for the S3 bucket where users’ persistent application settings are stored.  
*Required*: No  
*Type*: String  
*Pattern*: `^[A-Za-z0-9_./()!*'-]+$`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-workspaces-workspacespool-applicationsettings-status"></a>
Enables or disables persistent application settings for users during their pool sessions.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `DISABLED | ENABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpaces::WorkspacesPool Capacity
<a name="aws-properties-workspaces-workspacespool-capacity"></a>

Describes the user capacity for the pool.

## Syntax
<a name="aws-properties-workspaces-workspacespool-capacity-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspaces-workspacespool-capacity-syntax.json"></a>

```
{
  "[DesiredUserSessions](#cfn-workspaces-workspacespool-capacity-desiredusersessions)" : Integer
}
```

### YAML
<a name="aws-properties-workspaces-workspacespool-capacity-syntax.yaml"></a>

```
  [DesiredUserSessions](#cfn-workspaces-workspacespool-capacity-desiredusersessions): Integer
```

## Properties
<a name="aws-properties-workspaces-workspacespool-capacity-properties"></a>

`DesiredUserSessions`  <a name="cfn-workspaces-workspacespool-capacity-desiredusersessions"></a>
The desired number of user sessions for the WorkSpaces in the pool.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpaces::WorkspacesPool TimeoutSettings
<a name="aws-properties-workspaces-workspacespool-timeoutsettings"></a>

Describes the timeout settings for the pool.

## Syntax
<a name="aws-properties-workspaces-workspacespool-timeoutsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspaces-workspacespool-timeoutsettings-syntax.json"></a>

```
{
  "[DisconnectTimeoutInSeconds](#cfn-workspaces-workspacespool-timeoutsettings-disconnecttimeoutinseconds)" : Integer,
  "[IdleDisconnectTimeoutInSeconds](#cfn-workspaces-workspacespool-timeoutsettings-idledisconnecttimeoutinseconds)" : Integer,
  "[MaxUserDurationInSeconds](#cfn-workspaces-workspacespool-timeoutsettings-maxuserdurationinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-workspaces-workspacespool-timeoutsettings-syntax.yaml"></a>

```
  [DisconnectTimeoutInSeconds](#cfn-workspaces-workspacespool-timeoutsettings-disconnecttimeoutinseconds): Integer
  [IdleDisconnectTimeoutInSeconds](#cfn-workspaces-workspacespool-timeoutsettings-idledisconnecttimeoutinseconds): Integer
  [MaxUserDurationInSeconds](#cfn-workspaces-workspacespool-timeoutsettings-maxuserdurationinseconds): Integer
```

## Properties
<a name="aws-properties-workspaces-workspacespool-timeoutsettings-properties"></a>

`DisconnectTimeoutInSeconds`  <a name="cfn-workspaces-workspacespool-timeoutsettings-disconnecttimeoutinseconds"></a>
Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.  
*Required*: No  
*Type*: Integer  
*Minimum*: `60`  
*Maximum*: `36000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IdleDisconnectTimeoutInSeconds`  <a name="cfn-workspaces-workspacespool-timeoutsettings-idledisconnecttimeoutinseconds"></a>
The amount of time in seconds a connection will stay active while idle.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `36000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxUserDurationInSeconds`  <a name="cfn-workspaces-workspacespool-timeoutsettings-maxuserdurationinseconds"></a>
Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.  
*Required*: No  
*Type*: Integer  
*Minimum*: `600`  
*Maximum*: `432000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)