class CfnFleet (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.AppStream.CfnFleet`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappstream#CfnFleet`
Java	`software.amazon.awscdk.services.appstream.CfnFleet`
Python	`aws_cdk.aws_appstream.CfnFleet`
TypeScript	`aws-cdk-lib` » `aws_appstream` » `CfnFleet`

Implements IConstruct, IDependable, IInspectable, ITaggable

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

Example

const fleet = new appstream.CfnFleet(this, 'Fleet', {
  instanceType: 'stream.standard.small',
  name: 'Fleet',
  computeCapacity: {
    desiredInstances: 1,
  },
  imageName: 'AppStream-AmazonLinux2-09-21-2022',
});
fleet.cfnOptions.creationPolicy = {
  startFleet: true,
};

Initializer

new CfnFleet(scope: Construct, id: string, props: CfnFleetProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnFleetProps — Resource properties.

Construct Props

Name	Type	Description
instanceType	`string`	The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:.
name	`string`	A unique name for the fleet.
computeCapacity?	`IResolvable` `\|` `ComputeCapacityProperty`	The desired capacity for the fleet.
description?	`string`	The description to display.
disconnectTimeoutInSeconds?	`number`	The amount of time that a streaming session remains active after users disconnect.
displayName?	`string`	The fleet name to display.
domainJoinInfo?	`IResolvable` `\|` `DomainJoinInfoProperty`	The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
enableDefaultInternetAccess?	`boolean \|` `IResolvable`	Enables or disables default internet access for the fleet.
fleetType?	`string`	The fleet type.
iamRoleArn?	`string`	The ARN of the IAM role that is applied to the fleet.
idleDisconnectTimeoutInSeconds?	`number`	The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the `DisconnectTimeoutInSeconds` time interval begins.
imageArn?	`string`	The ARN of the public, private, or shared image to use.
imageName?	`string`	The name of the image used to create the fleet.
maxConcurrentSessions?	`number`	The maximum number of concurrent sessions that can be run on an Elastic fleet.
maxSessionsPerInstance?	`number`	Max number of user sessions on an instance.
maxUserDurationInSeconds?	`number`	The maximum amount of time that a streaming session can remain active, in seconds.
platform?	`string`	The platform of the fleet.
sessionScriptS3Location?	`IResolvable` `\|` `S3LocationProperty`	The S3 location of the session scripts configuration zip file.
streamView?	`string`	The AppStream 2.0 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.
tags?	`CfnTag[]`	An array of key-value pairs.
usbDeviceFilterStrings?	`string[]`	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.
vpcConfig?	`IResolvable` `\|` `VpcConfigProperty`	The VPC configuration for the fleet.

instanceType

Type: string

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-desktop.2xlarge
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-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge

The following instance types are available for Elastic fleets:

stream.standard.small
stream.standard.medium

name

Type: string

A unique name for the fleet.

computeCapacity?

Type: IResolvable | ComputeCapacityProperty (optional)

The desired capacity for the fleet.

This is not allowed for Elastic fleets.

description?

Type: string (optional)

The description to display.

disconnectTimeoutInSeconds?

Type: number (optional)

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.

displayName?

Type: string (optional)

The fleet name to display.

domainJoinInfo?

Type: IResolvable | DomainJoinInfoProperty (optional)

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.

enableDefaultInternetAccess?

Type: boolean | IResolvable (optional)

Enables or disables default internet access for the fleet.

fleetType?

Type: string (optional)

The fleet type.

ALWAYS_ON - 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_DEMAND - 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 AppStream 2.0. 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 | ELASTIC | ON_DEMAND

iamRoleArn?

Type: string (optional)

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. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

idleDisconnectTimeoutInSeconds?

Type: number (optional)

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.

imageArn?

Type: string (optional)

The ARN of the public, private, or shared image to use.

imageName?

Type: string (optional)

The name of the image used to create the fleet.

maxConcurrentSessions?

Type: number (optional)

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.

maxSessionsPerInstance?

Type: number (optional)

Max number of user sessions on an instance.

This is applicable only for multi-session fleets.

maxUserDurationInSeconds?

Type: number (optional)

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.

platform?

Type: string (optional)

The platform of the fleet.

Platform is a required setting for Elastic fleets, and is not used for other fleet types.

sessionScriptS3Location?

Type: IResolvable | S3LocationProperty (optional)

The S3 location of the session scripts configuration zip file.

This only applies to Elastic fleets.

streamView?

Type: string (optional)

The AppStream 2.0 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 .

tags?

Type: CfnTag[] (optional)

An array of key-value pairs.

usbDeviceFilterStrings?

Type: string[] (optional)

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.

vpcConfig?

Type: IResolvable | VpcConfigProperty (optional)

The VPC configuration for the fleet.

This is required for Elastic fleets, but not required for other fleet types.

Properties

Name	Type	Description
attrId	`string`
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
instanceType	`string`	The instance type to use when launching fleet instances.
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	A unique name for the fleet.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
computeCapacity?	`IResolvable` `\|` `ComputeCapacityProperty`	The desired capacity for the fleet.
description?	`string`	The description to display.
disconnectTimeoutInSeconds?	`number`	The amount of time that a streaming session remains active after users disconnect.
displayName?	`string`	The fleet name to display.
domainJoinInfo?	`IResolvable` `\|` `DomainJoinInfoProperty`	The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
enableDefaultInternetAccess?	`boolean \|` `IResolvable`	Enables or disables default internet access for the fleet.
fleetType?	`string`	The fleet type.
iamRoleArn?	`string`	The ARN of the IAM role that is applied to the fleet.
idleDisconnectTimeoutInSeconds?	`number`	The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the `DisconnectTimeoutInSeconds` time interval begins.
imageArn?	`string`	The ARN of the public, private, or shared image to use.
imageName?	`string`	The name of the image used to create the fleet.
maxConcurrentSessions?	`number`	The maximum number of concurrent sessions that can be run on an Elastic fleet.
maxSessionsPerInstance?	`number`	Max number of user sessions on an instance.
maxUserDurationInSeconds?	`number`	The maximum amount of time that a streaming session can remain active, in seconds.
platform?	`string`	The platform of the fleet.
sessionScriptS3Location?	`IResolvable` `\|` `S3LocationProperty`	The S3 location of the session scripts configuration zip file.
streamView?	`string`	The AppStream 2.0 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.
tagsRaw?	`CfnTag[]`	An array of key-value pairs.
usbDeviceFilterStrings?	`string[]`	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.
vpcConfig?	`IResolvable` `\|` `VpcConfigProperty`	The VPC configuration for the fleet.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

The following instance types are available for non-Elastic fleets:.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

A unique name for the fleet.

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

platform?

Type: string (optional)

The platform of the fleet.

sessionScriptS3Location?

Type: IResolvable | S3LocationProperty (optional)

The S3 location of the session scripts configuration zip file.

streamView?

Type: string (optional)

tagsRaw?

Type: CfnTag[] (optional)

An array of key-value pairs.

usbDeviceFilterStrings?

Type: string[] (optional)

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.

vpcConfig?

Type: IResolvable | VpcConfigProperty (optional)

The VPC configuration for the fleet.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }