Package software.amazon.awscdk.services.appstream

Class CfnFleet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.appstream.CfnFleet
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:38.772Z") @Stability(Stable) public class CfnFleet extends CfnResource implements IInspectable, ITaggable
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: 

 CfnFleet fleet = CfnFleet.Builder.create(this, "Fleet")
         .instanceType("stream.standard.small")
         .name("Fleet")
         .computeCapacity(ComputeCapacityProperty.builder()
                 .desiredInstances(1)
                 .build())
         .imageName("AppStream-AmazonLinux2-09-21-2022")
         .build();
 fleet.getCfnOptions().getCreationPolicy() = CfnCreationPolicy.builder()
         .startFleet(true)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFleet

      protected CfnFleet(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFleet

      protected CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFleet

      @Stability(Stable) public CfnFleet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFleetProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getInstanceType

      @Stability(Stable) @NotNull public String getInstanceType()
      The instance type to use when launching fleet instances.

      The following instance types are available for non-Elastic fleets:.

    • setInstanceType

      @Stability(Stable) public void setInstanceType(@NotNull String value)
      The instance type to use when launching fleet instances.

      The following instance types are available for non-Elastic fleets:.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A unique name for the fleet.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A unique name for the fleet.

    • getComputeCapacity

      @Stability(Stable) @Nullable public Object getComputeCapacity()
      The desired capacity for the fleet.

    • setComputeCapacity

      @Stability(Stable) public void setComputeCapacity(@Nullable IResolvable value)
      The desired capacity for the fleet.

    • setComputeCapacity

      @Stability(Stable) public void setComputeCapacity(@Nullable CfnFleet.ComputeCapacityProperty value)
      The desired capacity for the fleet.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description to display.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description to display.

    • getDisconnectTimeoutInSeconds

      @Stability(Stable) @Nullable public Number getDisconnectTimeoutInSeconds()
      The amount of time that a streaming session remains active after users disconnect.

    • setDisconnectTimeoutInSeconds

      @Stability(Stable) public void setDisconnectTimeoutInSeconds(@Nullable Number value)
      The amount of time that a streaming session remains active after users disconnect.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The fleet name to display.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The fleet name to display.

    • getDomainJoinInfo

      @Stability(Stable) @Nullable public Object getDomainJoinInfo()
      The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

    • setDomainJoinInfo

      @Stability(Stable) public void setDomainJoinInfo(@Nullable IResolvable value)
      The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

    • setDomainJoinInfo

      @Stability(Stable) public void setDomainJoinInfo(@Nullable CfnFleet.DomainJoinInfoProperty value)
      The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

    • getEnableDefaultInternetAccess

      @Stability(Stable) @Nullable public Object getEnableDefaultInternetAccess()
      Enables or disables default internet access for the fleet.

    • setEnableDefaultInternetAccess

      @Stability(Stable) public void setEnableDefaultInternetAccess(@Nullable Boolean value)
      Enables or disables default internet access for the fleet.

    • setEnableDefaultInternetAccess

      @Stability(Stable) public void setEnableDefaultInternetAccess(@Nullable IResolvable value)
      Enables or disables default internet access for the fleet.

    • getFleetType

      @Stability(Stable) @Nullable public String getFleetType()
      The fleet type.

    • setFleetType

      @Stability(Stable) public void setFleetType(@Nullable String value)
      The fleet type.

    • getIamRoleArn

      @Stability(Stable) @Nullable public String getIamRoleArn()
      The ARN of the IAM role that is applied to the fleet.

    • setIamRoleArn

      @Stability(Stable) public void setIamRoleArn(@Nullable String value)
      The ARN of the IAM role that is applied to the fleet.

    • getIdleDisconnectTimeoutInSeconds

      @Stability(Stable) @Nullable public Number getIdleDisconnectTimeoutInSeconds()
      The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins.

    • setIdleDisconnectTimeoutInSeconds

      @Stability(Stable) public void setIdleDisconnectTimeoutInSeconds(@Nullable Number 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.

    • getImageArn

      @Stability(Stable) @Nullable public String getImageArn()
      The ARN of the public, private, or shared image to use.

    • setImageArn

      @Stability(Stable) public void setImageArn(@Nullable String value)
      The ARN of the public, private, or shared image to use.

    • getImageName

      @Stability(Stable) @Nullable public String getImageName()
      The name of the image used to create the fleet.

    • setImageName

      @Stability(Stable) public void setImageName(@Nullable String value)
      The name of the image used to create the fleet.

    • getMaxConcurrentSessions

      @Stability(Stable) @Nullable public Number getMaxConcurrentSessions()
      The maximum number of concurrent sessions that can be run on an Elastic fleet.

    • setMaxConcurrentSessions

      @Stability(Stable) public void setMaxConcurrentSessions(@Nullable Number value)
      The maximum number of concurrent sessions that can be run on an Elastic fleet.

    • getMaxSessionsPerInstance

      @Stability(Stable) @Nullable public Number getMaxSessionsPerInstance()
      Max number of user sessions on an instance.

    • setMaxSessionsPerInstance

      @Stability(Stable) public void setMaxSessionsPerInstance(@Nullable Number value)
      Max number of user sessions on an instance.

    • getMaxUserDurationInSeconds

      @Stability(Stable) @Nullable public Number getMaxUserDurationInSeconds()
      The maximum amount of time that a streaming session can remain active, in seconds.

    • setMaxUserDurationInSeconds

      @Stability(Stable) public void setMaxUserDurationInSeconds(@Nullable Number value)
      The maximum amount of time that a streaming session can remain active, in seconds.

    • getPlatform

      @Stability(Stable) @Nullable public String getPlatform()
      The platform of the fleet.

    • setPlatform

      @Stability(Stable) public void setPlatform(@Nullable String value)
      The platform of the fleet.

    • getSessionScriptS3Location

      @Stability(Stable) @Nullable public Object getSessionScriptS3Location()
      The S3 location of the session scripts configuration zip file.

    • setSessionScriptS3Location

      @Stability(Stable) public void setSessionScriptS3Location(@Nullable IResolvable value)
      The S3 location of the session scripts configuration zip file.

    • setSessionScriptS3Location

      @Stability(Stable) public void setSessionScriptS3Location(@Nullable CfnFleet.S3LocationProperty value)
      The S3 location of the session scripts configuration zip file.

    • getStreamView

      @Stability(Stable) @Nullable public String getStreamView()
      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.

    • setStreamView

      @Stability(Stable) public void setStreamView(@Nullable String 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.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs.

    • getUsbDeviceFilterStrings

      @Stability(Stable) @Nullable public List<String> getUsbDeviceFilterStrings()
      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.

    • setUsbDeviceFilterStrings

      @Stability(Stable) public void setUsbDeviceFilterStrings(@Nullable List<String> 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.

    • getVpcConfig

      @Stability(Stable) @Nullable public Object getVpcConfig()
      The VPC configuration for the fleet.

    • setVpcConfig

      @Stability(Stable) public void setVpcConfig(@Nullable IResolvable value)
      The VPC configuration for the fleet.

    • setVpcConfig

      @Stability(Stable) public void setVpcConfig(@Nullable CfnFleet.VpcConfigProperty value)
      The VPC configuration for the fleet.