Skip to content

Resource: awsAppstreamFleet

Provides an AppStream fleet.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.appstreamFleet.AppstreamFleet(this, "test_fleet", {
  computeCapacity: {
    desiredInstances: 1,
  },
  description: "test fleet",
  displayName: "test-fleet",
  enableDefaultInternetAccess: false,
  fleetType: "ON_DEMAND",
  idleDisconnectTimeoutInSeconds: 60,
  imageName: "Amazon-AppStream2-Sample-Image-02-04-2019",
  instanceType: "stream.standard.large",
  maxUserDurationInSeconds: 600,
  name: "test-fleet",
  tags: {
    TagName: "tag-value",
  },
  vpcConfig: {
    subnetIds: ["subnet-06e9b13400c225127"],
  },
});

Argument Reference

The following arguments are required:

  • computeCapacity - (Required) Configuration block for the desired capacity of the fleet. See below.
  • instanceType - (Required) Instance type to use when launching fleet instances.
  • name - (Required) Unique name for the fleet.

The following arguments are optional:

  • description - (Optional) Description to display.
  • disconnectTimeoutInSeconds - (Optional) Amount of time that a streaming session remains active after users disconnect.
  • displayName - (Optional) Human-readable friendly name for the AppStream fleet.
  • domainJoinInfo - (Optional) Configuration block for the name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. See below.
  • enableDefaultInternetAccess - (Optional) Enables or disables default internet access for the fleet.
  • fleetType - (Optional) Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
  • iamRoleArn - (Optional) ARN of the IAM role to apply to the fleet.
  • idleDisconnectTimeoutInSeconds - (Optional) Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnectTimeoutInSeconds time interval begins.
  • imageName - (Optional) Name of the image used to create the fleet.
  • imageArn - (Optional) ARN of the public, private, or shared image to use.
  • streamView - (Optional) 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. If not specified, defaults to app.
  • maxUserDurationInSeconds - (Optional) Maximum amount of time that a streaming session can remain active, in seconds.
  • vpcConfig - (Optional) Configuration block for the VPC configuration for the image builder. See below.
  • tags - (Optional) Map of tags to attach to AppStream instances.

computeCapacity

  • desiredInstances - (Required) Desired number of streaming instances.

domainJoinInfo

  • directoryName - (Optional) Fully qualified name of the directory (for example, corp.example.com).
  • organizationalUnitDistinguishedName - (Optional) Distinguished name of the organizational unit for computer accounts.

vpcConfig

  • securityGroupIds - Identifiers of the security groups for the fleet or image builder.
  • subnetIds - Identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - Unique identifier (ID) of the appstream fleet.
  • arn - ARN of the appstream fleet.
  • state - State of the fleet. Can be starting, running, stopping or stopped
  • createdTime - Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
  • computeCapacity - Describes the capacity status for a fleet.

computeCapacity

  • available - Number of currently available instances that can be used to stream sessions.
  • inUse - Number of instances in use for streaming.
  • running - Total number of simultaneous streaming instances that are running.

Import

awsAppstreamFleet can be imported using the id, e.g.,

$ terraform import aws_appstream_fleet.example fleetNameExample