software.amazon.awscdk.services.appstream.CfnFleet Maven / Gradle / Ivy
Show all versions of appstream Show documentation
package software.amazon.awscdk.services.appstream;
/**
* A CloudFormation `AWS::AppStream::Fleet`.
*
* The AWS::AppStream::Fleet resource creates a fleet for Amazon AppStream 2.0. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand.
*
* Example:
*
*
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.appstream.*;
* CfnFleet cfnFleet = CfnFleet.Builder.create(this, "MyCfnFleet")
* .instanceType("instanceType")
* .name("name")
* // the properties below are optional
* .computeCapacity(ComputeCapacityProperty.builder()
* .desiredInstances(123)
* .build())
* .description("description")
* .disconnectTimeoutInSeconds(123)
* .displayName("displayName")
* .domainJoinInfo(DomainJoinInfoProperty.builder()
* .directoryName("directoryName")
* .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
* .build())
* .enableDefaultInternetAccess(false)
* .fleetType("fleetType")
* .iamRoleArn("iamRoleArn")
* .idleDisconnectTimeoutInSeconds(123)
* .imageArn("imageArn")
* .imageName("imageName")
* .maxConcurrentSessions(123)
* .maxUserDurationInSeconds(123)
* .platform("platform")
* .sessionScriptS3Location(S3LocationProperty.builder()
* .s3Bucket("s3Bucket")
* .s3Key("s3Key")
* .build())
* .streamView("streamView")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .usbDeviceFilterStrings(List.of("usbDeviceFilterStrings"))
* .vpcConfig(VpcConfigProperty.builder()
* .securityGroupIds(List.of("securityGroupIds"))
* .subnetIds(List.of("subnetIds"))
* .build())
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.73.0 (build 6faeda3)", date = "2023-01-31T18:36:45.633Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.appstream.$Module.class, fqn = "@aws-cdk/aws-appstream.CfnFleet")
public class CfnFleet extends software.amazon.awscdk.core.CfnResource implements software.amazon.awscdk.core.IInspectable {
protected CfnFleet(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected CfnFleet(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
static {
CFN_RESOURCE_TYPE_NAME = software.amazon.jsii.JsiiObject.jsiiStaticGet(software.amazon.awscdk.services.appstream.CfnFleet.class, "CFN_RESOURCE_TYPE_NAME", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Create a new `AWS::AppStream::Fleet`.
*
* @param scope - scope in which this resource is defined. This parameter is required.
* @param id - scoped id of the resource. This parameter is required.
* @param props - resource properties. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public CfnFleet(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.appstream.CfnFleetProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* Examines the CloudFormation resource and discloses attributes.
*
* @param inspector - tree inspector to collect and process attributes. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public void inspect(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.core.TreeInspector inspector) {
software.amazon.jsii.Kernel.call(this, "inspect", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(inspector, "inspector is required") });
}
/**
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
protected @org.jetbrains.annotations.NotNull java.util.Map renderProperties(final @org.jetbrains.annotations.NotNull java.util.Map props) {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.call(this, "renderProperties", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class)), new Object[] { java.util.Objects.requireNonNull(props, "props is required") }));
}
/**
* The CloudFormation resource type name for this resource class.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final static java.lang.String CFN_RESOURCE_TYPE_NAME;
/**
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
protected @org.jetbrains.annotations.NotNull java.util.Map getCfnProperties() {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.get(this, "cfnProperties", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class))));
}
/**
* An array of key-value pairs.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.core.TagManager getTags() {
return software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.core.TagManager.class));
}
/**
* The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:.
*
*
* - stream.standard.small
* - stream.standard.medium
* - stream.standard.large
* - stream.compute.large
* - stream.compute.xlarge
* - stream.compute.2xlarge
* - stream.compute.4xlarge
* - stream.compute.8xlarge
* - stream.memory.large
* - stream.memory.xlarge
* - stream.memory.2xlarge
* - stream.memory.4xlarge
* - stream.memory.8xlarge
* - stream.memory.z1d.large
* - stream.memory.z1d.xlarge
* - stream.memory.z1d.2xlarge
* - stream.memory.z1d.3xlarge
* - stream.memory.z1d.6xlarge
* - stream.memory.z1d.12xlarge
* - stream.graphics-design.large
* - stream.graphics-design.xlarge
* - stream.graphics-design.2xlarge
* - stream.graphics-design.4xlarge
* - stream.graphics-desktop.2xlarge
* - stream.graphics.g4dn.xlarge
* - stream.graphics.g4dn.2xlarge
* - stream.graphics.g4dn.4xlarge
* - stream.graphics.g4dn.8xlarge
* - stream.graphics.g4dn.12xlarge
* - stream.graphics.g4dn.16xlarge
* - stream.graphics-pro.4xlarge
* - stream.graphics-pro.8xlarge
* - stream.graphics-pro.16xlarge
*
*
* The following instance types are available for Elastic fleets:
*
*
* - stream.standard.small
* - stream.standard.medium
*
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getInstanceType() {
return software.amazon.jsii.Kernel.get(this, "instanceType", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:.
*
*
* - stream.standard.small
* - stream.standard.medium
* - stream.standard.large
* - stream.compute.large
* - stream.compute.xlarge
* - stream.compute.2xlarge
* - stream.compute.4xlarge
* - stream.compute.8xlarge
* - stream.memory.large
* - stream.memory.xlarge
* - stream.memory.2xlarge
* - stream.memory.4xlarge
* - stream.memory.8xlarge
* - stream.memory.z1d.large
* - stream.memory.z1d.xlarge
* - stream.memory.z1d.2xlarge
* - stream.memory.z1d.3xlarge
* - stream.memory.z1d.6xlarge
* - stream.memory.z1d.12xlarge
* - stream.graphics-design.large
* - stream.graphics-design.xlarge
* - stream.graphics-design.2xlarge
* - stream.graphics-design.4xlarge
* - stream.graphics-desktop.2xlarge
* - stream.graphics.g4dn.xlarge
* - stream.graphics.g4dn.2xlarge
* - stream.graphics.g4dn.4xlarge
* - stream.graphics.g4dn.8xlarge
* - stream.graphics.g4dn.12xlarge
* - stream.graphics.g4dn.16xlarge
* - stream.graphics-pro.4xlarge
* - stream.graphics-pro.8xlarge
* - stream.graphics-pro.16xlarge
*
*
* The following instance types are available for Elastic fleets:
*
*
* - stream.standard.small
* - stream.standard.medium
*
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setInstanceType(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "instanceType", java.util.Objects.requireNonNull(value, "instanceType is required"));
}
/**
* A unique name for the fleet.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getName() {
return software.amazon.jsii.Kernel.get(this, "name", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* A unique name for the fleet.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setName(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "name", java.util.Objects.requireNonNull(value, "name is required"));
}
/**
* The desired capacity for the fleet.
*
* This is not allowed for Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.Object getComputeCapacity() {
return software.amazon.jsii.Kernel.get(this, "computeCapacity", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* The desired capacity for the fleet.
*
* This is not allowed for Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setComputeCapacity(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.core.IResolvable value) {
software.amazon.jsii.Kernel.set(this, "computeCapacity", value);
}
/**
* The desired capacity for the fleet.
*
* This is not allowed for Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setComputeCapacity(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.appstream.CfnFleet.ComputeCapacityProperty value) {
software.amazon.jsii.Kernel.set(this, "computeCapacity", value);
}
/**
* The description to display.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getDescription() {
return software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The description to display.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setDescription(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "description", value);
}
/**
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.Number getDisconnectTimeoutInSeconds() {
return software.amazon.jsii.Kernel.get(this, "disconnectTimeoutInSeconds", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
/**
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setDisconnectTimeoutInSeconds(final @org.jetbrains.annotations.Nullable java.lang.Number value) {
software.amazon.jsii.Kernel.set(this, "disconnectTimeoutInSeconds", value);
}
/**
* The fleet name to display.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getDisplayName() {
return software.amazon.jsii.Kernel.get(this, "displayName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The fleet name to display.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setDisplayName(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "displayName", value);
}
/**
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*
* This is not allowed for Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.Object getDomainJoinInfo() {
return software.amazon.jsii.Kernel.get(this, "domainJoinInfo", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*
* This is not allowed for Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setDomainJoinInfo(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.core.IResolvable value) {
software.amazon.jsii.Kernel.set(this, "domainJoinInfo", value);
}
/**
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*
* This is not allowed for Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setDomainJoinInfo(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.appstream.CfnFleet.DomainJoinInfoProperty value) {
software.amazon.jsii.Kernel.set(this, "domainJoinInfo", value);
}
/**
* Enables or disables default internet access for the fleet.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.Object getEnableDefaultInternetAccess() {
return software.amazon.jsii.Kernel.get(this, "enableDefaultInternetAccess", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* Enables or disables default internet access for the fleet.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setEnableDefaultInternetAccess(final @org.jetbrains.annotations.Nullable java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "enableDefaultInternetAccess", value);
}
/**
* Enables or disables default internet access for the fleet.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setEnableDefaultInternetAccess(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.core.IResolvable value) {
software.amazon.jsii.Kernel.set(this, "enableDefaultInternetAccess", value);
}
/**
* 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.
* - ELASTIC - The pool of streaming instances is managed by Amazon AppStream 2.0. When a user selects their application or desktop to launch, they will start streaming after the app block has been downloaded and mounted to a streaming instance.
*
*
* Allowed Values : ALWAYS_ON | ELASTIC | ON_DEMAND
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getFleetType() {
return software.amazon.jsii.Kernel.get(this, "fleetType", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* 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.
* - ELASTIC - The pool of streaming instances is managed by Amazon AppStream 2.0. When a user selects their application or desktop to launch, they will start streaming after the app block has been downloaded and mounted to a streaming instance.
*
*
* Allowed Values : ALWAYS_ON | ELASTIC | ON_DEMAND
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setFleetType(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "fleetType", value);
}
/**
* 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 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 .
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getIamRoleArn() {
return software.amazon.jsii.Kernel.get(this, "iamRoleArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* 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 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 .
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setIamRoleArn(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "iamRoleArn", value);
}
/**
* 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.
*
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.Number getIdleDisconnectTimeoutInSeconds() {
return software.amazon.jsii.Kernel.get(this, "idleDisconnectTimeoutInSeconds", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
/**
* 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.
*
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setIdleDisconnectTimeoutInSeconds(final @org.jetbrains.annotations.Nullable java.lang.Number value) {
software.amazon.jsii.Kernel.set(this, "idleDisconnectTimeoutInSeconds", value);
}
/**
* The ARN of the public, private, or shared image to use.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getImageArn() {
return software.amazon.jsii.Kernel.get(this, "imageArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The ARN of the public, private, or shared image to use.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setImageArn(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "imageArn", value);
}
/**
* The name of the image used to create the fleet.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getImageName() {
return software.amazon.jsii.Kernel.get(this, "imageName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The name of the image used to create the fleet.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setImageName(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "imageName", value);
}
/**
* The maximum number of concurrent sessions that can be run on an Elastic fleet.
*
* This setting is required for Elastic fleets, but is not used for other fleet types.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.Number getMaxConcurrentSessions() {
return software.amazon.jsii.Kernel.get(this, "maxConcurrentSessions", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
/**
* The maximum number of concurrent sessions that can be run on an Elastic fleet.
*
* This setting is required for Elastic fleets, but is not used for other fleet types.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setMaxConcurrentSessions(final @org.jetbrains.annotations.Nullable java.lang.Number value) {
software.amazon.jsii.Kernel.set(this, "maxConcurrentSessions", value);
}
/**
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.Number getMaxUserDurationInSeconds() {
return software.amazon.jsii.Kernel.get(this, "maxUserDurationInSeconds", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
/**
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setMaxUserDurationInSeconds(final @org.jetbrains.annotations.Nullable java.lang.Number value) {
software.amazon.jsii.Kernel.set(this, "maxUserDurationInSeconds", value);
}
/**
* The platform of the fleet.
*
* Platform is a required setting for Elastic fleets, and is not used for other fleet types.
*
* Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getPlatform() {
return software.amazon.jsii.Kernel.get(this, "platform", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The platform of the fleet.
*
* Platform is a required setting for Elastic fleets, and is not used for other fleet types.
*
* Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setPlatform(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "platform", value);
}
/**
* The S3 location of the session scripts configuration zip file.
*
* This only applies to Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.Object getSessionScriptS3Location() {
return software.amazon.jsii.Kernel.get(this, "sessionScriptS3Location", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* The S3 location of the session scripts configuration zip file.
*
* This only applies to Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setSessionScriptS3Location(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.core.IResolvable value) {
software.amazon.jsii.Kernel.set(this, "sessionScriptS3Location", value);
}
/**
* The S3 location of the session scripts configuration zip file.
*
* This only applies to Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setSessionScriptS3Location(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.appstream.CfnFleet.S3LocationProperty value) {
software.amazon.jsii.Kernel.set(this, "sessionScriptS3Location", value);
}
/**
* 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 .
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getStreamView() {
return software.amazon.jsii.Kernel.get(this, "streamView", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* 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 .
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setStreamView(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "streamView", value);
}
/**
* The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client.
*
* This is allowed but not required for Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.util.List getUsbDeviceFilterStrings() {
return java.util.Optional.ofNullable((java.util.List)(software.amazon.jsii.Kernel.get(this, "usbDeviceFilterStrings", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class))))).map(java.util.Collections::unmodifiableList).orElse(null);
}
/**
* The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client.
*
* This is allowed but not required for Elastic fleets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setUsbDeviceFilterStrings(final @org.jetbrains.annotations.Nullable java.util.List value) {
software.amazon.jsii.Kernel.set(this, "usbDeviceFilterStrings", value);
}
/**
* The VPC configuration for the fleet.
*
* This is required for Elastic fleets, but not required for other fleet types.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.Object getVpcConfig() {
return software.amazon.jsii.Kernel.get(this, "vpcConfig", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* The VPC configuration for the fleet.
*
* This is required for Elastic fleets, but not required for other fleet types.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setVpcConfig(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.core.IResolvable value) {
software.amazon.jsii.Kernel.set(this, "vpcConfig", value);
}
/**
* The VPC configuration for the fleet.
*
* This is required for Elastic fleets, but not required for other fleet types.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setVpcConfig(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.appstream.CfnFleet.VpcConfigProperty value) {
software.amazon.jsii.Kernel.set(this, "vpcConfig", value);
}
/**
* The desired capacity for a fleet.
*
* Example:
*
*
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.appstream.*;
* ComputeCapacityProperty computeCapacityProperty = ComputeCapacityProperty.builder()
* .desiredInstances(123)
* .build();
*
*/
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.appstream.$Module.class, fqn = "@aws-cdk/aws-appstream.CfnFleet.ComputeCapacityProperty")
@software.amazon.jsii.Jsii.Proxy(ComputeCapacityProperty.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static interface ComputeCapacityProperty extends software.amazon.jsii.JsiiSerializable {
/**
* The desired number of streaming instances.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.Number getDesiredInstances();
/**
* @return a {@link Builder} of {@link ComputeCapacityProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link ComputeCapacityProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.Number desiredInstances;
/**
* Sets the value of {@link ComputeCapacityProperty#getDesiredInstances}
* @param desiredInstances The desired number of streaming instances. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder desiredInstances(java.lang.Number desiredInstances) {
this.desiredInstances = desiredInstances;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link ComputeCapacityProperty}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public ComputeCapacityProperty build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link ComputeCapacityProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ComputeCapacityProperty {
private final java.lang.Number desiredInstances;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.desiredInstances = software.amazon.jsii.Kernel.get(this, "desiredInstances", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.desiredInstances = java.util.Objects.requireNonNull(builder.desiredInstances, "desiredInstances is required");
}
@Override
public final java.lang.Number getDesiredInstances() {
return this.desiredInstances;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("desiredInstances", om.valueToTree(this.getDesiredInstances()));
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-appstream.CfnFleet.ComputeCapacityProperty"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
ComputeCapacityProperty.Jsii$Proxy that = (ComputeCapacityProperty.Jsii$Proxy) o;
return this.desiredInstances.equals(that.desiredInstances);
}
@Override
public final int hashCode() {
int result = this.desiredInstances.hashCode();
return result;
}
}
}
/**
* The name of the directory and organizational unit (OU) to use to join a fleet to a Microsoft Active Directory domain.
*
* Example:
*
*
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.appstream.*;
* DomainJoinInfoProperty domainJoinInfoProperty = DomainJoinInfoProperty.builder()
* .directoryName("directoryName")
* .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
* .build();
*
*/
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.appstream.$Module.class, fqn = "@aws-cdk/aws-appstream.CfnFleet.DomainJoinInfoProperty")
@software.amazon.jsii.Jsii.Proxy(DomainJoinInfoProperty.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static interface DomainJoinInfoProperty extends software.amazon.jsii.JsiiSerializable {
/**
* The fully qualified name of the directory (for example, corp.example.com).
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getDirectoryName() {
return null;
}
/**
* The distinguished name of the organizational unit for computer accounts.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getOrganizationalUnitDistinguishedName() {
return null;
}
/**
* @return a {@link Builder} of {@link DomainJoinInfoProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link DomainJoinInfoProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String directoryName;
java.lang.String organizationalUnitDistinguishedName;
/**
* Sets the value of {@link DomainJoinInfoProperty#getDirectoryName}
* @param directoryName The fully qualified name of the directory (for example, corp.example.com).
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder directoryName(java.lang.String directoryName) {
this.directoryName = directoryName;
return this;
}
/**
* Sets the value of {@link DomainJoinInfoProperty#getOrganizationalUnitDistinguishedName}
* @param organizationalUnitDistinguishedName The distinguished name of the organizational unit for computer accounts.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder organizationalUnitDistinguishedName(java.lang.String organizationalUnitDistinguishedName) {
this.organizationalUnitDistinguishedName = organizationalUnitDistinguishedName;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link DomainJoinInfoProperty}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public DomainJoinInfoProperty build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link DomainJoinInfoProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DomainJoinInfoProperty {
private final java.lang.String directoryName;
private final java.lang.String organizationalUnitDistinguishedName;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.directoryName = software.amazon.jsii.Kernel.get(this, "directoryName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.organizationalUnitDistinguishedName = software.amazon.jsii.Kernel.get(this, "organizationalUnitDistinguishedName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.directoryName = builder.directoryName;
this.organizationalUnitDistinguishedName = builder.organizationalUnitDistinguishedName;
}
@Override
public final java.lang.String getDirectoryName() {
return this.directoryName;
}
@Override
public final java.lang.String getOrganizationalUnitDistinguishedName() {
return this.organizationalUnitDistinguishedName;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
if (this.getDirectoryName() != null) {
data.set("directoryName", om.valueToTree(this.getDirectoryName()));
}
if (this.getOrganizationalUnitDistinguishedName() != null) {
data.set("organizationalUnitDistinguishedName", om.valueToTree(this.getOrganizationalUnitDistinguishedName()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-appstream.CfnFleet.DomainJoinInfoProperty"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
DomainJoinInfoProperty.Jsii$Proxy that = (DomainJoinInfoProperty.Jsii$Proxy) o;
if (this.directoryName != null ? !this.directoryName.equals(that.directoryName) : that.directoryName != null) return false;
return this.organizationalUnitDistinguishedName != null ? this.organizationalUnitDistinguishedName.equals(that.organizationalUnitDistinguishedName) : that.organizationalUnitDistinguishedName == null;
}
@Override
public final int hashCode() {
int result = this.directoryName != null ? this.directoryName.hashCode() : 0;
result = 31 * result + (this.organizationalUnitDistinguishedName != null ? this.organizationalUnitDistinguishedName.hashCode() : 0);
return result;
}
}
}
/**
* Describes the S3 location.
*
* Example:
*
*
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.appstream.*;
* S3LocationProperty s3LocationProperty = S3LocationProperty.builder()
* .s3Bucket("s3Bucket")
* .s3Key("s3Key")
* .build();
*
*/
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.appstream.$Module.class, fqn = "@aws-cdk/aws-appstream.CfnFleet.S3LocationProperty")
@software.amazon.jsii.Jsii.Proxy(S3LocationProperty.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static interface S3LocationProperty extends software.amazon.jsii.JsiiSerializable {
/**
* The S3 bucket of the S3 object.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getS3Bucket();
/**
* The S3 key of the S3 object.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getS3Key();
/**
* @return a {@link Builder} of {@link S3LocationProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link S3LocationProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String s3Bucket;
java.lang.String s3Key;
/**
* Sets the value of {@link S3LocationProperty#getS3Bucket}
* @param s3Bucket The S3 bucket of the S3 object. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder s3Bucket(java.lang.String s3Bucket) {
this.s3Bucket = s3Bucket;
return this;
}
/**
* Sets the value of {@link S3LocationProperty#getS3Key}
* @param s3Key The S3 key of the S3 object. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder s3Key(java.lang.String s3Key) {
this.s3Key = s3Key;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link S3LocationProperty}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public S3LocationProperty build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link S3LocationProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements S3LocationProperty {
private final java.lang.String s3Bucket;
private final java.lang.String s3Key;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.s3Bucket = software.amazon.jsii.Kernel.get(this, "s3Bucket", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.s3Key = software.amazon.jsii.Kernel.get(this, "s3Key", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.s3Bucket = java.util.Objects.requireNonNull(builder.s3Bucket, "s3Bucket is required");
this.s3Key = java.util.Objects.requireNonNull(builder.s3Key, "s3Key is required");
}
@Override
public final java.lang.String getS3Bucket() {
return this.s3Bucket;
}
@Override
public final java.lang.String getS3Key() {
return this.s3Key;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("s3Bucket", om.valueToTree(this.getS3Bucket()));
data.set("s3Key", om.valueToTree(this.getS3Key()));
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-appstream.CfnFleet.S3LocationProperty"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
S3LocationProperty.Jsii$Proxy that = (S3LocationProperty.Jsii$Proxy) o;
if (!s3Bucket.equals(that.s3Bucket)) return false;
return this.s3Key.equals(that.s3Key);
}
@Override
public final int hashCode() {
int result = this.s3Bucket.hashCode();
result = 31 * result + (this.s3Key.hashCode());
return result;
}
}
}
/**
* The VPC configuration information for the fleet.
*
* Example:
*
*
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.appstream.*;
* VpcConfigProperty vpcConfigProperty = VpcConfigProperty.builder()
* .securityGroupIds(List.of("securityGroupIds"))
* .subnetIds(List.of("subnetIds"))
* .build();
*
*/
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.appstream.$Module.class, fqn = "@aws-cdk/aws-appstream.CfnFleet.VpcConfigProperty")
@software.amazon.jsii.Jsii.Proxy(VpcConfigProperty.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static interface VpcConfigProperty extends software.amazon.jsii.JsiiSerializable {
/**
* The identifiers of the security groups for the fleet.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.util.List getSecurityGroupIds() {
return null;
}
/**
* The identifiers of the subnets to which a network interface is attached from the fleet instance.
*
* Fleet instances can use one or two subnets.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.util.List getSubnetIds() {
return null;
}
/**
* @return a {@link Builder} of {@link VpcConfigProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link VpcConfigProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.util.List securityGroupIds;
java.util.List subnetIds;
/**
* Sets the value of {@link VpcConfigProperty#getSecurityGroupIds}
* @param securityGroupIds The identifiers of the security groups for the fleet.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder securityGroupIds(java.util.List securityGroupIds) {
this.securityGroupIds = securityGroupIds;
return this;
}
/**
* Sets the value of {@link VpcConfigProperty#getSubnetIds}
* @param subnetIds The identifiers of the subnets to which a network interface is attached from the fleet instance.
* Fleet instances can use one or two subnets.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder subnetIds(java.util.List subnetIds) {
this.subnetIds = subnetIds;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link VpcConfigProperty}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public VpcConfigProperty build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link VpcConfigProperty}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements VpcConfigProperty {
private final java.util.List securityGroupIds;
private final java.util.List subnetIds;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.securityGroupIds = software.amazon.jsii.Kernel.get(this, "securityGroupIds", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
this.subnetIds = software.amazon.jsii.Kernel.get(this, "subnetIds", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.securityGroupIds = builder.securityGroupIds;
this.subnetIds = builder.subnetIds;
}
@Override
public final java.util.List getSecurityGroupIds() {
return this.securityGroupIds;
}
@Override
public final java.util.List getSubnetIds() {
return this.subnetIds;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
if (this.getSecurityGroupIds() != null) {
data.set("securityGroupIds", om.valueToTree(this.getSecurityGroupIds()));
}
if (this.getSubnetIds() != null) {
data.set("subnetIds", om.valueToTree(this.getSubnetIds()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-appstream.CfnFleet.VpcConfigProperty"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
VpcConfigProperty.Jsii$Proxy that = (VpcConfigProperty.Jsii$Proxy) o;
if (this.securityGroupIds != null ? !this.securityGroupIds.equals(that.securityGroupIds) : that.securityGroupIds != null) return false;
return this.subnetIds != null ? this.subnetIds.equals(that.subnetIds) : that.subnetIds == null;
}
@Override
public final int hashCode() {
int result = this.securityGroupIds != null ? this.securityGroupIds.hashCode() : 0;
result = 31 * result + (this.subnetIds != null ? this.subnetIds.hashCode() : 0);
return result;
}
}
}
/**
* A fluent builder for {@link software.amazon.awscdk.services.appstream.CfnFleet}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope - scope in which this resource is defined. This parameter is required.
* @param id - scoped id of the resource. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static Builder create(final software.amazon.awscdk.core.Construct scope, final java.lang.String id) {
return new Builder(scope, id);
}
private final software.amazon.awscdk.core.Construct scope;
private final java.lang.String id;
private final software.amazon.awscdk.services.appstream.CfnFleetProps.Builder props;
private Builder(final software.amazon.awscdk.core.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new software.amazon.awscdk.services.appstream.CfnFleetProps.Builder();
}
/**
* The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:.
*
*
* - stream.standard.small
* - stream.standard.medium
* - stream.standard.large
* - stream.compute.large
* - stream.compute.xlarge
* - stream.compute.2xlarge
* - stream.compute.4xlarge
* - stream.compute.8xlarge
* - stream.memory.large
* - stream.memory.xlarge
* - stream.memory.2xlarge
* - stream.memory.4xlarge
* - stream.memory.8xlarge
* - stream.memory.z1d.large
* - stream.memory.z1d.xlarge
* - stream.memory.z1d.2xlarge
* - stream.memory.z1d.3xlarge
* - stream.memory.z1d.6xlarge
* - stream.memory.z1d.12xlarge
* - stream.graphics-design.large
* - stream.graphics-design.xlarge
* - stream.graphics-design.2xlarge
* - stream.graphics-design.4xlarge
* - stream.graphics-desktop.2xlarge
* - stream.graphics.g4dn.xlarge
* - stream.graphics.g4dn.2xlarge
* - stream.graphics.g4dn.4xlarge
* - stream.graphics.g4dn.8xlarge
* - stream.graphics.g4dn.12xlarge
* - stream.graphics.g4dn.16xlarge
* - stream.graphics-pro.4xlarge
* - stream.graphics-pro.8xlarge
* - stream.graphics-pro.16xlarge
*
*
* The following instance types are available for Elastic fleets:
*
*
* - stream.standard.small
* - stream.standard.medium
*
*
* @return {@code this}
* @param instanceType The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder instanceType(final java.lang.String instanceType) {
this.props.instanceType(instanceType);
return this;
}
/**
* A unique name for the fleet.
*
* @return {@code this}
* @param name A unique name for the fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder name(final java.lang.String name) {
this.props.name(name);
return this;
}
/**
* The desired capacity for the fleet.
*
* This is not allowed for Elastic fleets.
*
* @return {@code this}
* @param computeCapacity The desired capacity for the fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder computeCapacity(final software.amazon.awscdk.core.IResolvable computeCapacity) {
this.props.computeCapacity(computeCapacity);
return this;
}
/**
* The desired capacity for the fleet.
*
* This is not allowed for Elastic fleets.
*
* @return {@code this}
* @param computeCapacity The desired capacity for the fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder computeCapacity(final software.amazon.awscdk.services.appstream.CfnFleet.ComputeCapacityProperty computeCapacity) {
this.props.computeCapacity(computeCapacity);
return this;
}
/**
* The description to display.
*
* @return {@code this}
* @param description The description to display. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder description(final java.lang.String description) {
this.props.description(description);
return this;
}
/**
* 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.
*
* @return {@code this}
* @param disconnectTimeoutInSeconds The amount of time that a streaming session remains active after users disconnect. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder disconnectTimeoutInSeconds(final java.lang.Number disconnectTimeoutInSeconds) {
this.props.disconnectTimeoutInSeconds(disconnectTimeoutInSeconds);
return this;
}
/**
* The fleet name to display.
*
* @return {@code this}
* @param displayName The fleet name to display. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder displayName(final java.lang.String displayName) {
this.props.displayName(displayName);
return this;
}
/**
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*
* This is not allowed for Elastic fleets.
*
* @return {@code this}
* @param domainJoinInfo The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder domainJoinInfo(final software.amazon.awscdk.core.IResolvable domainJoinInfo) {
this.props.domainJoinInfo(domainJoinInfo);
return this;
}
/**
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*
* This is not allowed for Elastic fleets.
*
* @return {@code this}
* @param domainJoinInfo The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder domainJoinInfo(final software.amazon.awscdk.services.appstream.CfnFleet.DomainJoinInfoProperty domainJoinInfo) {
this.props.domainJoinInfo(domainJoinInfo);
return this;
}
/**
* Enables or disables default internet access for the fleet.
*
* @return {@code this}
* @param enableDefaultInternetAccess Enables or disables default internet access for the fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder enableDefaultInternetAccess(final java.lang.Boolean enableDefaultInternetAccess) {
this.props.enableDefaultInternetAccess(enableDefaultInternetAccess);
return this;
}
/**
* Enables or disables default internet access for the fleet.
*
* @return {@code this}
* @param enableDefaultInternetAccess Enables or disables default internet access for the fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder enableDefaultInternetAccess(final software.amazon.awscdk.core.IResolvable enableDefaultInternetAccess) {
this.props.enableDefaultInternetAccess(enableDefaultInternetAccess);
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.
* - ELASTIC - The pool of streaming instances is managed by Amazon AppStream 2.0. When a user selects their application or desktop to launch, they will start streaming after the app block has been downloaded and mounted to a streaming instance.
*
*
* Allowed Values : ALWAYS_ON | ELASTIC | ON_DEMAND
*
* @return {@code this}
* @param fleetType The fleet type. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder fleetType(final java.lang.String fleetType) {
this.props.fleetType(fleetType);
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 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 {@code this}
* @param iamRoleArn The ARN of the IAM role that is applied to the fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder iamRoleArn(final java.lang.String iamRoleArn) {
this.props.iamRoleArn(iamRoleArn);
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 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.
*
* 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 {@code this}
* @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. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder idleDisconnectTimeoutInSeconds(final java.lang.Number idleDisconnectTimeoutInSeconds) {
this.props.idleDisconnectTimeoutInSeconds(idleDisconnectTimeoutInSeconds);
return this;
}
/**
* The ARN of the public, private, or shared image to use.
*
* @return {@code this}
* @param imageArn The ARN of the public, private, or shared image to use. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder imageArn(final java.lang.String imageArn) {
this.props.imageArn(imageArn);
return this;
}
/**
* The name of the image used to create the fleet.
*
* @return {@code this}
* @param imageName The name of the image used to create the fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder imageName(final java.lang.String imageName) {
this.props.imageName(imageName);
return this;
}
/**
* The maximum number of concurrent sessions that can be run on an Elastic fleet.
*
* This setting is required for Elastic fleets, but is not used for other fleet types.
*
* @return {@code this}
* @param maxConcurrentSessions The maximum number of concurrent sessions that can be run on an Elastic fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder maxConcurrentSessions(final java.lang.Number maxConcurrentSessions) {
this.props.maxConcurrentSessions(maxConcurrentSessions);
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.
*
* @return {@code this}
* @param maxUserDurationInSeconds The maximum amount of time that a streaming session can remain active, in seconds. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder maxUserDurationInSeconds(final java.lang.Number maxUserDurationInSeconds) {
this.props.maxUserDurationInSeconds(maxUserDurationInSeconds);
return this;
}
/**
* The platform of the fleet.
*
* Platform is a required setting for Elastic fleets, and is not used for other fleet types.
*
* Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2
*
* @return {@code this}
* @param platform The platform of the fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder platform(final java.lang.String platform) {
this.props.platform(platform);
return this;
}
/**
* The S3 location of the session scripts configuration zip file.
*
* This only applies to Elastic fleets.
*
* @return {@code this}
* @param sessionScriptS3Location The S3 location of the session scripts configuration zip file. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder sessionScriptS3Location(final software.amazon.awscdk.core.IResolvable sessionScriptS3Location) {
this.props.sessionScriptS3Location(sessionScriptS3Location);
return this;
}
/**
* The S3 location of the session scripts configuration zip file.
*
* This only applies to Elastic fleets.
*
* @return {@code this}
* @param sessionScriptS3Location The S3 location of the session scripts configuration zip file. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder sessionScriptS3Location(final software.amazon.awscdk.services.appstream.CfnFleet.S3LocationProperty sessionScriptS3Location) {
this.props.sessionScriptS3Location(sessionScriptS3Location);
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 .
*
* @return {@code this}
* @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. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder streamView(final java.lang.String streamView) {
this.props.streamView(streamView);
return this;
}
/**
* An array of key-value pairs.
*
* @return {@code this}
* @param tags An array of key-value pairs. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder tags(final java.util.List tags) {
this.props.tags(tags);
return this;
}
/**
* The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client.
*
* This is allowed but not required for Elastic fleets.
*
* @return {@code this}
* @param usbDeviceFilterStrings The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder usbDeviceFilterStrings(final java.util.List usbDeviceFilterStrings) {
this.props.usbDeviceFilterStrings(usbDeviceFilterStrings);
return this;
}
/**
* The VPC configuration for the fleet.
*
* This is required for Elastic fleets, but not required for other fleet types.
*
* @return {@code this}
* @param vpcConfig The VPC configuration for the fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder vpcConfig(final software.amazon.awscdk.core.IResolvable vpcConfig) {
this.props.vpcConfig(vpcConfig);
return this;
}
/**
* The VPC configuration for the fleet.
*
* This is required for Elastic fleets, but not required for other fleet types.
*
* @return {@code this}
* @param vpcConfig The VPC configuration for the fleet. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder vpcConfig(final software.amazon.awscdk.services.appstream.CfnFleet.VpcConfigProperty vpcConfig) {
this.props.vpcConfig(vpcConfig);
return this;
}
/**
* @returns a newly built instance of {@link software.amazon.awscdk.services.appstream.CfnFleet}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public software.amazon.awscdk.services.appstream.CfnFleet build() {
return new software.amazon.awscdk.services.appstream.CfnFleet(
this.scope,
this.id,
this.props.build()
);
}
}
}