commonMain.aws.sdk.kotlin.services.appstream.model.CreateFleetRequest.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of appstream-jvm Show documentation
Show all versions of appstream-jvm Show documentation
The AWS SDK for Kotlin client for AppStream
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.appstream.model
class CreateFleetRequest private constructor(builder: Builder) {
/**
* The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
*/
val computeCapacity: aws.sdk.kotlin.services.appstream.model.ComputeCapacity? = builder.computeCapacity
/**
* The description to display.
*/
val description: kotlin.String? = builder.description
/**
* 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 360000.
*/
val disconnectTimeoutInSeconds: kotlin.Int? = builder.disconnectTimeoutInSeconds
/**
* The fleet name to display.
*/
val displayName: kotlin.String? = builder.displayName
/**
* 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.
*/
val domainJoinInfo: aws.sdk.kotlin.services.appstream.model.DomainJoinInfo? = builder.domainJoinInfo
/**
* Enables or disables default internet access for the fleet.
*/
val enableDefaultInternetAccess: kotlin.Boolean? = builder.enableDefaultInternetAccess
/**
* 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.
*/
val fleetType: aws.sdk.kotlin.services.appstream.model.FleetType? = builder.fleetType
/**
* The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a 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](https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) in the *Amazon AppStream 2.0 Administration Guide*.
*/
val iamRoleArn: kotlin.String? = builder.iamRoleArn
/**
* 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 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.
*/
val idleDisconnectTimeoutInSeconds: kotlin.Int? = builder.idleDisconnectTimeoutInSeconds
/**
* The ARN of the public, private, or shared image to use.
*/
val imageArn: kotlin.String? = builder.imageArn
/**
* The name of the image used to create the fleet.
*/
val imageName: kotlin.String? = builder.imageName
/**
* 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
*
* The following instance types are available for Elastic fleets:
* + stream.standard.small
* + stream.standard.medium
*/
val instanceType: kotlin.String? = builder.instanceType
/**
* The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.
*/
val maxConcurrentSessions: kotlin.Int? = builder.maxConcurrentSessions
/**
* 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.
*/
val maxUserDurationInSeconds: kotlin.Int? = builder.maxUserDurationInSeconds
/**
* A unique name for the fleet.
*/
val name: kotlin.String? = builder.name
/**
* The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
*/
val platform: aws.sdk.kotlin.services.appstream.model.PlatformType? = builder.platform
/**
* The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*/
val sessionScriptS3Location: aws.sdk.kotlin.services.appstream.model.S3Location? = builder.sessionScriptS3Location
/**
* 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`.
*/
val streamView: aws.sdk.kotlin.services.appstream.model.StreamView? = builder.streamView
/**
* The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
*
* If you do not specify a value, the value is set to an empty string.
*
* Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
*
* _ . : / = + \ - @
*
* For more information, see [Tagging Your Resources](https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) in the *Amazon AppStream 2.0 Administration Guide*.
*/
val tags: Map? = builder.tags
/**
* 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.
*/
val usbDeviceFilterStrings: List? = builder.usbDeviceFilterStrings
/**
* The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
*/
val vpcConfig: aws.sdk.kotlin.services.appstream.model.VpcConfig? = builder.vpcConfig
companion object {
operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.appstream.model.CreateFleetRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("CreateFleetRequest(")
append("computeCapacity=$computeCapacity,")
append("description=$description,")
append("disconnectTimeoutInSeconds=$disconnectTimeoutInSeconds,")
append("displayName=$displayName,")
append("domainJoinInfo=$domainJoinInfo,")
append("enableDefaultInternetAccess=$enableDefaultInternetAccess,")
append("fleetType=$fleetType,")
append("iamRoleArn=$iamRoleArn,")
append("idleDisconnectTimeoutInSeconds=$idleDisconnectTimeoutInSeconds,")
append("imageArn=$imageArn,")
append("imageName=$imageName,")
append("instanceType=$instanceType,")
append("maxConcurrentSessions=$maxConcurrentSessions,")
append("maxUserDurationInSeconds=$maxUserDurationInSeconds,")
append("name=$name,")
append("platform=$platform,")
append("sessionScriptS3Location=$sessionScriptS3Location,")
append("streamView=$streamView,")
append("tags=$tags,")
append("usbDeviceFilterStrings=$usbDeviceFilterStrings,")
append("vpcConfig=$vpcConfig)")
}
override fun hashCode(): kotlin.Int {
var result = computeCapacity?.hashCode() ?: 0
result = 31 * result + (description?.hashCode() ?: 0)
result = 31 * result + (disconnectTimeoutInSeconds ?: 0)
result = 31 * result + (displayName?.hashCode() ?: 0)
result = 31 * result + (domainJoinInfo?.hashCode() ?: 0)
result = 31 * result + (enableDefaultInternetAccess?.hashCode() ?: 0)
result = 31 * result + (fleetType?.hashCode() ?: 0)
result = 31 * result + (iamRoleArn?.hashCode() ?: 0)
result = 31 * result + (idleDisconnectTimeoutInSeconds ?: 0)
result = 31 * result + (imageArn?.hashCode() ?: 0)
result = 31 * result + (imageName?.hashCode() ?: 0)
result = 31 * result + (instanceType?.hashCode() ?: 0)
result = 31 * result + (maxConcurrentSessions ?: 0)
result = 31 * result + (maxUserDurationInSeconds ?: 0)
result = 31 * result + (name?.hashCode() ?: 0)
result = 31 * result + (platform?.hashCode() ?: 0)
result = 31 * result + (sessionScriptS3Location?.hashCode() ?: 0)
result = 31 * result + (streamView?.hashCode() ?: 0)
result = 31 * result + (tags?.hashCode() ?: 0)
result = 31 * result + (usbDeviceFilterStrings?.hashCode() ?: 0)
result = 31 * result + (vpcConfig?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as CreateFleetRequest
if (computeCapacity != other.computeCapacity) return false
if (description != other.description) return false
if (disconnectTimeoutInSeconds != other.disconnectTimeoutInSeconds) return false
if (displayName != other.displayName) return false
if (domainJoinInfo != other.domainJoinInfo) return false
if (enableDefaultInternetAccess != other.enableDefaultInternetAccess) return false
if (fleetType != other.fleetType) return false
if (iamRoleArn != other.iamRoleArn) return false
if (idleDisconnectTimeoutInSeconds != other.idleDisconnectTimeoutInSeconds) return false
if (imageArn != other.imageArn) return false
if (imageName != other.imageName) return false
if (instanceType != other.instanceType) return false
if (maxConcurrentSessions != other.maxConcurrentSessions) return false
if (maxUserDurationInSeconds != other.maxUserDurationInSeconds) return false
if (name != other.name) return false
if (platform != other.platform) return false
if (sessionScriptS3Location != other.sessionScriptS3Location) return false
if (streamView != other.streamView) return false
if (tags != other.tags) return false
if (usbDeviceFilterStrings != other.usbDeviceFilterStrings) return false
if (vpcConfig != other.vpcConfig) return false
return true
}
inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.appstream.model.CreateFleetRequest = Builder(this).apply(block).build()
class Builder {
/**
* The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
*/
var computeCapacity: aws.sdk.kotlin.services.appstream.model.ComputeCapacity? = null
/**
* The description to display.
*/
var description: kotlin.String? = null
/**
* 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 360000.
*/
var disconnectTimeoutInSeconds: kotlin.Int? = null
/**
* The fleet name to display.
*/
var displayName: kotlin.String? = null
/**
* 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.
*/
var domainJoinInfo: aws.sdk.kotlin.services.appstream.model.DomainJoinInfo? = null
/**
* Enables or disables default internet access for the fleet.
*/
var enableDefaultInternetAccess: kotlin.Boolean? = null
/**
* 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.
*/
var fleetType: aws.sdk.kotlin.services.appstream.model.FleetType? = null
/**
* The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a 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](https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) in the *Amazon AppStream 2.0 Administration Guide*.
*/
var iamRoleArn: kotlin.String? = null
/**
* 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 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.
*/
var idleDisconnectTimeoutInSeconds: kotlin.Int? = null
/**
* The ARN of the public, private, or shared image to use.
*/
var imageArn: kotlin.String? = null
/**
* The name of the image used to create the fleet.
*/
var imageName: kotlin.String? = null
/**
* 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
*
* The following instance types are available for Elastic fleets:
* + stream.standard.small
* + stream.standard.medium
*/
var instanceType: kotlin.String? = null
/**
* The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.
*/
var maxConcurrentSessions: kotlin.Int? = null
/**
* 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.
*/
var maxUserDurationInSeconds: kotlin.Int? = null
/**
* A unique name for the fleet.
*/
var name: kotlin.String? = null
/**
* The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
*/
var platform: aws.sdk.kotlin.services.appstream.model.PlatformType? = null
/**
* The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*/
var sessionScriptS3Location: aws.sdk.kotlin.services.appstream.model.S3Location? = null
/**
* 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`.
*/
var streamView: aws.sdk.kotlin.services.appstream.model.StreamView? = null
/**
* The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
*
* If you do not specify a value, the value is set to an empty string.
*
* Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
*
* _ . : / = + \ - @
*
* For more information, see [Tagging Your Resources](https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) in the *Amazon AppStream 2.0 Administration Guide*.
*/
var tags: Map? = null
/**
* 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.
*/
var usbDeviceFilterStrings: List? = null
/**
* The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
*/
var vpcConfig: aws.sdk.kotlin.services.appstream.model.VpcConfig? = null
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.appstream.model.CreateFleetRequest) : this() {
this.computeCapacity = x.computeCapacity
this.description = x.description
this.disconnectTimeoutInSeconds = x.disconnectTimeoutInSeconds
this.displayName = x.displayName
this.domainJoinInfo = x.domainJoinInfo
this.enableDefaultInternetAccess = x.enableDefaultInternetAccess
this.fleetType = x.fleetType
this.iamRoleArn = x.iamRoleArn
this.idleDisconnectTimeoutInSeconds = x.idleDisconnectTimeoutInSeconds
this.imageArn = x.imageArn
this.imageName = x.imageName
this.instanceType = x.instanceType
this.maxConcurrentSessions = x.maxConcurrentSessions
this.maxUserDurationInSeconds = x.maxUserDurationInSeconds
this.name = x.name
this.platform = x.platform
this.sessionScriptS3Location = x.sessionScriptS3Location
this.streamView = x.streamView
this.tags = x.tags
this.usbDeviceFilterStrings = x.usbDeviceFilterStrings
this.vpcConfig = x.vpcConfig
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.appstream.model.CreateFleetRequest = CreateFleetRequest(this)
/**
* construct an [aws.sdk.kotlin.services.appstream.model.ComputeCapacity] inside the given [block]
*/
fun computeCapacity(block: aws.sdk.kotlin.services.appstream.model.ComputeCapacity.Builder.() -> kotlin.Unit) {
this.computeCapacity = aws.sdk.kotlin.services.appstream.model.ComputeCapacity.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.appstream.model.DomainJoinInfo] inside the given [block]
*/
fun domainJoinInfo(block: aws.sdk.kotlin.services.appstream.model.DomainJoinInfo.Builder.() -> kotlin.Unit) {
this.domainJoinInfo = aws.sdk.kotlin.services.appstream.model.DomainJoinInfo.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.appstream.model.S3Location] inside the given [block]
*/
fun sessionScriptS3Location(block: aws.sdk.kotlin.services.appstream.model.S3Location.Builder.() -> kotlin.Unit) {
this.sessionScriptS3Location = aws.sdk.kotlin.services.appstream.model.S3Location.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.appstream.model.VpcConfig] inside the given [block]
*/
fun vpcConfig(block: aws.sdk.kotlin.services.appstream.model.VpcConfig.Builder.() -> kotlin.Unit) {
this.vpcConfig = aws.sdk.kotlin.services.appstream.model.VpcConfig.invoke(block)
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy