Fleet class

Provides an AppStream fleet.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testFleet = new aws.appstream.Fleet("test_fleet", {
    computeCapacity: {
        desiredInstances: 1,
    },
    vpcConfig: {
        subnetIds: ["subnet-06e9b13400c225127"],
    },
    name: "test-fleet",
    description: "test fleet",
    idleDisconnectTimeoutInSeconds: 60,
    displayName: "test-fleet",
    enableDefaultInternetAccess: false,
    fleetType: "ON_DEMAND",
    imageName: "Amazon-AppStream2-Sample-Image-03-11-2023",
    instanceType: "stream.standard.large",
    maxUserDurationInSeconds: 600,
    tags: {
        TagName: "tag-value",
    },
});
import pulumi
import pulumi_aws as aws

test_fleet = aws.appstream.Fleet("test_fleet",
    compute_capacity={
        "desired_instances": 1,
    },
    vpc_config={
        "subnet_ids": ["subnet-06e9b13400c225127"],
    },
    name="test-fleet",
    description="test fleet",
    idle_disconnect_timeout_in_seconds=60,
    display_name="test-fleet",
    enable_default_internet_access=False,
    fleet_type="ON_DEMAND",
    image_name="Amazon-AppStream2-Sample-Image-03-11-2023",
    instance_type="stream.standard.large",
    max_user_duration_in_seconds=600,
    tags={
        "TagName": "tag-value",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var testFleet = new Aws.AppStream.Fleet("test_fleet", new()
    {
        ComputeCapacity = new Aws.AppStream.Inputs.FleetComputeCapacityArgs
        {
            DesiredInstances = 1,
        },
        VpcConfig = new Aws.AppStream.Inputs.FleetVpcConfigArgs
        {
            SubnetIds = new[]
            {
                "subnet-06e9b13400c225127",
            },
        },
        Name = "test-fleet",
        Description = "test fleet",
        IdleDisconnectTimeoutInSeconds = 60,
        DisplayName = "test-fleet",
        EnableDefaultInternetAccess = false,
        FleetType = "ON_DEMAND",
        ImageName = "Amazon-AppStream2-Sample-Image-03-11-2023",
        InstanceType = "stream.standard.large",
        MaxUserDurationInSeconds = 600,
        Tags =
        {
            { "TagName", "tag-value" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/appstream"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appstream.NewFleet(ctx, "test_fleet", &appstream.FleetArgs{
			ComputeCapacity: &appstream.FleetComputeCapacityArgs{
				DesiredInstances: pulumi.Int(1),
			},
			VpcConfig: &appstream.FleetVpcConfigArgs{
				SubnetIds: pulumi.StringArray{
					pulumi.String("subnet-06e9b13400c225127"),
				},
			},
			Name:                           pulumi.String("test-fleet"),
			Description:                    pulumi.String("test fleet"),
			IdleDisconnectTimeoutInSeconds: pulumi.Int(60),
			DisplayName:                    pulumi.String("test-fleet"),
			EnableDefaultInternetAccess:    pulumi.Bool(false),
			FleetType:                      pulumi.String("ON_DEMAND"),
			ImageName:                      pulumi.String("Amazon-AppStream2-Sample-Image-03-11-2023"),
			InstanceType:                   pulumi.String("stream.standard.large"),
			MaxUserDurationInSeconds:       pulumi.Int(600),
			Tags: pulumi.StringMap{
				"TagName": pulumi.String("tag-value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_appstream_fleet" "test_fleet" {
  compute_capacity = {
    desired_instances = 1
  }
  vpc_config = {
    subnet_ids = ["subnet-06e9b13400c225127"]
  }
  name                               = "test-fleet"
  description                        = "test fleet"
  idle_disconnect_timeout_in_seconds = 60
  display_name                       = "test-fleet"
  enable_default_internet_access     = false
  fleet_type                         = "ON_DEMAND"
  image_name                         = "Amazon-AppStream2-Sample-Image-03-11-2023"
  instance_type                      = "stream.standard.large"
  max_user_duration_in_seconds       = 600
  tags = {
    "TagName" = "tag-value"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appstream.Fleet;
import com.pulumi.aws.appstream.FleetArgs;
import com.pulumi.aws.appstream.inputs.FleetComputeCapacityArgs;
import com.pulumi.aws.appstream.inputs.FleetVpcConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testFleet = new Fleet("testFleet", FleetArgs.builder()
            .computeCapacity(FleetComputeCapacityArgs.builder()
                .desiredInstances(1)
                .build())
            .vpcConfig(FleetVpcConfigArgs.builder()
                .subnetIds("subnet-06e9b13400c225127")
                .build())
            .name("test-fleet")
            .description("test fleet")
            .idleDisconnectTimeoutInSeconds(60)
            .displayName("test-fleet")
            .enableDefaultInternetAccess(false)
            .fleetType("ON_DEMAND")
            .imageName("Amazon-AppStream2-Sample-Image-03-11-2023")
            .instanceType("stream.standard.large")
            .maxUserDurationInSeconds(600)
            .tags(Map.of("TagName", "tag-value"))
            .build());

    }
}
resources:
  testFleet:
    type: aws:appstream:Fleet
    name: test_fleet
    properties:
      computeCapacity:
        desiredInstances: 1
      vpcConfig:
        subnetIds:
          - subnet-06e9b13400c225127
      name: test-fleet
      description: test fleet
      idleDisconnectTimeoutInSeconds: 60
      displayName: test-fleet
      enableDefaultInternetAccess: false
      fleetType: ON_DEMAND
      imageName: Amazon-AppStream2-Sample-Image-03-11-2023
      instanceType: stream.standard.large
      maxUserDurationInSeconds: 600
      tags:
        TagName: tag-value

Import

Using pulumi import, import aws.appstream.Fleet using the id. For example:

$ pulumi import aws:appstream/fleet:Fleet example fleetNameExample

Constructors

Fleet(String name, {FleetArgs? args, CustomResourceOptions? options})
Creates a new Fleet. name The Pulumi resource name. args Arguments used to configure this Fleet. The set of arguments for Fleet. options Resource options controlling this resource's behavior.
Fleet.reference(String urn)
Creates a typed reference to an existing Fleet resource.

Properties

arn ↔ Output<String>
ARN of the appstream fleet.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
computeCapacity ↔ Output<FleetComputeCapacity>
Configuration block for the desired capacity of the fleet. See below.
latefinal
createdTime ↔ Output<String>
Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
latefinal
description ↔ Output<String>
Description to display.
latefinal
disconnectTimeoutInSeconds ↔ Output<int>
Amount of time that a streaming session remains active after users disconnect.
latefinal
displayName ↔ Output<String>
Human-readable friendly name for the AppStream fleet.
latefinal
domainJoinInfo ↔ Output<FleetDomainJoinInfo>
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.
latefinal
enableDefaultInternetAccess ↔ Output<bool>
Enables or disables default internet access for the fleet.
latefinal
fleetType ↔ Output<String>
Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
latefinal
hashCode → int
The hash code for this object.
no setterinherited
iamRoleArn ↔ Output<String>
ARN of the IAM role to apply to the fleet.
latefinal
id ↔ Output<String>
getter/setter pairinherited
idleDisconnectTimeoutInSeconds ↔ Output<int?>
Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnectTimeoutInSeconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
latefinal
imageArn ↔ Output<String>
ARN of the public, private, or shared image to use.
latefinal
imageName ↔ Output<String>
Name of the image used to create the fleet.
latefinal
instanceType ↔ Output<String>
Instance type to use when launching fleet instances.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
maxSessionsPerInstance ↔ Output<int?>
Maximum number of user sessions on an instance. This only applies to multi-session fleets.
latefinal
maxUserDurationInSeconds ↔ Output<int>
Maximum amount of time that a streaming session can remain active, in seconds.
latefinal
name ↔ Output<String>
Unique name for the fleet.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state ↔ Output<String>
State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
latefinal
streamView ↔ Output<String>
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.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to attach to AppStream instances.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vpcConfig ↔ Output<FleetVpcConfig>
Configuration block for the VPC configuration for the image builder. See below.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {FleetState? state, CustomResourceOptions? options}) → Fleet
Gets an existing Fleet resource's state with the given name and id.