Class CfnFleet
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.
Inherited Members
Namespace: Amazon.CDK.AWS.AppStream
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFleet : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnFleet
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html
CloudformationResource: AWS::AppStream::Fleet
ExampleMetadata: infused
Examples
var fleet = new CfnFleet(this, "Fleet", new CfnFleetProps {
InstanceType = "stream.standard.small",
Name = "Fleet",
ComputeCapacity = new ComputeCapacityProperty {
DesiredInstances = 1
},
ImageName = "AppStream-AmazonLinux2-09-21-2022"
});
fleet.CfnOptions.CreationPolicy = new CfnCreationPolicy {
StartFleet = true
};
Synopsis
Constructors
CfnFleet(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFleet(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnFleet(Construct, String, ICfnFleetProps) |
Properties
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ComputeCapacity | The desired capacity for the fleet. |
Description | The description to display. |
DisconnectTimeoutInSeconds | The amount of time that a streaming session remains active after users disconnect. |
DisplayName | The fleet name to display. |
DomainJoinInfo | The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. |
EnableDefaultInternetAccess | Enables or disables default internet access for the fleet. |
FleetType | The fleet type. |
IamRoleArn | The ARN of the IAM role that is applied to the fleet. |
IdleDisconnectTimeoutInSeconds | The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the |
ImageArn | The ARN of the public, private, or shared image to use. |
ImageName | The name of the image used to create the fleet. |
InstanceType | The instance type to use when launching fleet instances. |
MaxConcurrentSessions | The maximum number of concurrent sessions that can be run on an Elastic fleet. |
MaxSessionsPerInstance | Max number of user sessions on an instance. |
MaxUserDurationInSeconds | The maximum amount of time that a streaming session can remain active, in seconds. |
Name | A unique name for the fleet. |
Platform | The platform of the fleet. |
SessionScriptS3Location | The S3 location of the session scripts configuration zip file. |
StreamView | The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs. |
UsbDeviceFilterStrings | 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 | The VPC configuration for the fleet. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFleet(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFleet(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFleet(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFleet(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnFleet(Construct, String, ICfnFleetProps)
public CfnFleet(Construct scope, string id, ICfnFleetProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnFleetProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ComputeCapacity
The desired capacity for the fleet.
public virtual object ComputeCapacity { get; set; }
Property Value
System.Object
Description
The description to display.
public virtual string Description { get; set; }
Property Value
System.String
DisconnectTimeoutInSeconds
The amount of time that a streaming session remains active after users disconnect.
public virtual Nullable<double> DisconnectTimeoutInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
DisplayName
The fleet name to display.
public virtual string DisplayName { get; set; }
Property Value
System.String
DomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
public virtual object DomainJoinInfo { get; set; }
Property Value
System.Object
EnableDefaultInternetAccess
Enables or disables default internet access for the fleet.
public virtual object EnableDefaultInternetAccess { get; set; }
Property Value
System.Object
FleetType
The fleet type.
public virtual string FleetType { get; set; }
Property Value
System.String
IamRoleArn
The ARN of the IAM role that is applied to the fleet.
public virtual string IamRoleArn { get; set; }
Property Value
System.String
IdleDisconnectTimeoutInSeconds
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds
time interval begins.
public virtual Nullable<double> IdleDisconnectTimeoutInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
ImageArn
The ARN of the public, private, or shared image to use.
public virtual string ImageArn { get; set; }
Property Value
System.String
ImageName
The name of the image used to create the fleet.
public virtual string ImageName { get; set; }
Property Value
System.String
InstanceType
The instance type to use when launching fleet instances.
public virtual string InstanceType { get; set; }
Property Value
System.String
Remarks
The following instance types are available for non-Elastic fleets:.
MaxConcurrentSessions
The maximum number of concurrent sessions that can be run on an Elastic fleet.
public virtual Nullable<double> MaxConcurrentSessions { get; set; }
Property Value
System.Nullable<System.Double>
MaxSessionsPerInstance
Max number of user sessions on an instance.
public virtual Nullable<double> MaxSessionsPerInstance { get; set; }
Property Value
System.Nullable<System.Double>
MaxUserDurationInSeconds
The maximum amount of time that a streaming session can remain active, in seconds.
public virtual Nullable<double> MaxUserDurationInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Name
A unique name for the fleet.
public virtual string Name { get; set; }
Property Value
System.String
Platform
The platform of the fleet.
public virtual string Platform { get; set; }
Property Value
System.String
SessionScriptS3Location
The S3 location of the session scripts configuration zip file.
public virtual object SessionScriptS3Location { get; set; }
Property Value
System.Object
StreamView
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.
public virtual string StreamView { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
UsbDeviceFilterStrings
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.
public virtual string[] UsbDeviceFilterStrings { get; set; }
Property Value
System.String[]
VpcConfig
The VPC configuration for the fleet.
public virtual object VpcConfig { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>