Class CfnFleetMixinProps
Properties for CfnFleetPropsMixin.
Implements
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.AppStream
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnFleetMixinProps : ICfnFleetMixinPropsSyntax (vb)
Public Class CfnFleetMixinProps Implements ICfnFleetMixinPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.AppStream;
var cfnFleetMixinProps = new CfnFleetMixinProps {
ComputeCapacity = new ComputeCapacityProperty {
DesiredInstances = 123,
DesiredSessions = 123
},
Description = "description",
DisconnectTimeoutInSeconds = 123,
DisplayName = "displayName",
DomainJoinInfo = new DomainJoinInfoProperty {
DirectoryName = "directoryName",
OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName"
},
EnableDefaultInternetAccess = false,
FleetType = "fleetType",
IamRoleArn = "iamRoleArn",
IdleDisconnectTimeoutInSeconds = 123,
ImageArn = "imageArn",
ImageName = "imageName",
InstanceType = "instanceType",
MaxConcurrentSessions = 123,
MaxSessionsPerInstance = 123,
MaxUserDurationInSeconds = 123,
Name = "name",
Platform = "platform",
RootVolumeConfig = new VolumeConfigProperty {
VolumeSizeInGb = 123
},
SessionScriptS3Location = new S3LocationProperty {
S3Bucket = "s3Bucket",
S3Key = "s3Key"
},
StreamView = "streamView",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UsbDeviceFilterStrings = new [] { "usbDeviceFilterStrings" },
VpcConfig = new VpcConfigProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
};Synopsis
Constructors
| CfnFleetMixinProps() | Properties for CfnFleetPropsMixin. |
Properties
| 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. 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. |
| 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. |
| RootVolumeConfig | Properties for CfnFleetPropsMixin. |
| SessionScriptS3Location | The S3 location of the session scripts configuration zip file. |
| StreamView | The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. |
| Tags | 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. |
Constructors
CfnFleetMixinProps()
Properties for CfnFleetPropsMixin.
public CfnFleetMixinProps()Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.AppStream;
var cfnFleetMixinProps = new CfnFleetMixinProps {
ComputeCapacity = new ComputeCapacityProperty {
DesiredInstances = 123,
DesiredSessions = 123
},
Description = "description",
DisconnectTimeoutInSeconds = 123,
DisplayName = "displayName",
DomainJoinInfo = new DomainJoinInfoProperty {
DirectoryName = "directoryName",
OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName"
},
EnableDefaultInternetAccess = false,
FleetType = "fleetType",
IamRoleArn = "iamRoleArn",
IdleDisconnectTimeoutInSeconds = 123,
ImageArn = "imageArn",
ImageName = "imageName",
InstanceType = "instanceType",
MaxConcurrentSessions = 123,
MaxSessionsPerInstance = 123,
MaxUserDurationInSeconds = 123,
Name = "name",
Platform = "platform",
RootVolumeConfig = new VolumeConfigProperty {
VolumeSizeInGb = 123
},
SessionScriptS3Location = new S3LocationProperty {
S3Bucket = "s3Bucket",
S3Key = "s3Key"
},
StreamView = "streamView",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UsbDeviceFilterStrings = new [] { "usbDeviceFilterStrings" },
VpcConfig = new VpcConfigProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
};Properties
ComputeCapacity
The desired capacity for the fleet.
public object? ComputeCapacity { get; set; }Property Value
Remarks
This is not allowed for Elastic fleets.
Type union: either IResolvable or CfnFleetPropsMixin.IComputeCapacityProperty
Description
The description to display.
public string? Description { get; set; }Property Value
Remarks
DisconnectTimeoutInSeconds
The amount of time that a streaming session remains active after users disconnect.
public double? DisconnectTimeoutInSeconds { get; set; }Property Value
Remarks
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
The fleet name to display.
public string? DisplayName { get; set; }Property Value
Remarks
DomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
public object? DomainJoinInfo { get; set; }Property Value
Remarks
This is not allowed for Elastic fleets.
Type union: either IResolvable or CfnFleetPropsMixin.IDomainJoinInfoProperty
EnableDefaultInternetAccess
Enables or disables default internet access for the fleet.
public object? EnableDefaultInternetAccess { get; set; }Property Value
Remarks
FleetType
The fleet type.
public string? FleetType { get; set; }Property Value
Remarks
Allowed Values : ALWAYS_ON | ELASTIC | ON_DEMAND
IamRoleArn
The ARN of the IAM role that is applied to the fleet.
public string? IamRoleArn { get; set; }Property Value
Remarks
To assume a role, the fleet instance calls the 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
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 double? IdleDisconnectTimeoutInSeconds { get; set; }Property Value
Remarks
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
The ARN of the public, private, or shared image to use.
public string? ImageArn { get; set; }Property Value
Remarks
ImageName
The name of the image used to create the fleet.
public string? ImageName { get; set; }Property Value
Remarks
InstanceType
The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:.
public string? InstanceType { get; set; }Property Value
Remarks
The following instance types are available for Elastic fleets:
MaxConcurrentSessions
The maximum number of concurrent sessions that can be run on an Elastic fleet.
public double? MaxConcurrentSessions { get; set; }Property Value
Remarks
This setting is required for Elastic fleets, but is not used for other fleet types.
MaxSessionsPerInstance
Max number of user sessions on an instance.
public double? MaxSessionsPerInstance { get; set; }Property Value
Remarks
This is applicable only for multi-session fleets.
MaxUserDurationInSeconds
The maximum amount of time that a streaming session can remain active, in seconds.
public double? MaxUserDurationInSeconds { get; set; }Property Value
Remarks
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.
Name
A unique name for the fleet.
public string? Name { get; set; }Property Value
Remarks
Platform
The platform of the fleet.
public string? Platform { get; set; }Property Value
Remarks
Platform is a required setting for Elastic fleets, and is not used for other fleet types.
RootVolumeConfig
Properties for CfnFleetPropsMixin.
public object? RootVolumeConfig { get; set; }Property Value
Remarks
SessionScriptS3Location
The S3 location of the session scripts configuration zip file.
public object? SessionScriptS3Location { get; set; }Property Value
Remarks
This only applies to Elastic fleets.
Type union: either IResolvable or CfnFleetPropsMixin.IS3LocationProperty
StreamView
The WorkSpaces Applications view that is displayed to your users when they stream from the fleet.
public string? StreamView { get; set; }Property Value
Remarks
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
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 string[]? UsbDeviceFilterStrings { get; set; }Property Value
string[]
Remarks
This is allowed but not required for Elastic fleets.
VpcConfig
The VPC configuration for the fleet.
public object? VpcConfig { get; set; }Property Value
Remarks
This is required for Elastic fleets, but not required for other fleet types.
Type union: either IResolvable or CfnFleetPropsMixin.IVpcConfigProperty