String name
The name of the application.
String displayName
The application name to display.
String iconURL
The URL for the application icon. This URL might be time-limited.
String launchPath
The path to the application executable in the instance.
String launchParameters
The arguments that are passed to the application at launch.
Boolean enabled
If there is a problem, the application can be disabled after image creation.
Map<K,V> metadata
Additional attributes that describe the application.
Boolean enabled
Enables or disables persistent application settings for users during their streaming sessions.
String settingsGroup
The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
Boolean enabled
Specifies whether persistent application settings are enabled for users during their streaming sessions.
String settingsGroup
The path prefix for the S3 bucket where users’ persistent application settings are stored.
String s3BucketName
The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
Integer desiredInstances
The desired number of streaming instances.
Integer desired
The desired number of streaming instances.
Integer running
The total number of simultaneous streaming instances that are running.
Integer inUse
The number of instances in use for streaming.
Integer available
The number of currently available instances that can be used to stream sessions.
String sourceImageName
The name of the image to copy.
String destinationImageName
The name that the image will have when it is copied to the destination.
String destinationRegion
The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.
String destinationImageDescription
The description that the image will have when it is copied to the destination.
String destinationImageName
The name of the destination image.
String directoryName
The fully qualified name of the directory (for example, corp.example.com).
List<E> organizationalUnitDistinguishedNames
The distinguished names of the organizational units for computer accounts.
ServiceAccountCredentials serviceAccountCredentials
The credentials for the service account used by the fleet or image builder to connect to the directory.
DirectoryConfig directoryConfig
Information about the directory configuration.
String name
A unique name for the fleet.
String imageName
The name of the image used to create the fleet.
String imageArn
The ARN of the public, private, or shared image to use.
String instanceType
The instance type to use when launching fleet instances. The following instance types are available:
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.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
String fleetType
The fleet type.
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.
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.
ComputeCapacity computeCapacity
The desired capacity for the fleet.
VpcConfig vpcConfig
The VPC configuration for the fleet.
Integer 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.
Integer disconnectTimeoutInSeconds
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.
String description
The description to display.
String displayName
The fleet name to display.
Boolean enableDefaultInternetAccess
Enables or disables default internet access for the fleet.
DomainJoinInfo domainJoinInfo
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
Map<K,V> tags
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 in the Amazon AppStream 2.0 Administration Guide.
Integer 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 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.
String iamRoleArn
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 in the Amazon AppStream 2.0 Administration Guide.
Fleet fleet
Information about the fleet.
String name
A unique name for the image builder.
String imageName
The name of the image used to create the image builder.
String imageArn
The ARN of the public, private, or shared image to use.
String instanceType
The instance type to use when launching the image builder. The following instance types are available:
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.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
String description
The description to display.
String displayName
The image builder name to display.
VpcConfig vpcConfig
The VPC configuration for the image builder. You can specify only one subnet.
String iamRoleArn
The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder
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.
Boolean enableDefaultInternetAccess
Enables or disables default internet access for the image builder.
DomainJoinInfo domainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
String appstreamAgentVersion
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
Map<K,V> tags
The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + \ - @
If you do not specify a value, the value is set to an empty string.
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
List<E> accessEndpoints
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
ImageBuilder imageBuilder
Information about the image builder.
String name
The name of the stack.
String description
The description to display.
String displayName
The stack name to display.
List<E> storageConnectors
The storage connectors to enable.
String redirectURL
The URL that users are redirected to after their streaming session ends.
String feedbackURL
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
List<E> userSettings
The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
ApplicationSettings applicationSettings
The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
Map<K,V> tags
The tags to associate with the stack. 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 about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
List<E> accessEndpoints
The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
List<E> embedHostDomains
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
Stack stack
Information about the stack.
String stackName
The name of the stack.
String fleetName
The name of the fleet.
String userId
The identifier of the user.
String applicationId
The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant.
Long validity
The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.
String sessionContext
The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.
String s3BucketName
The Amazon S3 bucket where generated reports are stored.
If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
String schedule
The schedule for generating usage reports.
String userName
The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
String messageAction
The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
String firstName
The first name, or given name, of the user.
String lastName
The last name, or surname, of the user.
String authenticationType
The authentication type for the user. You must specify USERPOOL.
String directoryName
The name of the directory configuration.
String name
The name of the fleet.
String name
The name of the image builder.
ImageBuilder imageBuilder
Information about the image builder.
String name
The name of the image.
Image image
Information about the image.
String name
The name of the stack.
List<E> directoryConfigs
Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
List<E> names
The names of the image builders to describe.
Integer maxResults
The maximum size of each page of results.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
String name
The name of the private image for which to describe permissions. The image must be one that you own.
Integer maxResults
The maximum size of each page of results.
List<E> sharedAwsAccountIds
The 12-digit identifier of one or more AWS accounts with which the image is shared.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
String name
The name of the private image.
List<E> sharedImagePermissionsList
The permissions for a private image that you own.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
List<E> names
The names of the public or private images to describe.
List<E> arns
The ARNs of the public, private, and shared images to describe.
String type
The type of image (public, private, or shared) to describe.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
Integer maxResults
The maximum size of each page of results.
String stackName
The name of the stack. This value is case-sensitive.
String fleetName
The name of the fleet. This value is case-sensitive.
String userId
The user identifier.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
Integer limit
The size of each page of results. The default value is 20 and the maximum value is 50.
String authenticationType
The authentication method. Specify API for a user authenticated using a streaming URL or
SAML for a SAML federated user. The default is to authenticate users using a streaming URL.
String authenticationType
The authentication type for the users in the user pool to describe. You must specify USERPOOL.
Integer maxResults
The maximum size of each page of results.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
String stackName
The name of the stack that is associated with the user.
String userName
The email address of the user who is associated with the stack.
Users' email addresses are case-sensitive.
String authenticationType
The authentication type for the user who is associated with the stack. You must specify USERPOOL.
Integer maxResults
The maximum size of each page of results.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
String directoryName
The fully qualified name of the directory (for example, corp.example.com).
List<E> organizationalUnitDistinguishedNames
The distinguished names of the organizational units for computer accounts.
ServiceAccountCredentials serviceAccountCredentials
The credentials for the service account used by the fleet or image builder to connect to the directory.
Date createdTime
The time the directory configuration was created.
String userName
The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
String authenticationType
The authentication type for the user. You must specify USERPOOL.
String sessionId
The identifier of the streaming session.
String arn
The Amazon Resource Name (ARN) for the fleet.
String name
The name of the fleet.
String displayName
The fleet name to display.
String description
The description to display.
String imageName
The name of the image used to create the fleet.
String imageArn
The ARN for the public, private, or shared image.
String instanceType
The instance type to use when launching fleet instances. The following instance types are available:
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.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
String fleetType
The fleet type.
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.
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.
ComputeCapacityStatus computeCapacityStatus
The capacity status for the fleet.
Integer 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.
Integer 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.
String state
The current state for the fleet.
VpcConfig vpcConfig
The VPC configuration for the fleet.
Date createdTime
The time the fleet was created.
List<E> fleetErrors
The fleet errors.
Boolean enableDefaultInternetAccess
Indicates whether default internet access is enabled for the fleet.
DomainJoinInfo domainJoinInfo
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
Integer 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.
String 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.
String name
The name of the image.
String arn
The ARN of the image.
String baseImageArn
The ARN of the image from which this image was created.
String displayName
The image name to display.
String state
The image starts in the PENDING state. If image creation succeeds, the state is
AVAILABLE. If image creation fails, the state is FAILED.
String visibility
Indicates whether the image is public or private.
Boolean imageBuilderSupported
Indicates whether an image builder can be launched from this image.
String imageBuilderName
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
String platform
The operating system platform of the image.
String description
The description to display.
ImageStateChangeReason stateChangeReason
The reason why the last state change occurred.
List<E> applications
The applications associated with the image.
Date createdTime
The time the image was created.
Date publicBaseImageReleasedDate
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
String appstreamAgentVersion
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
ImagePermissions imagePermissions
The permissions to provide to the destination AWS account for the specified image.
String name
The name of the image builder.
String arn
The ARN for the image builder.
String imageArn
The ARN of the image from which this builder was created.
String description
The description to display.
String displayName
The image builder name to display.
VpcConfig vpcConfig
The VPC configuration of the image builder.
String instanceType
The instance type for the image builder. The following instance types are available:
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.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
String platform
The operating system platform of the image builder.
String iamRoleArn
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder 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.
String state
The state of the image builder.
ImageBuilderStateChangeReason stateChangeReason
The reason why the last state change occurred.
Date createdTime
The time stamp when the image builder was created.
Boolean enableDefaultInternetAccess
Enables or disables default internet access for the image builder.
DomainJoinInfo domainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
NetworkAccessConfiguration networkAccessConfiguration
List<E> imageBuilderErrors
The image builder errors.
String appstreamAgentVersion
The version of the AppStream 2.0 agent that is currently being used by the image builder.
List<E> accessEndpoints
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
String eniPrivateIpAddress
The private IP address of the elastic network interface that is attached to instances in your VPC.
String eniId
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
String accountName
The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
String accountPassword
The password for the account.
String id
The identifier of the streaming session.
String userId
The identifier of the user for whom the session was created.
String stackName
The name of the stack for the streaming session.
String fleetName
The name of the fleet for the streaming session.
String state
The current state of the streaming session.
String connectionState
Specifies whether a user is connected to the streaming session.
Date startTime
The time when a streaming instance is dedicated for the user.
Date maxExpirationTime
The time when the streaming session is set to expire. This time is based on the
MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session
can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime,
when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the
DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming
instance is terminated and the streaming session ends.
String authenticationType
The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0
federation (SAML).
NetworkAccessConfiguration networkAccessConfiguration
The network details for the streaming session.
String sharedAccountId
The 12-digit identifier of the AWS account with which the image is shared.
ImagePermissions imagePermissions
Describes the permissions for a shared image.
String arn
The ARN of the stack.
String name
The name of the stack.
String description
The description to display.
String displayName
The stack name to display.
Date createdTime
The time the stack was created.
List<E> storageConnectors
The storage connectors to enable.
String redirectURL
The URL that users are redirected to after their streaming session ends.
String feedbackURL
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
List<E> stackErrors
The errors for the stack.
List<E> userSettings
The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
ApplicationSettingsResponse applicationSettings
The persistent application settings for users of the stack.
List<E> accessEndpoints
The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
List<E> embedHostDomains
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
String name
The name of the fleet.
ImageBuilder imageBuilder
Information about the image builder.
String name
The name of the fleet.
String name
The name of the image builder.
ImageBuilder imageBuilder
Information about the image builder.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
Map<K,V> tags
The tags to associate. 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:
_ . : / = + \ - @
String directoryName
The name of the Directory Config object.
List<E> organizationalUnitDistinguishedNames
The distinguished names of the organizational units for computer accounts.
ServiceAccountCredentials serviceAccountCredentials
The credentials for the service account used by the fleet or image builder to connect to the directory.
DirectoryConfig directoryConfig
Information about the Directory Config object.
String imageName
The name of the image used to create the fleet.
String imageArn
The ARN of the public, private, or shared image to use.
String name
A unique name for the fleet.
String instanceType
The instance type to use when launching fleet instances. The following instance types are available:
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.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
ComputeCapacity computeCapacity
The desired capacity for the fleet.
VpcConfig vpcConfig
The VPC configuration for the fleet.
Integer 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.
Integer disconnectTimeoutInSeconds
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.
Boolean deleteVpcConfig
Deletes the VPC association for the specified fleet.
String description
The description to display.
String displayName
The fleet name to display.
Boolean enableDefaultInternetAccess
Enables or disables default internet access for the fleet.
DomainJoinInfo domainJoinInfo
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
Integer 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.
List<E> attributesToDelete
The fleet attributes to delete.
String iamRoleArn
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 in the Amazon AppStream 2.0 Administration Guide.
Fleet fleet
Information about the fleet.
String name
The name of the private image.
String sharedAccountId
The 12-digit identifier of the AWS account for which you want add or update image permissions.
ImagePermissions imagePermissions
The permissions for the image.
String displayName
The stack name to display.
String description
The description to display.
String name
The name of the stack.
List<E> storageConnectors
The storage connectors to enable.
Boolean deleteStorageConnectors
Deletes the storage connectors currently enabled for the stack.
String redirectURL
The URL that users are redirected to after their streaming session ends.
String feedbackURL
The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
List<E> attributesToDelete
The stack attributes to delete.
List<E> userSettings
The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
ApplicationSettings applicationSettings
The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
List<E> accessEndpoints
The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
List<E> embedHostDomains
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
Stack stack
Information about the stack.
String s3BucketName
The Amazon S3 bucket where generated reports are stored.
If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
String schedule
The schedule for generating usage reports.
Date lastGeneratedReportDate
The time when the last usage report was generated.
List<E> subscriptionErrors
The errors that were returned if usage reports couldn't be generated.
String arn
The ARN of the user.
String userName
The email address of the user.
Users' email addresses are case-sensitive.
Boolean enabled
Specifies whether the user in the user pool is enabled.
String status
The status of the user in the user pool. The status can be one of the following:
UNCONFIRMED – The user is created but not confirmed.
CONFIRMED – The user is confirmed.
ARCHIVED – The user is no longer active.
COMPROMISED – The user is disabled because of a potential security threat.
UNKNOWN – The user status is not known.
String firstName
The first name, or given name, of the user.
String lastName
The last name, or surname, of the user.
Date createdTime
The date and time the user was created in the user pool.
String authenticationType
The authentication type for the user.
String stackName
The name of the stack that is associated with the user.
String userName
The email address of the user who is associated with the stack.
Users' email addresses are case-sensitive.
String authenticationType
The authentication type for the user.
Boolean sendEmailNotification
Specifies whether a welcome email is sent to a user after the user is created in the user pool.
UserStackAssociation userStackAssociation
Information about the user and associated stack.
String errorCode
The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
String errorMessage
The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
List<E> subnetIds
The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
List<E> securityGroupIds
The identifiers of the security groups for the fleet or image builder.
Copyright © 2019. All rights reserved.