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).

# AWS::AppStream::Fleet
<a name="aws-resource-appstream-fleet"></a>

The `AWS::AppStream::Fleet` resource creates a fleet for Amazon WorkSpaces Applications. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand.

## Syntax
<a name="aws-resource-appstream-fleet-syntax"></a>

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

### JSON
<a name="aws-resource-appstream-fleet-syntax.json"></a>

```
{
  "Type" : "AWS::AppStream::Fleet",
  "Properties" : {
      "[ComputeCapacity](#cfn-appstream-fleet-computecapacity)" : ComputeCapacity,
      "[Description](#cfn-appstream-fleet-description)" : String,
      "[DisableIMDSV1](#cfn-appstream-fleet-disableimdsv1)" : Boolean,
      "[DisconnectTimeoutInSeconds](#cfn-appstream-fleet-disconnecttimeoutinseconds)" : Integer,
      "[DisplayName](#cfn-appstream-fleet-displayname)" : String,
      "[DomainJoinInfo](#cfn-appstream-fleet-domainjoininfo)" : DomainJoinInfo,
      "[EnableDefaultInternetAccess](#cfn-appstream-fleet-enabledefaultinternetaccess)" : Boolean,
      "[FleetType](#cfn-appstream-fleet-fleettype)" : String,
      "[IamRoleArn](#cfn-appstream-fleet-iamrolearn)" : String,
      "[IdleDisconnectTimeoutInSeconds](#cfn-appstream-fleet-idledisconnecttimeoutinseconds)" : Integer,
      "[ImageArn](#cfn-appstream-fleet-imagearn)" : String,
      "[ImageName](#cfn-appstream-fleet-imagename)" : String,
      "[InstanceType](#cfn-appstream-fleet-instancetype)" : String,
      "[MaxConcurrentSessions](#cfn-appstream-fleet-maxconcurrentsessions)" : Integer,
      "[MaxSessionsPerInstance](#cfn-appstream-fleet-maxsessionsperinstance)" : Integer,
      "[MaxUserDurationInSeconds](#cfn-appstream-fleet-maxuserdurationinseconds)" : Integer,
      "[Name](#cfn-appstream-fleet-name)" : String,
      "[Platform](#cfn-appstream-fleet-platform)" : String,
      "[RootVolumeConfig](#cfn-appstream-fleet-rootvolumeconfig)" : VolumeConfig,
      "[SessionScriptS3Location](#cfn-appstream-fleet-sessionscripts3location)" : S3Location,
      "[StreamView](#cfn-appstream-fleet-streamview)" : String,
      "[Tags](#cfn-appstream-fleet-tags)" : [ Tag, ... ],
      "[UsbDeviceFilterStrings](#cfn-appstream-fleet-usbdevicefilterstrings)" : [ String, ... ],
      "[VpcConfig](#cfn-appstream-fleet-vpcconfig)" : VpcConfig
    }
}
```

### YAML
<a name="aws-resource-appstream-fleet-syntax.yaml"></a>

```
Type: AWS::AppStream::Fleet
Properties:
  [ComputeCapacity](#cfn-appstream-fleet-computecapacity): 
    ComputeCapacity
  [Description](#cfn-appstream-fleet-description): String
  [DisableIMDSV1](#cfn-appstream-fleet-disableimdsv1): Boolean
  [DisconnectTimeoutInSeconds](#cfn-appstream-fleet-disconnecttimeoutinseconds): Integer
  [DisplayName](#cfn-appstream-fleet-displayname): String
  [DomainJoinInfo](#cfn-appstream-fleet-domainjoininfo): 
    DomainJoinInfo
  [EnableDefaultInternetAccess](#cfn-appstream-fleet-enabledefaultinternetaccess): Boolean
  [FleetType](#cfn-appstream-fleet-fleettype): String
  [IamRoleArn](#cfn-appstream-fleet-iamrolearn): String
  [IdleDisconnectTimeoutInSeconds](#cfn-appstream-fleet-idledisconnecttimeoutinseconds): Integer
  [ImageArn](#cfn-appstream-fleet-imagearn): String
  [ImageName](#cfn-appstream-fleet-imagename): String
  [InstanceType](#cfn-appstream-fleet-instancetype): String
  [MaxConcurrentSessions](#cfn-appstream-fleet-maxconcurrentsessions): Integer
  [MaxSessionsPerInstance](#cfn-appstream-fleet-maxsessionsperinstance): Integer
  [MaxUserDurationInSeconds](#cfn-appstream-fleet-maxuserdurationinseconds): Integer
  [Name](#cfn-appstream-fleet-name): String
  [Platform](#cfn-appstream-fleet-platform): String
  [RootVolumeConfig](#cfn-appstream-fleet-rootvolumeconfig): 
    VolumeConfig
  [SessionScriptS3Location](#cfn-appstream-fleet-sessionscripts3location): 
    S3Location
  [StreamView](#cfn-appstream-fleet-streamview): String
  [Tags](#cfn-appstream-fleet-tags): 
    - Tag
  [UsbDeviceFilterStrings](#cfn-appstream-fleet-usbdevicefilterstrings): 
    - String
  [VpcConfig](#cfn-appstream-fleet-vpcconfig): 
    VpcConfig
```

## Properties
<a name="aws-resource-appstream-fleet-properties"></a>

`ComputeCapacity`  <a name="cfn-appstream-fleet-computecapacity"></a>
The desired capacity for the fleet. This is not allowed for Elastic fleets.  
*Required*: No  
*Type*: [ComputeCapacity](aws-properties-appstream-fleet-computecapacity.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-appstream-fleet-description"></a>
The description to display.  
*Required*: No  
*Type*: String  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DisableIMDSV1`  <a name="cfn-appstream-fleet-disableimdsv1"></a>
Indicates whether Instance Metadata Service Version 1 (IMDSv1) is disabled for the fleet.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DisconnectTimeoutInSeconds`  <a name="cfn-appstream-fleet-disconnecttimeoutinseconds"></a>
The amount of time 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 this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.   
Specify a value between 60 and 36000.  
*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)

`DisplayName`  <a name="cfn-appstream-fleet-displayname"></a>
The fleet name to display.  
*Required*: No  
*Type*: String  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DomainJoinInfo`  <a name="cfn-appstream-fleet-domainjoininfo"></a>
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.  
*Required*: No  
*Type*: [DomainJoinInfo](aws-properties-appstream-fleet-domainjoininfo.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnableDefaultInternetAccess`  <a name="cfn-appstream-fleet-enabledefaultinternetaccess"></a>
Enables or disables default internet access for the fleet.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FleetType`  <a name="cfn-appstream-fleet-fleettype"></a>
The fleet type.    
ALWAYS\$1ON  
Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.  
ON\$1DEMAND  
Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.  
ELASTIC  
The pool of streaming instances is managed by Amazon WorkSpaces Applications. When a user selects their application or desktop to launch, they will start streaming after the app block has been downloaded and mounted to a streaming instance.
*Allowed Values*: `ALWAYS_ON` \$1 `ELASTIC` \$1 `ON_DEMAND`  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IamRoleArn`  <a name="cfn-appstream-fleet-iamrolearn"></a>
The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service`AssumeRole` API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the **appstream\$1machine\$1role** credential profile on the instance.  
For more information, see [Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances](https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) in the *Amazon WorkSpaces Applications Administration Guide*.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$`  
*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-appstream-fleet-idledisconnecttimeoutinseconds"></a>
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the `DisconnectTimeoutInSeconds` time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in `DisconnectTimeoutInSeconds` elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in `IdleDisconnectTimeoutInSeconds` elapses, they are disconnected.  
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000.  
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.   
*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)

`ImageArn`  <a name="cfn-appstream-fleet-imagearn"></a>
The ARN of the public, private, or shared image to use.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ImageName`  <a name="cfn-appstream-fleet-imagename"></a>
The name of the image used to create the fleet.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceType`  <a name="cfn-appstream-fleet-instancetype"></a>
The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:  
+ stream.standard.small
+ stream.standard.medium
+ stream.standard.large
+ stream.compute.large
+ stream.compute.xlarge
+ stream.compute.2xlarge
+ stream.compute.4xlarge
+ stream.compute.8xlarge
+ stream.memory.large
+ stream.memory.xlarge
+ stream.memory.2xlarge
+ stream.memory.4xlarge
+ stream.memory.8xlarge
+ stream.memory.z1d.large
+ stream.memory.z1d.xlarge
+ stream.memory.z1d.2xlarge
+ stream.memory.z1d.3xlarge
+ stream.memory.z1d.6xlarge
+ stream.memory.z1d.12xlarge
+ stream.graphics-design.large
+ stream.graphics-design.xlarge
+ stream.graphics-design.2xlarge
+ stream.graphics-design.4xlarge
+ stream.graphics.g4dn.xlarge
+ stream.graphics.g4dn.2xlarge
+ stream.graphics.g4dn.4xlarge
+ stream.graphics.g4dn.8xlarge
+ stream.graphics.g4dn.12xlarge
+ stream.graphics.g4dn.16xlarge
+ stream.graphics.g5.xlarge
+ stream.graphics.g5.2xlarge
+ stream.graphics.g5.4xlarge
+ stream.graphics.g5.8xlarge
+ stream.graphics.g5.16xlarge
+ stream.graphics.g5.12xlarge
+ stream.graphics.g5.24xlarge
+ stream.graphics.g6.xlarge
+ stream.graphics.g6.2xlarge
+ stream.graphics.g6.4xlarge
+ stream.graphics.g6.8xlarge
+ stream.graphics.g6.16xlarge
+ stream.graphics.g6.12xlarge
+ stream.graphics.g6.24xlarge
+ stream.graphics.gr6.4xlarge
+ stream.graphics.gr6.8xlarge
+ stream.graphics.g6f.large
+ stream.graphics.g6f.xlarge
+ stream.graphics.g6f.2xlarge
+ stream.graphics.g6f.4xlarge
+ stream.graphics.gr6f.4xlarge
The following instance types are available for Elastic fleets:  
+ stream.standard.small
+ stream.standard.medium
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxConcurrentSessions`  <a name="cfn-appstream-fleet-maxconcurrentsessions"></a>
The maximum number of concurrent sessions that can be run on an Elastic fleet. This setting is required for Elastic fleets, but is not used for other fleet types.  
*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)

`MaxSessionsPerInstance`  <a name="cfn-appstream-fleet-maxsessionsperinstance"></a>
Max number of user sessions on an instance. This is applicable only for multi-session fleets.  
*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)

`MaxUserDurationInSeconds`  <a name="cfn-appstream-fleet-maxuserdurationinseconds"></a>
The maximum amount of time that a streaming session can remain active, in seconds. 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.  
Specify a value between 600 and 432000.  
*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)

`Name`  <a name="cfn-appstream-fleet-name"></a>
A unique name for the fleet.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Platform`  <a name="cfn-appstream-fleet-platform"></a>
The platform of the fleet. Platform is a required setting for Elastic fleets, and is not used for other fleet types.  
*Required*: No  
*Type*: String  
*Allowed values*: `WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | WINDOWS_SERVER_2025 | AMAZON_LINUX2 | RHEL8 | ROCKY_LINUX8 | UBUNTU_PRO_2404`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RootVolumeConfig`  <a name="cfn-appstream-fleet-rootvolumeconfig"></a>
The configuration for the root volume of fleet instances. Use this to customize storage capacity from 200 GB up to 500 GB based on your application requirements.  
*Required*: No  
*Type*: [VolumeConfig](aws-properties-appstream-fleet-volumeconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SessionScriptS3Location`  <a name="cfn-appstream-fleet-sessionscripts3location"></a>
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.  
*Required*: No  
*Type*: [S3Location](aws-properties-appstream-fleet-s3location.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StreamView`  <a name="cfn-appstream-fleet-streamview"></a>
The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When `APP` is specified, only the windows of applications opened by users display. When `DESKTOP` is specified, the standard desktop that is provided by the operating system displays.  
The default value is `APP`.  
*Required*: No  
*Type*: String  
*Allowed values*: `APP | DESKTOP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-appstream-fleet-tags"></a>
An array of key-value pairs.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-appstream-fleet-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UsbDeviceFilterStrings`  <a name="cfn-appstream-fleet-usbdevicefilterstrings"></a>
The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcConfig`  <a name="cfn-appstream-fleet-vpcconfig"></a>
The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types.  
*Required*: No  
*Type*: [VpcConfig](aws-properties-appstream-fleet-vpcconfig.md)  
*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-resource-appstream-fleet--seealso"></a>
+ [CreateFleet](https://docs.aws.amazon.com/appstream2/latest/APIReference/API_CreateFleet.html) in the *Amazon WorkSpaces Applications API Reference*



# AWS::AppStream::Fleet ComputeCapacity
<a name="aws-properties-appstream-fleet-computecapacity"></a>

The desired capacity for a fleet.

## Syntax
<a name="aws-properties-appstream-fleet-computecapacity-syntax"></a>

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

### JSON
<a name="aws-properties-appstream-fleet-computecapacity-syntax.json"></a>

```
{
  "[DesiredInstances](#cfn-appstream-fleet-computecapacity-desiredinstances)" : Integer,
  "[DesiredSessions](#cfn-appstream-fleet-computecapacity-desiredsessions)" : Integer
}
```

### YAML
<a name="aws-properties-appstream-fleet-computecapacity-syntax.yaml"></a>

```
  [DesiredInstances](#cfn-appstream-fleet-computecapacity-desiredinstances): Integer
  [DesiredSessions](#cfn-appstream-fleet-computecapacity-desiredsessions): Integer
```

## Properties
<a name="aws-properties-appstream-fleet-computecapacity-properties"></a>

`DesiredInstances`  <a name="cfn-appstream-fleet-computecapacity-desiredinstances"></a>
The desired number of streaming instances.  
*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)

`DesiredSessions`  <a name="cfn-appstream-fleet-computecapacity-desiredsessions"></a>
The desired capacity in terms of number of user sessions, for the multi-session fleet. This is not allowed for single-session fleets.  
When you create a fleet, you must set define either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.  
*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)

# AWS::AppStream::Fleet DomainJoinInfo
<a name="aws-properties-appstream-fleet-domainjoininfo"></a>

The name of the directory and organizational unit (OU) to use to join a fleet to a Microsoft Active Directory domain.

## Syntax
<a name="aws-properties-appstream-fleet-domainjoininfo-syntax"></a>

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

### JSON
<a name="aws-properties-appstream-fleet-domainjoininfo-syntax.json"></a>

```
{
  "[DirectoryName](#cfn-appstream-fleet-domainjoininfo-directoryname)" : String,
  "[OrganizationalUnitDistinguishedName](#cfn-appstream-fleet-domainjoininfo-organizationalunitdistinguishedname)" : String
}
```

### YAML
<a name="aws-properties-appstream-fleet-domainjoininfo-syntax.yaml"></a>

```
  [DirectoryName](#cfn-appstream-fleet-domainjoininfo-directoryname): String
  [OrganizationalUnitDistinguishedName](#cfn-appstream-fleet-domainjoininfo-organizationalunitdistinguishedname): String
```

## Properties
<a name="aws-properties-appstream-fleet-domainjoininfo-properties"></a>

`DirectoryName`  <a name="cfn-appstream-fleet-domainjoininfo-directoryname"></a>
The fully qualified name of the directory (for example, corp.example.com).  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OrganizationalUnitDistinguishedName`  <a name="cfn-appstream-fleet-domainjoininfo-organizationalunitdistinguishedname"></a>
The distinguished name of the organizational unit for computer accounts.  
*Required*: No  
*Type*: String  
*Maximum*: `2000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::AppStream::Fleet S3Location
<a name="aws-properties-appstream-fleet-s3location"></a>

Describes the S3 location.

## Syntax
<a name="aws-properties-appstream-fleet-s3location-syntax"></a>

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

### JSON
<a name="aws-properties-appstream-fleet-s3location-syntax.json"></a>

```
{
  "[S3Bucket](#cfn-appstream-fleet-s3location-s3bucket)" : String,
  "[S3Key](#cfn-appstream-fleet-s3location-s3key)" : String
}
```

### YAML
<a name="aws-properties-appstream-fleet-s3location-syntax.yaml"></a>

```
  [S3Bucket](#cfn-appstream-fleet-s3location-s3bucket): String
  [S3Key](#cfn-appstream-fleet-s3location-s3key): String
```

## Properties
<a name="aws-properties-appstream-fleet-s3location-properties"></a>

`S3Bucket`  <a name="cfn-appstream-fleet-s3location-s3bucket"></a>
The S3 bucket of the S3 object.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[0-9a-z\.\-]*(?<!\.)$`  
*Minimum*: `3`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Key`  <a name="cfn-appstream-fleet-s3location-s3key"></a>
The S3 key of the S3 object.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::AppStream::Fleet Tag
<a name="aws-properties-appstream-fleet-tag"></a>

The tag of the fleet.

## Syntax
<a name="aws-properties-appstream-fleet-tag-syntax"></a>

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

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

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

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

```
  [Key](#cfn-appstream-fleet-tag-key): String
  [Value](#cfn-appstream-fleet-tag-value): String
```

## Properties
<a name="aws-properties-appstream-fleet-tag-properties"></a>

`Key`  <a name="cfn-appstream-fleet-tag-key"></a>
The key of the tag.  
*Required*: Yes  
*Type*: String  
*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-appstream-fleet-tag-value"></a>
The value of the tag.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::AppStream::Fleet VolumeConfig
<a name="aws-properties-appstream-fleet-volumeconfig"></a>

Configuration for the root volume of fleet instances and image builders. This allows you to customize the storage capacity beyond the default 200 GB.

## Syntax
<a name="aws-properties-appstream-fleet-volumeconfig-syntax"></a>

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

### JSON
<a name="aws-properties-appstream-fleet-volumeconfig-syntax.json"></a>

```
{
  "[VolumeSizeInGb](#cfn-appstream-fleet-volumeconfig-volumesizeingb)" : Integer
}
```

### YAML
<a name="aws-properties-appstream-fleet-volumeconfig-syntax.yaml"></a>

```
  [VolumeSizeInGb](#cfn-appstream-fleet-volumeconfig-volumesizeingb): Integer
```

## Properties
<a name="aws-properties-appstream-fleet-volumeconfig-properties"></a>

`VolumeSizeInGb`  <a name="cfn-appstream-fleet-volumeconfig-volumesizeingb"></a>
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.  
*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)

# AWS::AppStream::Fleet VpcConfig
<a name="aws-properties-appstream-fleet-vpcconfig"></a>

The VPC configuration information for the fleet.

## Syntax
<a name="aws-properties-appstream-fleet-vpcconfig-syntax"></a>

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

### JSON
<a name="aws-properties-appstream-fleet-vpcconfig-syntax.json"></a>

```
{
  "[SecurityGroupIds](#cfn-appstream-fleet-vpcconfig-securitygroupids)" : [ String, ... ],
  "[SubnetIds](#cfn-appstream-fleet-vpcconfig-subnetids)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-appstream-fleet-vpcconfig-syntax.yaml"></a>

```
  [SecurityGroupIds](#cfn-appstream-fleet-vpcconfig-securitygroupids): 
    - String
  [SubnetIds](#cfn-appstream-fleet-vpcconfig-subnetids): 
    - String
```

## Properties
<a name="aws-properties-appstream-fleet-vpcconfig-properties"></a>

`SecurityGroupIds`  <a name="cfn-appstream-fleet-vpcconfig-securitygroupids"></a>
The identifiers of the security groups for the fleet.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubnetIds`  <a name="cfn-appstream-fleet-vpcconfig-subnetids"></a>
The identifiers of the subnets to which a network interface is attached from the fleet instance. Fleet instances can use one or two subnets.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)