/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the appstream-2016-12-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.AppStream.Model
{
///
/// Describes a fleet.
///
public partial class Fleet
{
private string _arn;
private ComputeCapacityStatus _computeCapacityStatus;
private DateTime? _createdTime;
private string _description;
private int? _disconnectTimeoutInSeconds;
private string _displayName;
private DomainJoinInfo _domainJoinInfo;
private bool? _enableDefaultInternetAccess;
private List _fleetErrors = new List();
private FleetType _fleetType;
private string _iamRoleArn;
private int? _idleDisconnectTimeoutInSeconds;
private string _imageArn;
private string _imageName;
private string _instanceType;
private int? _maxConcurrentSessions;
private int? _maxUserDurationInSeconds;
private string _name;
private PlatformType _platform;
private S3Location _sessionScriptS3Location;
private FleetState _state;
private StreamView _streamView;
private List _usbDeviceFilterStrings = new List();
private VpcConfig _vpcConfig;
///
/// Gets and sets the property Arn.
///
/// The Amazon Resource Name (ARN) for the fleet.
///
///
[AWSProperty(Required=true)]
public string Arn
{
get { return this._arn; }
set { this._arn = value; }
}
// Check to see if Arn property is set
internal bool IsSetArn()
{
return this._arn != null;
}
///
/// Gets and sets the property ComputeCapacityStatus.
///
/// The capacity status for the fleet.
///
///
[AWSProperty(Required=true)]
public ComputeCapacityStatus ComputeCapacityStatus
{
get { return this._computeCapacityStatus; }
set { this._computeCapacityStatus = value; }
}
// Check to see if ComputeCapacityStatus property is set
internal bool IsSetComputeCapacityStatus()
{
return this._computeCapacityStatus != null;
}
///
/// Gets and sets the property CreatedTime.
///
/// The time the fleet was created.
///
///
public DateTime CreatedTime
{
get { return this._createdTime.GetValueOrDefault(); }
set { this._createdTime = value; }
}
// Check to see if CreatedTime property is set
internal bool IsSetCreatedTime()
{
return this._createdTime.HasValue;
}
///
/// Gets and sets the property Description.
///
/// The description to display.
///
///
[AWSProperty(Min=1)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
///
/// Gets and sets the property DisconnectTimeoutInSeconds.
///
/// The amount of time that a streaming session remains active after users disconnect.
/// If they 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 360000.
///
///
public int DisconnectTimeoutInSeconds
{
get { return this._disconnectTimeoutInSeconds.GetValueOrDefault(); }
set { this._disconnectTimeoutInSeconds = value; }
}
// Check to see if DisconnectTimeoutInSeconds property is set
internal bool IsSetDisconnectTimeoutInSeconds()
{
return this._disconnectTimeoutInSeconds.HasValue;
}
///
/// Gets and sets the property DisplayName.
///
/// The fleet name to display.
///
///
[AWSProperty(Min=1)]
public string DisplayName
{
get { return this._displayName; }
set { this._displayName = value; }
}
// Check to see if DisplayName property is set
internal bool IsSetDisplayName()
{
return this._displayName != null;
}
///
/// Gets and sets the property DomainJoinInfo.
///
/// The name of the directory and organizational unit (OU) to use to join the fleet to
/// a Microsoft Active Directory domain.
///
///
public DomainJoinInfo DomainJoinInfo
{
get { return this._domainJoinInfo; }
set { this._domainJoinInfo = value; }
}
// Check to see if DomainJoinInfo property is set
internal bool IsSetDomainJoinInfo()
{
return this._domainJoinInfo != null;
}
///
/// Gets and sets the property EnableDefaultInternetAccess.
///
/// Indicates whether default internet access is enabled for the fleet.
///
///
public bool EnableDefaultInternetAccess
{
get { return this._enableDefaultInternetAccess.GetValueOrDefault(); }
set { this._enableDefaultInternetAccess = value; }
}
// Check to see if EnableDefaultInternetAccess property is set
internal bool IsSetEnableDefaultInternetAccess()
{
return this._enableDefaultInternetAccess.HasValue;
}
///
/// Gets and sets the property FleetErrors.
///
/// The fleet errors.
///
///
public List FleetErrors
{
get { return this._fleetErrors; }
set { this._fleetErrors = value; }
}
// Check to see if FleetErrors property is set
internal bool IsSetFleetErrors()
{
return this._fleetErrors != null && this._fleetErrors.Count > 0;
}
///
/// Gets and sets the property FleetType.
///
/// 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.
///
///
///
public FleetType FleetType
{
get { return this._fleetType; }
set { this._fleetType = value; }
}
// Check to see if FleetType property is set
internal bool IsSetFleetType()
{
return this._fleetType != null;
}
///
/// Gets and sets the property IamRoleArn.
///
/// 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 (STS) 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.
///
///
public string IamRoleArn
{
get { return this._iamRoleArn; }
set { this._iamRoleArn = value; }
}
// Check to see if IamRoleArn property is set
internal bool IsSetIamRoleArn()
{
return this._iamRoleArn != null;
}
///
/// Gets and sets the property 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. Users are notified before they are disconnected due to inactivity.
/// If users 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 3600. The default value is 0.
///
///
///
/// 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.
///
///
///
public int IdleDisconnectTimeoutInSeconds
{
get { return this._idleDisconnectTimeoutInSeconds.GetValueOrDefault(); }
set { this._idleDisconnectTimeoutInSeconds = value; }
}
// Check to see if IdleDisconnectTimeoutInSeconds property is set
internal bool IsSetIdleDisconnectTimeoutInSeconds()
{
return this._idleDisconnectTimeoutInSeconds.HasValue;
}
///
/// Gets and sets the property ImageArn.
///
/// The ARN for the public, private, or shared image.
///
///
public string ImageArn
{
get { return this._imageArn; }
set { this._imageArn = value; }
}
// Check to see if ImageArn property is set
internal bool IsSetImageArn()
{
return this._imageArn != null;
}
///
/// Gets and sets the property ImageName.
///
/// The name of the image used to create the fleet.
///
///
[AWSProperty(Min=1)]
public string ImageName
{
get { return this._imageName; }
set { this._imageName = value; }
}
// Check to see if ImageName property is set
internal bool IsSetImageName()
{
return this._imageName != null;
}
///
/// Gets and sets the property InstanceType.
///
/// The instance type to use when launching fleet instances. The following instance types
/// are available:
///
/// -
///
/// 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
///
///
///
[AWSProperty(Required=true, Min=1)]
public string InstanceType
{
get { return this._instanceType; }
set { this._instanceType = value; }
}
// Check to see if InstanceType property is set
internal bool IsSetInstanceType()
{
return this._instanceType != null;
}
///
/// Gets and sets the property MaxConcurrentSessions.
///
/// The maximum number of concurrent sessions for the fleet.
///
///
public int MaxConcurrentSessions
{
get { return this._maxConcurrentSessions.GetValueOrDefault(); }
set { this._maxConcurrentSessions = value; }
}
// Check to see if MaxConcurrentSessions property is set
internal bool IsSetMaxConcurrentSessions()
{
return this._maxConcurrentSessions.HasValue;
}
///
/// Gets and sets the property MaxUserDurationInSeconds.
///
/// 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 360000.
///
///
public int MaxUserDurationInSeconds
{
get { return this._maxUserDurationInSeconds.GetValueOrDefault(); }
set { this._maxUserDurationInSeconds = value; }
}
// Check to see if MaxUserDurationInSeconds property is set
internal bool IsSetMaxUserDurationInSeconds()
{
return this._maxUserDurationInSeconds.HasValue;
}
///
/// Gets and sets the property Name.
///
/// The name of the fleet.
///
///
[AWSProperty(Required=true, Min=1)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
///
/// Gets and sets the property Platform.
///
/// The platform of the fleet.
///
///
public PlatformType Platform
{
get { return this._platform; }
set { this._platform = value; }
}
// Check to see if Platform property is set
internal bool IsSetPlatform()
{
return this._platform != null;
}
///
/// Gets and sets the property SessionScriptS3Location.
///
/// The S3 location of the session scripts configuration zip file. This only applies to
/// Elastic fleets.
///
///
public S3Location SessionScriptS3Location
{
get { return this._sessionScriptS3Location; }
set { this._sessionScriptS3Location = value; }
}
// Check to see if SessionScriptS3Location property is set
internal bool IsSetSessionScriptS3Location()
{
return this._sessionScriptS3Location != null;
}
///
/// Gets and sets the property State.
///
/// The current state for the fleet.
///
///
[AWSProperty(Required=true)]
public FleetState State
{
get { return this._state; }
set { this._state = value; }
}
// Check to see if State property is set
internal bool IsSetState()
{
return this._state != null;
}
///
/// Gets and sets the property 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.
///
///
///
/// The default value is APP
.
///
///
public StreamView StreamView
{
get { return this._streamView; }
set { this._streamView = value; }
}
// Check to see if StreamView property is set
internal bool IsSetStreamView()
{
return this._streamView != null;
}
///
/// Gets and sets the property UsbDeviceFilterStrings.
///
/// The USB device filter strings associated with the fleet.
///
///
public List UsbDeviceFilterStrings
{
get { return this._usbDeviceFilterStrings; }
set { this._usbDeviceFilterStrings = value; }
}
// Check to see if UsbDeviceFilterStrings property is set
internal bool IsSetUsbDeviceFilterStrings()
{
return this._usbDeviceFilterStrings != null && this._usbDeviceFilterStrings.Count > 0;
}
///
/// Gets and sets the property VpcConfig.
///
/// The VPC configuration for the fleet.
///
///
public VpcConfig VpcConfig
{
get { return this._vpcConfig; }
set { this._vpcConfig = value; }
}
// Check to see if VpcConfig property is set
internal bool IsSetVpcConfig()
{
return this._vpcConfig != null;
}
}
}