com.amazonaws.services.appstream.model.Fleet Maven / Gradle / Ivy
Show all versions of aws-java-sdk-appstream Show documentation
/*
* Copyright 2019-2024 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.
*/
package com.amazonaws.services.appstream.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes a fleet.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Fleet implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) for the fleet.
*
*/
private String arn;
/**
*
* The name of the fleet.
*
*/
private String name;
/**
*
* The fleet name to display.
*
*/
private String displayName;
/**
*
* The description to display.
*
*/
private String description;
/**
*
* The name of the image used to create the fleet.
*
*/
private String imageName;
/**
*
* The ARN for the public, private, or shared image.
*
*/
private String imageArn;
/**
*
* 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
*
*
*
*/
private String instanceType;
/**
*
* 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.
*
*
*
*/
private String fleetType;
/**
*
* The capacity status for the fleet.
*
*/
private ComputeCapacityStatus computeCapacityStatus;
/**
*
* 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.
*
*/
private Integer maxUserDurationInSeconds;
/**
*
* 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 36000.
*
*/
private Integer disconnectTimeoutInSeconds;
/**
*
* The current state for the fleet.
*
*/
private String state;
/**
*
* The VPC configuration for the fleet.
*
*/
private VpcConfig vpcConfig;
/**
*
* The time the fleet was created.
*
*/
private java.util.Date createdTime;
/**
*
* The fleet errors.
*
*/
private java.util.List fleetErrors;
/**
*
* Indicates whether default internet access is enabled for the fleet.
*
*/
private Boolean enableDefaultInternetAccess;
/**
*
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory
* domain.
*
*/
private DomainJoinInfo domainJoinInfo;
/**
*
* 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 36000. 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.
*
*
*/
private Integer idleDisconnectTimeoutInSeconds;
/**
*
* 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.
*
*/
private String iamRoleArn;
/**
*
* 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.
*
*/
private String streamView;
/**
*
* The platform of the fleet.
*
*/
private String platform;
/**
*
* The maximum number of concurrent sessions for the fleet.
*
*/
private Integer maxConcurrentSessions;
/**
*
* The USB device filter strings associated with the fleet.
*
*/
private java.util.List usbDeviceFilterStrings;
/**
*
* The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*
*/
private S3Location sessionScriptS3Location;
/**
*
* The maximum number of user sessions on an instance. This only applies to multi-session fleets.
*
*/
private Integer maxSessionsPerInstance;
/**
*
* The Amazon Resource Name (ARN) for the fleet.
*
*
* @param arn
* The Amazon Resource Name (ARN) for the fleet.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) for the fleet.
*
*
* @return The Amazon Resource Name (ARN) for the fleet.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) for the fleet.
*
*
* @param arn
* The Amazon Resource Name (ARN) for the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The name of the fleet.
*
*
* @param name
* The name of the fleet.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the fleet.
*
*
* @return The name of the fleet.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the fleet.
*
*
* @param name
* The name of the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withName(String name) {
setName(name);
return this;
}
/**
*
* The fleet name to display.
*
*
* @param displayName
* The fleet name to display.
*/
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
*
* The fleet name to display.
*
*
* @return The fleet name to display.
*/
public String getDisplayName() {
return this.displayName;
}
/**
*
* The fleet name to display.
*
*
* @param displayName
* The fleet name to display.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withDisplayName(String displayName) {
setDisplayName(displayName);
return this;
}
/**
*
* The description to display.
*
*
* @param description
* The description to display.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description to display.
*
*
* @return The description to display.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description to display.
*
*
* @param description
* The description to display.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The name of the image used to create the fleet.
*
*
* @param imageName
* The name of the image used to create the fleet.
*/
public void setImageName(String imageName) {
this.imageName = imageName;
}
/**
*
* The name of the image used to create the fleet.
*
*
* @return The name of the image used to create the fleet.
*/
public String getImageName() {
return this.imageName;
}
/**
*
* The name of the image used to create the fleet.
*
*
* @param imageName
* The name of the image used to create the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withImageName(String imageName) {
setImageName(imageName);
return this;
}
/**
*
* The ARN for the public, private, or shared image.
*
*
* @param imageArn
* The ARN for the public, private, or shared image.
*/
public void setImageArn(String imageArn) {
this.imageArn = imageArn;
}
/**
*
* The ARN for the public, private, or shared image.
*
*
* @return The ARN for the public, private, or shared image.
*/
public String getImageArn() {
return this.imageArn;
}
/**
*
* The ARN for the public, private, or shared image.
*
*
* @param imageArn
* The ARN for the public, private, or shared image.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withImageArn(String imageArn) {
setImageArn(imageArn);
return this;
}
/**
*
* 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
*
*
*
*
* @param 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
*
*
*/
public void setInstanceType(String instanceType) {
this.instanceType = 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
*
*
*
*
* @return 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
*
*
*/
public String getInstanceType() {
return this.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
*
*
*
*
* @param 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
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withInstanceType(String instanceType) {
setInstanceType(instanceType);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see FleetType
*/
public void setFleetType(String fleetType) {
this.fleetType = 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.
*
*
*
*
* @return 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.
*
*
* @see FleetType
*/
public String getFleetType() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see FleetType
*/
public Fleet withFleetType(String fleetType) {
setFleetType(fleetType);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see FleetType
*/
public void setFleetType(FleetType fleetType) {
withFleetType(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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see FleetType
*/
public Fleet withFleetType(FleetType fleetType) {
this.fleetType = fleetType.toString();
return this;
}
/**
*
* The capacity status for the fleet.
*
*
* @param computeCapacityStatus
* The capacity status for the fleet.
*/
public void setComputeCapacityStatus(ComputeCapacityStatus computeCapacityStatus) {
this.computeCapacityStatus = computeCapacityStatus;
}
/**
*
* The capacity status for the fleet.
*
*
* @return The capacity status for the fleet.
*/
public ComputeCapacityStatus getComputeCapacityStatus() {
return this.computeCapacityStatus;
}
/**
*
* The capacity status for the fleet.
*
*
* @param computeCapacityStatus
* The capacity status for the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withComputeCapacityStatus(ComputeCapacityStatus computeCapacityStatus) {
setComputeCapacityStatus(computeCapacityStatus);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setMaxUserDurationInSeconds(Integer maxUserDurationInSeconds) {
this.maxUserDurationInSeconds = 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.
*
*
* @return 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 Integer getMaxUserDurationInSeconds() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withMaxUserDurationInSeconds(Integer maxUserDurationInSeconds) {
setMaxUserDurationInSeconds(maxUserDurationInSeconds);
return this;
}
/**
*
* 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 36000.
*
*
* @param 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 36000.
*/
public void setDisconnectTimeoutInSeconds(Integer disconnectTimeoutInSeconds) {
this.disconnectTimeoutInSeconds = 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 36000.
*
*
* @return 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 36000.
*/
public Integer getDisconnectTimeoutInSeconds() {
return this.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 36000.
*
*
* @param 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 36000.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withDisconnectTimeoutInSeconds(Integer disconnectTimeoutInSeconds) {
setDisconnectTimeoutInSeconds(disconnectTimeoutInSeconds);
return this;
}
/**
*
* The current state for the fleet.
*
*
* @param state
* The current state for the fleet.
* @see FleetState
*/
public void setState(String state) {
this.state = state;
}
/**
*
* The current state for the fleet.
*
*
* @return The current state for the fleet.
* @see FleetState
*/
public String getState() {
return this.state;
}
/**
*
* The current state for the fleet.
*
*
* @param state
* The current state for the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FleetState
*/
public Fleet withState(String state) {
setState(state);
return this;
}
/**
*
* The current state for the fleet.
*
*
* @param state
* The current state for the fleet.
* @see FleetState
*/
public void setState(FleetState state) {
withState(state);
}
/**
*
* The current state for the fleet.
*
*
* @param state
* The current state for the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FleetState
*/
public Fleet withState(FleetState state) {
this.state = state.toString();
return this;
}
/**
*
* The VPC configuration for the fleet.
*
*
* @param vpcConfig
* The VPC configuration for the fleet.
*/
public void setVpcConfig(VpcConfig vpcConfig) {
this.vpcConfig = vpcConfig;
}
/**
*
* The VPC configuration for the fleet.
*
*
* @return The VPC configuration for the fleet.
*/
public VpcConfig getVpcConfig() {
return this.vpcConfig;
}
/**
*
* The VPC configuration for the fleet.
*
*
* @param vpcConfig
* The VPC configuration for the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withVpcConfig(VpcConfig vpcConfig) {
setVpcConfig(vpcConfig);
return this;
}
/**
*
* The time the fleet was created.
*
*
* @param createdTime
* The time the fleet was created.
*/
public void setCreatedTime(java.util.Date createdTime) {
this.createdTime = createdTime;
}
/**
*
* The time the fleet was created.
*
*
* @return The time the fleet was created.
*/
public java.util.Date getCreatedTime() {
return this.createdTime;
}
/**
*
* The time the fleet was created.
*
*
* @param createdTime
* The time the fleet was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withCreatedTime(java.util.Date createdTime) {
setCreatedTime(createdTime);
return this;
}
/**
*
* The fleet errors.
*
*
* @return The fleet errors.
*/
public java.util.List getFleetErrors() {
return fleetErrors;
}
/**
*
* The fleet errors.
*
*
* @param fleetErrors
* The fleet errors.
*/
public void setFleetErrors(java.util.Collection fleetErrors) {
if (fleetErrors == null) {
this.fleetErrors = null;
return;
}
this.fleetErrors = new java.util.ArrayList(fleetErrors);
}
/**
*
* The fleet errors.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFleetErrors(java.util.Collection)} or {@link #withFleetErrors(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param fleetErrors
* The fleet errors.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withFleetErrors(FleetError... fleetErrors) {
if (this.fleetErrors == null) {
setFleetErrors(new java.util.ArrayList(fleetErrors.length));
}
for (FleetError ele : fleetErrors) {
this.fleetErrors.add(ele);
}
return this;
}
/**
*
* The fleet errors.
*
*
* @param fleetErrors
* The fleet errors.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withFleetErrors(java.util.Collection fleetErrors) {
setFleetErrors(fleetErrors);
return this;
}
/**
*
* Indicates whether default internet access is enabled for the fleet.
*
*
* @param enableDefaultInternetAccess
* Indicates whether default internet access is enabled for the fleet.
*/
public void setEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess) {
this.enableDefaultInternetAccess = enableDefaultInternetAccess;
}
/**
*
* Indicates whether default internet access is enabled for the fleet.
*
*
* @return Indicates whether default internet access is enabled for the fleet.
*/
public Boolean getEnableDefaultInternetAccess() {
return this.enableDefaultInternetAccess;
}
/**
*
* Indicates whether default internet access is enabled for the fleet.
*
*
* @param enableDefaultInternetAccess
* Indicates whether default internet access is enabled for the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess) {
setEnableDefaultInternetAccess(enableDefaultInternetAccess);
return this;
}
/**
*
* Indicates whether default internet access is enabled for the fleet.
*
*
* @return Indicates whether default internet access is enabled for the fleet.
*/
public Boolean isEnableDefaultInternetAccess() {
return this.enableDefaultInternetAccess;
}
/**
*
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory
* domain.
*
*
* @param domainJoinInfo
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active
* Directory domain.
*/
public void setDomainJoinInfo(DomainJoinInfo domainJoinInfo) {
this.domainJoinInfo = domainJoinInfo;
}
/**
*
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory
* domain.
*
*
* @return The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active
* Directory domain.
*/
public DomainJoinInfo getDomainJoinInfo() {
return this.domainJoinInfo;
}
/**
*
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory
* domain.
*
*
* @param domainJoinInfo
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active
* Directory domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withDomainJoinInfo(DomainJoinInfo domainJoinInfo) {
setDomainJoinInfo(domainJoinInfo);
return this;
}
/**
*
* 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 36000. 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.
*
*
*
* @param 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 36000. 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 void setIdleDisconnectTimeoutInSeconds(Integer idleDisconnectTimeoutInSeconds) {
this.idleDisconnectTimeoutInSeconds = 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 36000. 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.
*
*
*
* @return 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 36000. 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 Integer getIdleDisconnectTimeoutInSeconds() {
return this.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 36000. 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.
*
*
*
* @param 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 36000. 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withIdleDisconnectTimeoutInSeconds(Integer idleDisconnectTimeoutInSeconds) {
setIdleDisconnectTimeoutInSeconds(idleDisconnectTimeoutInSeconds);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setIamRoleArn(String iamRoleArn) {
this.iamRoleArn = 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.
*
*
* @return 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 getIamRoleArn() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withIamRoleArn(String iamRoleArn) {
setIamRoleArn(iamRoleArn);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see StreamView
*/
public void setStreamView(String streamView) {
this.streamView = 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.
*
*
* @return 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.
* @see StreamView
*/
public String getStreamView() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamView
*/
public Fleet withStreamView(String streamView) {
setStreamView(streamView);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see StreamView
*/
public void setStreamView(StreamView streamView) {
withStreamView(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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamView
*/
public Fleet withStreamView(StreamView streamView) {
this.streamView = streamView.toString();
return this;
}
/**
*
* The platform of the fleet.
*
*
* @param platform
* The platform of the fleet.
* @see PlatformType
*/
public void setPlatform(String platform) {
this.platform = platform;
}
/**
*
* The platform of the fleet.
*
*
* @return The platform of the fleet.
* @see PlatformType
*/
public String getPlatform() {
return this.platform;
}
/**
*
* The platform of the fleet.
*
*
* @param platform
* The platform of the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PlatformType
*/
public Fleet withPlatform(String platform) {
setPlatform(platform);
return this;
}
/**
*
* The platform of the fleet.
*
*
* @param platform
* The platform of the fleet.
* @see PlatformType
*/
public void setPlatform(PlatformType platform) {
withPlatform(platform);
}
/**
*
* The platform of the fleet.
*
*
* @param platform
* The platform of the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PlatformType
*/
public Fleet withPlatform(PlatformType platform) {
this.platform = platform.toString();
return this;
}
/**
*
* The maximum number of concurrent sessions for the fleet.
*
*
* @param maxConcurrentSessions
* The maximum number of concurrent sessions for the fleet.
*/
public void setMaxConcurrentSessions(Integer maxConcurrentSessions) {
this.maxConcurrentSessions = maxConcurrentSessions;
}
/**
*
* The maximum number of concurrent sessions for the fleet.
*
*
* @return The maximum number of concurrent sessions for the fleet.
*/
public Integer getMaxConcurrentSessions() {
return this.maxConcurrentSessions;
}
/**
*
* The maximum number of concurrent sessions for the fleet.
*
*
* @param maxConcurrentSessions
* The maximum number of concurrent sessions for the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withMaxConcurrentSessions(Integer maxConcurrentSessions) {
setMaxConcurrentSessions(maxConcurrentSessions);
return this;
}
/**
*
* The USB device filter strings associated with the fleet.
*
*
* @return The USB device filter strings associated with the fleet.
*/
public java.util.List getUsbDeviceFilterStrings() {
return usbDeviceFilterStrings;
}
/**
*
* The USB device filter strings associated with the fleet.
*
*
* @param usbDeviceFilterStrings
* The USB device filter strings associated with the fleet.
*/
public void setUsbDeviceFilterStrings(java.util.Collection usbDeviceFilterStrings) {
if (usbDeviceFilterStrings == null) {
this.usbDeviceFilterStrings = null;
return;
}
this.usbDeviceFilterStrings = new java.util.ArrayList(usbDeviceFilterStrings);
}
/**
*
* The USB device filter strings associated with the fleet.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setUsbDeviceFilterStrings(java.util.Collection)} or
* {@link #withUsbDeviceFilterStrings(java.util.Collection)} if you want to override the existing values.
*
*
* @param usbDeviceFilterStrings
* The USB device filter strings associated with the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withUsbDeviceFilterStrings(String... usbDeviceFilterStrings) {
if (this.usbDeviceFilterStrings == null) {
setUsbDeviceFilterStrings(new java.util.ArrayList(usbDeviceFilterStrings.length));
}
for (String ele : usbDeviceFilterStrings) {
this.usbDeviceFilterStrings.add(ele);
}
return this;
}
/**
*
* The USB device filter strings associated with the fleet.
*
*
* @param usbDeviceFilterStrings
* The USB device filter strings associated with the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withUsbDeviceFilterStrings(java.util.Collection usbDeviceFilterStrings) {
setUsbDeviceFilterStrings(usbDeviceFilterStrings);
return this;
}
/**
*
* The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*
*
* @param sessionScriptS3Location
* The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*/
public void setSessionScriptS3Location(S3Location sessionScriptS3Location) {
this.sessionScriptS3Location = sessionScriptS3Location;
}
/**
*
* The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*
*
* @return The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*/
public S3Location getSessionScriptS3Location() {
return this.sessionScriptS3Location;
}
/**
*
* The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
*
*
* @param sessionScriptS3Location
* The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withSessionScriptS3Location(S3Location sessionScriptS3Location) {
setSessionScriptS3Location(sessionScriptS3Location);
return this;
}
/**
*
* The maximum number of user sessions on an instance. This only applies to multi-session fleets.
*
*
* @param maxSessionsPerInstance
* The maximum number of user sessions on an instance. This only applies to multi-session fleets.
*/
public void setMaxSessionsPerInstance(Integer maxSessionsPerInstance) {
this.maxSessionsPerInstance = maxSessionsPerInstance;
}
/**
*
* The maximum number of user sessions on an instance. This only applies to multi-session fleets.
*
*
* @return The maximum number of user sessions on an instance. This only applies to multi-session fleets.
*/
public Integer getMaxSessionsPerInstance() {
return this.maxSessionsPerInstance;
}
/**
*
* The maximum number of user sessions on an instance. This only applies to multi-session fleets.
*
*
* @param maxSessionsPerInstance
* The maximum number of user sessions on an instance. This only applies to multi-session fleets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Fleet withMaxSessionsPerInstance(Integer maxSessionsPerInstance) {
setMaxSessionsPerInstance(maxSessionsPerInstance);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDisplayName() != null)
sb.append("DisplayName: ").append(getDisplayName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getImageName() != null)
sb.append("ImageName: ").append(getImageName()).append(",");
if (getImageArn() != null)
sb.append("ImageArn: ").append(getImageArn()).append(",");
if (getInstanceType() != null)
sb.append("InstanceType: ").append(getInstanceType()).append(",");
if (getFleetType() != null)
sb.append("FleetType: ").append(getFleetType()).append(",");
if (getComputeCapacityStatus() != null)
sb.append("ComputeCapacityStatus: ").append(getComputeCapacityStatus()).append(",");
if (getMaxUserDurationInSeconds() != null)
sb.append("MaxUserDurationInSeconds: ").append(getMaxUserDurationInSeconds()).append(",");
if (getDisconnectTimeoutInSeconds() != null)
sb.append("DisconnectTimeoutInSeconds: ").append(getDisconnectTimeoutInSeconds()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getVpcConfig() != null)
sb.append("VpcConfig: ").append(getVpcConfig()).append(",");
if (getCreatedTime() != null)
sb.append("CreatedTime: ").append(getCreatedTime()).append(",");
if (getFleetErrors() != null)
sb.append("FleetErrors: ").append(getFleetErrors()).append(",");
if (getEnableDefaultInternetAccess() != null)
sb.append("EnableDefaultInternetAccess: ").append(getEnableDefaultInternetAccess()).append(",");
if (getDomainJoinInfo() != null)
sb.append("DomainJoinInfo: ").append(getDomainJoinInfo()).append(",");
if (getIdleDisconnectTimeoutInSeconds() != null)
sb.append("IdleDisconnectTimeoutInSeconds: ").append(getIdleDisconnectTimeoutInSeconds()).append(",");
if (getIamRoleArn() != null)
sb.append("IamRoleArn: ").append(getIamRoleArn()).append(",");
if (getStreamView() != null)
sb.append("StreamView: ").append(getStreamView()).append(",");
if (getPlatform() != null)
sb.append("Platform: ").append(getPlatform()).append(",");
if (getMaxConcurrentSessions() != null)
sb.append("MaxConcurrentSessions: ").append(getMaxConcurrentSessions()).append(",");
if (getUsbDeviceFilterStrings() != null)
sb.append("UsbDeviceFilterStrings: ").append(getUsbDeviceFilterStrings()).append(",");
if (getSessionScriptS3Location() != null)
sb.append("SessionScriptS3Location: ").append(getSessionScriptS3Location()).append(",");
if (getMaxSessionsPerInstance() != null)
sb.append("MaxSessionsPerInstance: ").append(getMaxSessionsPerInstance());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Fleet == false)
return false;
Fleet other = (Fleet) obj;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDisplayName() == null ^ this.getDisplayName() == null)
return false;
if (other.getDisplayName() != null && other.getDisplayName().equals(this.getDisplayName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getImageName() == null ^ this.getImageName() == null)
return false;
if (other.getImageName() != null && other.getImageName().equals(this.getImageName()) == false)
return false;
if (other.getImageArn() == null ^ this.getImageArn() == null)
return false;
if (other.getImageArn() != null && other.getImageArn().equals(this.getImageArn()) == false)
return false;
if (other.getInstanceType() == null ^ this.getInstanceType() == null)
return false;
if (other.getInstanceType() != null && other.getInstanceType().equals(this.getInstanceType()) == false)
return false;
if (other.getFleetType() == null ^ this.getFleetType() == null)
return false;
if (other.getFleetType() != null && other.getFleetType().equals(this.getFleetType()) == false)
return false;
if (other.getComputeCapacityStatus() == null ^ this.getComputeCapacityStatus() == null)
return false;
if (other.getComputeCapacityStatus() != null && other.getComputeCapacityStatus().equals(this.getComputeCapacityStatus()) == false)
return false;
if (other.getMaxUserDurationInSeconds() == null ^ this.getMaxUserDurationInSeconds() == null)
return false;
if (other.getMaxUserDurationInSeconds() != null && other.getMaxUserDurationInSeconds().equals(this.getMaxUserDurationInSeconds()) == false)
return false;
if (other.getDisconnectTimeoutInSeconds() == null ^ this.getDisconnectTimeoutInSeconds() == null)
return false;
if (other.getDisconnectTimeoutInSeconds() != null && other.getDisconnectTimeoutInSeconds().equals(this.getDisconnectTimeoutInSeconds()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getVpcConfig() == null ^ this.getVpcConfig() == null)
return false;
if (other.getVpcConfig() != null && other.getVpcConfig().equals(this.getVpcConfig()) == false)
return false;
if (other.getCreatedTime() == null ^ this.getCreatedTime() == null)
return false;
if (other.getCreatedTime() != null && other.getCreatedTime().equals(this.getCreatedTime()) == false)
return false;
if (other.getFleetErrors() == null ^ this.getFleetErrors() == null)
return false;
if (other.getFleetErrors() != null && other.getFleetErrors().equals(this.getFleetErrors()) == false)
return false;
if (other.getEnableDefaultInternetAccess() == null ^ this.getEnableDefaultInternetAccess() == null)
return false;
if (other.getEnableDefaultInternetAccess() != null && other.getEnableDefaultInternetAccess().equals(this.getEnableDefaultInternetAccess()) == false)
return false;
if (other.getDomainJoinInfo() == null ^ this.getDomainJoinInfo() == null)
return false;
if (other.getDomainJoinInfo() != null && other.getDomainJoinInfo().equals(this.getDomainJoinInfo()) == false)
return false;
if (other.getIdleDisconnectTimeoutInSeconds() == null ^ this.getIdleDisconnectTimeoutInSeconds() == null)
return false;
if (other.getIdleDisconnectTimeoutInSeconds() != null
&& other.getIdleDisconnectTimeoutInSeconds().equals(this.getIdleDisconnectTimeoutInSeconds()) == false)
return false;
if (other.getIamRoleArn() == null ^ this.getIamRoleArn() == null)
return false;
if (other.getIamRoleArn() != null && other.getIamRoleArn().equals(this.getIamRoleArn()) == false)
return false;
if (other.getStreamView() == null ^ this.getStreamView() == null)
return false;
if (other.getStreamView() != null && other.getStreamView().equals(this.getStreamView()) == false)
return false;
if (other.getPlatform() == null ^ this.getPlatform() == null)
return false;
if (other.getPlatform() != null && other.getPlatform().equals(this.getPlatform()) == false)
return false;
if (other.getMaxConcurrentSessions() == null ^ this.getMaxConcurrentSessions() == null)
return false;
if (other.getMaxConcurrentSessions() != null && other.getMaxConcurrentSessions().equals(this.getMaxConcurrentSessions()) == false)
return false;
if (other.getUsbDeviceFilterStrings() == null ^ this.getUsbDeviceFilterStrings() == null)
return false;
if (other.getUsbDeviceFilterStrings() != null && other.getUsbDeviceFilterStrings().equals(this.getUsbDeviceFilterStrings()) == false)
return false;
if (other.getSessionScriptS3Location() == null ^ this.getSessionScriptS3Location() == null)
return false;
if (other.getSessionScriptS3Location() != null && other.getSessionScriptS3Location().equals(this.getSessionScriptS3Location()) == false)
return false;
if (other.getMaxSessionsPerInstance() == null ^ this.getMaxSessionsPerInstance() == null)
return false;
if (other.getMaxSessionsPerInstance() != null && other.getMaxSessionsPerInstance().equals(this.getMaxSessionsPerInstance()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDisplayName() == null) ? 0 : getDisplayName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getImageName() == null) ? 0 : getImageName().hashCode());
hashCode = prime * hashCode + ((getImageArn() == null) ? 0 : getImageArn().hashCode());
hashCode = prime * hashCode + ((getInstanceType() == null) ? 0 : getInstanceType().hashCode());
hashCode = prime * hashCode + ((getFleetType() == null) ? 0 : getFleetType().hashCode());
hashCode = prime * hashCode + ((getComputeCapacityStatus() == null) ? 0 : getComputeCapacityStatus().hashCode());
hashCode = prime * hashCode + ((getMaxUserDurationInSeconds() == null) ? 0 : getMaxUserDurationInSeconds().hashCode());
hashCode = prime * hashCode + ((getDisconnectTimeoutInSeconds() == null) ? 0 : getDisconnectTimeoutInSeconds().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getVpcConfig() == null) ? 0 : getVpcConfig().hashCode());
hashCode = prime * hashCode + ((getCreatedTime() == null) ? 0 : getCreatedTime().hashCode());
hashCode = prime * hashCode + ((getFleetErrors() == null) ? 0 : getFleetErrors().hashCode());
hashCode = prime * hashCode + ((getEnableDefaultInternetAccess() == null) ? 0 : getEnableDefaultInternetAccess().hashCode());
hashCode = prime * hashCode + ((getDomainJoinInfo() == null) ? 0 : getDomainJoinInfo().hashCode());
hashCode = prime * hashCode + ((getIdleDisconnectTimeoutInSeconds() == null) ? 0 : getIdleDisconnectTimeoutInSeconds().hashCode());
hashCode = prime * hashCode + ((getIamRoleArn() == null) ? 0 : getIamRoleArn().hashCode());
hashCode = prime * hashCode + ((getStreamView() == null) ? 0 : getStreamView().hashCode());
hashCode = prime * hashCode + ((getPlatform() == null) ? 0 : getPlatform().hashCode());
hashCode = prime * hashCode + ((getMaxConcurrentSessions() == null) ? 0 : getMaxConcurrentSessions().hashCode());
hashCode = prime * hashCode + ((getUsbDeviceFilterStrings() == null) ? 0 : getUsbDeviceFilterStrings().hashCode());
hashCode = prime * hashCode + ((getSessionScriptS3Location() == null) ? 0 : getSessionScriptS3Location().hashCode());
hashCode = prime * hashCode + ((getMaxSessionsPerInstance() == null) ? 0 : getMaxSessionsPerInstance().hashCode());
return hashCode;
}
@Override
public Fleet clone() {
try {
return (Fleet) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.appstream.model.transform.FleetMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}