Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. appstream
  5. Fleet
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.appstream.Fleet

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    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", {
    name: "test-fleet",
    computeCapacity: {
        desiredInstances: 1,
    },
    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,
    vpcConfig: {
        subnetIds: ["subnet-06e9b13400c225127"],
    },
    tags: {
        TagName: "tag-value",
    },
});

    import pulumi
import pulumi_aws as aws

test_fleet = aws.appstream.Fleet("test_fleet",
    name="test-fleet",
    compute_capacity={
        "desired_instances": 1,
    },
    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,
    vpc_config={
        "subnet_ids": ["subnet-06e9b13400c225127"],
    },
    tags={
        "TagName": "tag-value",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name: pulumi.String("test-fleet"),
			ComputeCapacity: &appstream.FleetComputeCapacityArgs{
				DesiredInstances: pulumi.Int(1),
			},
			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),
			VpcConfig: &appstream.FleetVpcConfigArgs{
				SubnetIds: pulumi.StringArray{
					pulumi.String("subnet-06e9b13400c225127"),
				},
			},
			Tags: pulumi.StringMap{
				"TagName": pulumi.String("tag-value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        Name = "test-fleet",
        ComputeCapacity = new Aws.AppStream.Inputs.FleetComputeCapacityArgs
        {
            DesiredInstances = 1,
        },
        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,
        VpcConfig = new Aws.AppStream.Inputs.FleetVpcConfigArgs
        {
            SubnetIds = new[]
            {
                "subnet-06e9b13400c225127",
            },
        },
        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.List;
import java.util.ArrayList;
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()
            .name("test-fleet")
            .computeCapacity(FleetComputeCapacityArgs.builder()
                .desiredInstances(1)
                .build())
            .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)
            .vpcConfig(FleetVpcConfigArgs.builder()
                .subnetIds("subnet-06e9b13400c225127")
                .build())
            .tags(Map.of("TagName", "tag-value"))
            .build());

    }
}

    resources:
  testFleet:
    type: aws:appstream:Fleet
    name: test_fleet
    properties:
      name: test-fleet
      computeCapacity:
        desiredInstances: 1
      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
      vpcConfig:
        subnetIds:
          - subnet-06e9b13400c225127
      tags:
        TagName: tag-value

    Create Fleet Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Fleet(name: string, args: FleetArgs, opts?: CustomResourceOptions);
    @overload
def Fleet(resource_name: str,
          args: FleetArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Fleet(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          compute_capacity: Optional[FleetComputeCapacityArgs] = None,
          instance_type: Optional[str] = None,
          idle_disconnect_timeout_in_seconds: Optional[int] = None,
          image_arn: Optional[str] = None,
          domain_join_info: Optional[FleetDomainJoinInfoArgs] = None,
          enable_default_internet_access: Optional[bool] = None,
          fleet_type: Optional[str] = None,
          iam_role_arn: Optional[str] = None,
          disconnect_timeout_in_seconds: Optional[int] = None,
          display_name: Optional[str] = None,
          image_name: Optional[str] = None,
          description: Optional[str] = None,
          max_sessions_per_instance: Optional[int] = None,
          max_user_duration_in_seconds: Optional[int] = None,
          name: Optional[str] = None,
          stream_view: Optional[str] = None,
          tags: Optional[Mapping[str, str]] = None,
          vpc_config: Optional[FleetVpcConfigArgs] = None)
    func NewFleet(ctx *Context, name string, args FleetArgs, opts ...ResourceOption) (*Fleet, error)
    public Fleet(string name, FleetArgs args, CustomResourceOptions? opts = null)
    public Fleet(String name, FleetArgs args)
public Fleet(String name, FleetArgs args, CustomResourceOptions options)

    type: aws:appstream:Fleet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args FleetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FleetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FleetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FleetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FleetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var fleetResource = new Aws.AppStream.Fleet("fleetResource", new()
{
    ComputeCapacity = new Aws.AppStream.Inputs.FleetComputeCapacityArgs
    {
        Available = 0,
        DesiredInstances = 0,
        DesiredSessions = 0,
        InUse = 0,
        Running = 0,
    },
    InstanceType = "string",
    IdleDisconnectTimeoutInSeconds = 0,
    ImageArn = "string",
    DomainJoinInfo = new Aws.AppStream.Inputs.FleetDomainJoinInfoArgs
    {
        DirectoryName = "string",
        OrganizationalUnitDistinguishedName = "string",
    },
    EnableDefaultInternetAccess = false,
    FleetType = "string",
    IamRoleArn = "string",
    DisconnectTimeoutInSeconds = 0,
    DisplayName = "string",
    ImageName = "string",
    Description = "string",
    MaxSessionsPerInstance = 0,
    MaxUserDurationInSeconds = 0,
    Name = "string",
    StreamView = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VpcConfig = new Aws.AppStream.Inputs.FleetVpcConfigArgs
    {
        SecurityGroupIds = new[]
        {
            "string",
        },
        SubnetIds = new[]
        {
            "string",
        },
    },
});

    example, err := appstream.NewFleet(ctx, "fleetResource", &appstream.FleetArgs{
	ComputeCapacity: &appstream.FleetComputeCapacityArgs{
		Available:        pulumi.Int(0),
		DesiredInstances: pulumi.Int(0),
		DesiredSessions:  pulumi.Int(0),
		InUse:            pulumi.Int(0),
		Running:          pulumi.Int(0),
	},
	InstanceType:                   pulumi.String("string"),
	IdleDisconnectTimeoutInSeconds: pulumi.Int(0),
	ImageArn:                       pulumi.String("string"),
	DomainJoinInfo: &appstream.FleetDomainJoinInfoArgs{
		DirectoryName:                       pulumi.String("string"),
		OrganizationalUnitDistinguishedName: pulumi.String("string"),
	},
	EnableDefaultInternetAccess: pulumi.Bool(false),
	FleetType:                   pulumi.String("string"),
	IamRoleArn:                  pulumi.String("string"),
	DisconnectTimeoutInSeconds:  pulumi.Int(0),
	DisplayName:                 pulumi.String("string"),
	ImageName:                   pulumi.String("string"),
	Description:                 pulumi.String("string"),
	MaxSessionsPerInstance:      pulumi.Int(0),
	MaxUserDurationInSeconds:    pulumi.Int(0),
	Name:                        pulumi.String("string"),
	StreamView:                  pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcConfig: &appstream.FleetVpcConfigArgs{
		SecurityGroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		SubnetIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    var fleetResource = new Fleet("fleetResource", FleetArgs.builder()
    .computeCapacity(FleetComputeCapacityArgs.builder()
        .available(0)
        .desiredInstances(0)
        .desiredSessions(0)
        .inUse(0)
        .running(0)
        .build())
    .instanceType("string")
    .idleDisconnectTimeoutInSeconds(0)
    .imageArn("string")
    .domainJoinInfo(FleetDomainJoinInfoArgs.builder()
        .directoryName("string")
        .organizationalUnitDistinguishedName("string")
        .build())
    .enableDefaultInternetAccess(false)
    .fleetType("string")
    .iamRoleArn("string")
    .disconnectTimeoutInSeconds(0)
    .displayName("string")
    .imageName("string")
    .description("string")
    .maxSessionsPerInstance(0)
    .maxUserDurationInSeconds(0)
    .name("string")
    .streamView("string")
    .tags(Map.of("string", "string"))
    .vpcConfig(FleetVpcConfigArgs.builder()
        .securityGroupIds("string")
        .subnetIds("string")
        .build())
    .build());

    fleet_resource = aws.appstream.Fleet("fleetResource",
    compute_capacity={
        "available": 0,
        "desired_instances": 0,
        "desired_sessions": 0,
        "in_use": 0,
        "running": 0,
    },
    instance_type="string",
    idle_disconnect_timeout_in_seconds=0,
    image_arn="string",
    domain_join_info={
        "directory_name": "string",
        "organizational_unit_distinguished_name": "string",
    },
    enable_default_internet_access=False,
    fleet_type="string",
    iam_role_arn="string",
    disconnect_timeout_in_seconds=0,
    display_name="string",
    image_name="string",
    description="string",
    max_sessions_per_instance=0,
    max_user_duration_in_seconds=0,
    name="string",
    stream_view="string",
    tags={
        "string": "string",
    },
    vpc_config={
        "security_group_ids": ["string"],
        "subnet_ids": ["string"],
    })

    const fleetResource = new aws.appstream.Fleet("fleetResource", {
    computeCapacity: {
        available: 0,
        desiredInstances: 0,
        desiredSessions: 0,
        inUse: 0,
        running: 0,
    },
    instanceType: "string",
    idleDisconnectTimeoutInSeconds: 0,
    imageArn: "string",
    domainJoinInfo: {
        directoryName: "string",
        organizationalUnitDistinguishedName: "string",
    },
    enableDefaultInternetAccess: false,
    fleetType: "string",
    iamRoleArn: "string",
    disconnectTimeoutInSeconds: 0,
    displayName: "string",
    imageName: "string",
    description: "string",
    maxSessionsPerInstance: 0,
    maxUserDurationInSeconds: 0,
    name: "string",
    streamView: "string",
    tags: {
        string: "string",
    },
    vpcConfig: {
        securityGroupIds: ["string"],
        subnetIds: ["string"],
    },
});

    type: aws:appstream:Fleet
properties:
    computeCapacity:
        available: 0
        desiredInstances: 0
        desiredSessions: 0
        inUse: 0
        running: 0
    description: string
    disconnectTimeoutInSeconds: 0
    displayName: string
    domainJoinInfo:
        directoryName: string
        organizationalUnitDistinguishedName: string
    enableDefaultInternetAccess: false
    fleetType: string
    iamRoleArn: string
    idleDisconnectTimeoutInSeconds: 0
    imageArn: string
    imageName: string
    instanceType: string
    maxSessionsPerInstance: 0
    maxUserDurationInSeconds: 0
    name: string
    streamView: string
    tags:
        string: string
    vpcConfig:
        securityGroupIds:
            - string
        subnetIds:
            - string

    Fleet Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Fleet resource accepts the following input properties:

    ComputeCapacity FleetComputeCapacity
    Configuration block for the desired capacity of the fleet. See below.
    InstanceType string
    Instance type to use when launching fleet instances.
    Description string
    Description to display.
    DisconnectTimeoutInSeconds int
    Amount of time that a streaming session remains active after users disconnect.
    DisplayName string
    Human-readable friendly name for the AppStream fleet.
    DomainJoinInfo 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.
    EnableDefaultInternetAccess bool
    Enables or disables default internet access for the fleet.
    FleetType string
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    IamRoleArn string
    ARN of the IAM role to apply to the fleet.
    IdleDisconnectTimeoutInSeconds int
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    ImageArn string
    ARN of the public, private, or shared image to use.
    ImageName string
    Name of the image used to create the fleet.
    MaxSessionsPerInstance int
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    MaxUserDurationInSeconds int
    Maximum amount of time that a streaming session can remain active, in seconds.
    Name string

    Unique name for the fleet.

    The following arguments are optional:

    StreamView 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.
    Tags Dictionary<string, string>
    Map of tags to attach to AppStream instances.
    VpcConfig FleetVpcConfig
    Configuration block for the VPC configuration for the image builder. See below.
    ComputeCapacity FleetComputeCapacityArgs
    Configuration block for the desired capacity of the fleet. See below.
    InstanceType string
    Instance type to use when launching fleet instances.
    Description string
    Description to display.
    DisconnectTimeoutInSeconds int
    Amount of time that a streaming session remains active after users disconnect.
    DisplayName string
    Human-readable friendly name for the AppStream fleet.
    DomainJoinInfo FleetDomainJoinInfoArgs
    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 bool
    Enables or disables default internet access for the fleet.
    FleetType string
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    IamRoleArn string
    ARN of the IAM role to apply to the fleet.
    IdleDisconnectTimeoutInSeconds int
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    ImageArn string
    ARN of the public, private, or shared image to use.
    ImageName string
    Name of the image used to create the fleet.
    MaxSessionsPerInstance int
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    MaxUserDurationInSeconds int
    Maximum amount of time that a streaming session can remain active, in seconds.
    Name string

    Unique name for the fleet.

    The following arguments are optional:

    StreamView 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.
    Tags map[string]string
    Map of tags to attach to AppStream instances.
    VpcConfig FleetVpcConfigArgs
    Configuration block for the VPC configuration for the image builder. See below.
    computeCapacity FleetComputeCapacity
    Configuration block for the desired capacity of the fleet. See below.
    instanceType String
    Instance type to use when launching fleet instances.
    description String
    Description to display.
    disconnectTimeoutInSeconds Integer
    Amount of time that a streaming session remains active after users disconnect.
    displayName String
    Human-readable friendly name for the AppStream fleet.
    domainJoinInfo 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.
    enableDefaultInternetAccess Boolean
    Enables or disables default internet access for the fleet.
    fleetType String
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    iamRoleArn String
    ARN of the IAM role to apply to the fleet.
    idleDisconnectTimeoutInSeconds Integer
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    imageArn String
    ARN of the public, private, or shared image to use.
    imageName String
    Name of the image used to create the fleet.
    maxSessionsPerInstance Integer
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    maxUserDurationInSeconds Integer
    Maximum amount of time that a streaming session can remain active, in seconds.
    name String

    Unique name for the fleet.

    The following arguments are optional:

    streamView 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.
    tags Map<String,String>
    Map of tags to attach to AppStream instances.
    vpcConfig FleetVpcConfig
    Configuration block for the VPC configuration for the image builder. See below.
    computeCapacity FleetComputeCapacity
    Configuration block for the desired capacity of the fleet. See below.
    instanceType string
    Instance type to use when launching fleet instances.
    description string
    Description to display.
    disconnectTimeoutInSeconds number
    Amount of time that a streaming session remains active after users disconnect.
    displayName string
    Human-readable friendly name for the AppStream fleet.
    domainJoinInfo 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.
    enableDefaultInternetAccess boolean
    Enables or disables default internet access for the fleet.
    fleetType string
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    iamRoleArn string
    ARN of the IAM role to apply to the fleet.
    idleDisconnectTimeoutInSeconds number
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    imageArn string
    ARN of the public, private, or shared image to use.
    imageName string
    Name of the image used to create the fleet.
    maxSessionsPerInstance number
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    maxUserDurationInSeconds number
    Maximum amount of time that a streaming session can remain active, in seconds.
    name string

    Unique name for the fleet.

    The following arguments are optional:

    streamView 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.
    tags {[key: string]: string}
    Map of tags to attach to AppStream instances.
    vpcConfig FleetVpcConfig
    Configuration block for the VPC configuration for the image builder. See below.
    compute_capacity FleetComputeCapacityArgs
    Configuration block for the desired capacity of the fleet. See below.
    instance_type str
    Instance type to use when launching fleet instances.
    description str
    Description to display.
    disconnect_timeout_in_seconds int
    Amount of time that a streaming session remains active after users disconnect.
    display_name str
    Human-readable friendly name for the AppStream fleet.
    domain_join_info FleetDomainJoinInfoArgs
    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.
    enable_default_internet_access bool
    Enables or disables default internet access for the fleet.
    fleet_type str
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    iam_role_arn str
    ARN of the IAM role to apply to the fleet.
    idle_disconnect_timeout_in_seconds int
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    image_arn str
    ARN of the public, private, or shared image to use.
    image_name str
    Name of the image used to create the fleet.
    max_sessions_per_instance int
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    max_user_duration_in_seconds int
    Maximum amount of time that a streaming session can remain active, in seconds.
    name str

    Unique name for the fleet.

    The following arguments are optional:

    stream_view str
    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.
    tags Mapping[str, str]
    Map of tags to attach to AppStream instances.
    vpc_config FleetVpcConfigArgs
    Configuration block for the VPC configuration for the image builder. See below.
    computeCapacity Property Map
    Configuration block for the desired capacity of the fleet. See below.
    instanceType String
    Instance type to use when launching fleet instances.
    description String
    Description to display.
    disconnectTimeoutInSeconds Number
    Amount of time that a streaming session remains active after users disconnect.
    displayName String
    Human-readable friendly name for the AppStream fleet.
    domainJoinInfo Property Map
    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 Boolean
    Enables or disables default internet access for the fleet.
    fleetType String
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    iamRoleArn String
    ARN of the IAM role to apply to the fleet.
    idleDisconnectTimeoutInSeconds Number
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    imageArn String
    ARN of the public, private, or shared image to use.
    imageName String
    Name of the image used to create the fleet.
    maxSessionsPerInstance Number
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    maxUserDurationInSeconds Number
    Maximum amount of time that a streaming session can remain active, in seconds.
    name String

    Unique name for the fleet.

    The following arguments are optional:

    streamView 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.
    tags Map<String>
    Map of tags to attach to AppStream instances.
    vpcConfig Property Map
    Configuration block for the VPC configuration for the image builder. See below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Fleet resource produces the following output properties:

    Arn string
    ARN of the appstream fleet.
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the appstream fleet.
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    ARN of the appstream fleet.
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    ARN of the appstream fleet.
    createdTime string
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    ARN of the appstream fleet.
    created_time str
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    ARN of the appstream fleet.
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing Fleet Resource

    Get an existing Fleet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FleetState, opts?: CustomResourceOptions): Fleet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        compute_capacity: Optional[FleetComputeCapacityArgs] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        disconnect_timeout_in_seconds: Optional[int] = None,
        display_name: Optional[str] = None,
        domain_join_info: Optional[FleetDomainJoinInfoArgs] = None,
        enable_default_internet_access: Optional[bool] = None,
        fleet_type: Optional[str] = None,
        iam_role_arn: Optional[str] = None,
        idle_disconnect_timeout_in_seconds: Optional[int] = None,
        image_arn: Optional[str] = None,
        image_name: Optional[str] = None,
        instance_type: Optional[str] = None,
        max_sessions_per_instance: Optional[int] = None,
        max_user_duration_in_seconds: Optional[int] = None,
        name: Optional[str] = None,
        state: Optional[str] = None,
        stream_view: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_config: Optional[FleetVpcConfigArgs] = None) -> Fleet
    func GetFleet(ctx *Context, name string, id IDInput, state *FleetState, opts ...ResourceOption) (*Fleet, error)
    public static Fleet Get(string name, Input<string> id, FleetState? state, CustomResourceOptions? opts = null)
    public static Fleet get(String name, Output<String> id, FleetState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the appstream fleet.
    ComputeCapacity FleetComputeCapacity
    Configuration block for the desired capacity of the fleet. See below.
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    Description string
    Description to display.
    DisconnectTimeoutInSeconds int
    Amount of time that a streaming session remains active after users disconnect.
    DisplayName string
    Human-readable friendly name for the AppStream fleet.
    DomainJoinInfo 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.
    EnableDefaultInternetAccess bool
    Enables or disables default internet access for the fleet.
    FleetType string
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    IamRoleArn string
    ARN of the IAM role to apply to the fleet.
    IdleDisconnectTimeoutInSeconds int
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    ImageArn string
    ARN of the public, private, or shared image to use.
    ImageName string
    Name of the image used to create the fleet.
    InstanceType string
    Instance type to use when launching fleet instances.
    MaxSessionsPerInstance int
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    MaxUserDurationInSeconds int
    Maximum amount of time that a streaming session can remain active, in seconds.
    Name string

    Unique name for the fleet.

    The following arguments are optional:

    State string
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    StreamView 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.
    Tags Dictionary<string, string>
    Map of tags to attach to AppStream instances.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    VpcConfig FleetVpcConfig
    Configuration block for the VPC configuration for the image builder. See below.
    Arn string
    ARN of the appstream fleet.
    ComputeCapacity FleetComputeCapacityArgs
    Configuration block for the desired capacity of the fleet. See below.
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    Description string
    Description to display.
    DisconnectTimeoutInSeconds int
    Amount of time that a streaming session remains active after users disconnect.
    DisplayName string
    Human-readable friendly name for the AppStream fleet.
    DomainJoinInfo FleetDomainJoinInfoArgs
    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 bool
    Enables or disables default internet access for the fleet.
    FleetType string
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    IamRoleArn string
    ARN of the IAM role to apply to the fleet.
    IdleDisconnectTimeoutInSeconds int
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    ImageArn string
    ARN of the public, private, or shared image to use.
    ImageName string
    Name of the image used to create the fleet.
    InstanceType string
    Instance type to use when launching fleet instances.
    MaxSessionsPerInstance int
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    MaxUserDurationInSeconds int
    Maximum amount of time that a streaming session can remain active, in seconds.
    Name string

    Unique name for the fleet.

    The following arguments are optional:

    State string
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    StreamView 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.
    Tags map[string]string
    Map of tags to attach to AppStream instances.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    VpcConfig FleetVpcConfigArgs
    Configuration block for the VPC configuration for the image builder. See below.
    arn String
    ARN of the appstream fleet.
    computeCapacity FleetComputeCapacity
    Configuration block for the desired capacity of the fleet. See below.
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    description String
    Description to display.
    disconnectTimeoutInSeconds Integer
    Amount of time that a streaming session remains active after users disconnect.
    displayName String
    Human-readable friendly name for the AppStream fleet.
    domainJoinInfo 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.
    enableDefaultInternetAccess Boolean
    Enables or disables default internet access for the fleet.
    fleetType String
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    iamRoleArn String
    ARN of the IAM role to apply to the fleet.
    idleDisconnectTimeoutInSeconds Integer
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    imageArn String
    ARN of the public, private, or shared image to use.
    imageName String
    Name of the image used to create the fleet.
    instanceType String
    Instance type to use when launching fleet instances.
    maxSessionsPerInstance Integer
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    maxUserDurationInSeconds Integer
    Maximum amount of time that a streaming session can remain active, in seconds.
    name String

    Unique name for the fleet.

    The following arguments are optional:

    state String
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    streamView 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.
    tags Map<String,String>
    Map of tags to attach to AppStream instances.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    vpcConfig FleetVpcConfig
    Configuration block for the VPC configuration for the image builder. See below.
    arn string
    ARN of the appstream fleet.
    computeCapacity FleetComputeCapacity
    Configuration block for the desired capacity of the fleet. See below.
    createdTime string
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    description string
    Description to display.
    disconnectTimeoutInSeconds number
    Amount of time that a streaming session remains active after users disconnect.
    displayName string
    Human-readable friendly name for the AppStream fleet.
    domainJoinInfo 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.
    enableDefaultInternetAccess boolean
    Enables or disables default internet access for the fleet.
    fleetType string
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    iamRoleArn string
    ARN of the IAM role to apply to the fleet.
    idleDisconnectTimeoutInSeconds number
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    imageArn string
    ARN of the public, private, or shared image to use.
    imageName string
    Name of the image used to create the fleet.
    instanceType string
    Instance type to use when launching fleet instances.
    maxSessionsPerInstance number
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    maxUserDurationInSeconds number
    Maximum amount of time that a streaming session can remain active, in seconds.
    name string

    Unique name for the fleet.

    The following arguments are optional:

    state string
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    streamView 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.
    tags {[key: string]: string}
    Map of tags to attach to AppStream instances.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    vpcConfig FleetVpcConfig
    Configuration block for the VPC configuration for the image builder. See below.
    arn str
    ARN of the appstream fleet.
    compute_capacity FleetComputeCapacityArgs
    Configuration block for the desired capacity of the fleet. See below.
    created_time str
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    description str
    Description to display.
    disconnect_timeout_in_seconds int
    Amount of time that a streaming session remains active after users disconnect.
    display_name str
    Human-readable friendly name for the AppStream fleet.
    domain_join_info FleetDomainJoinInfoArgs
    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.
    enable_default_internet_access bool
    Enables or disables default internet access for the fleet.
    fleet_type str
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    iam_role_arn str
    ARN of the IAM role to apply to the fleet.
    idle_disconnect_timeout_in_seconds int
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    image_arn str
    ARN of the public, private, or shared image to use.
    image_name str
    Name of the image used to create the fleet.
    instance_type str
    Instance type to use when launching fleet instances.
    max_sessions_per_instance int
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    max_user_duration_in_seconds int
    Maximum amount of time that a streaming session can remain active, in seconds.
    name str

    Unique name for the fleet.

    The following arguments are optional:

    state str
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    stream_view str
    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.
    tags Mapping[str, str]
    Map of tags to attach to AppStream instances.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    vpc_config FleetVpcConfigArgs
    Configuration block for the VPC configuration for the image builder. See below.
    arn String
    ARN of the appstream fleet.
    computeCapacity Property Map
    Configuration block for the desired capacity of the fleet. See below.
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the fleet was created.
    description String
    Description to display.
    disconnectTimeoutInSeconds Number
    Amount of time that a streaming session remains active after users disconnect.
    displayName String
    Human-readable friendly name for the AppStream fleet.
    domainJoinInfo Property Map
    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 Boolean
    Enables or disables default internet access for the fleet.
    fleetType String
    Fleet type. Valid values are: ON_DEMAND, ALWAYS_ON
    iamRoleArn String
    ARN of the IAM role to apply to the fleet.
    idleDisconnectTimeoutInSeconds Number
    Amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect_timeout_in_seconds time interval begins. Defaults to 0. Valid value is between 60 and 3600 seconds.
    imageArn String
    ARN of the public, private, or shared image to use.
    imageName String
    Name of the image used to create the fleet.
    instanceType String
    Instance type to use when launching fleet instances.
    maxSessionsPerInstance Number
    The maximum number of user sessions on an instance. This only applies to multi-session fleets.
    maxUserDurationInSeconds Number
    Maximum amount of time that a streaming session can remain active, in seconds.
    name String

    Unique name for the fleet.

    The following arguments are optional:

    state String
    State of the fleet. Can be STARTING, RUNNING, STOPPING or STOPPED
    streamView 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.
    tags Map<String>
    Map of tags to attach to AppStream instances.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    vpcConfig Property Map
    Configuration block for the VPC configuration for the image builder. See below.

    Supporting Types

    FleetComputeCapacity, FleetComputeCapacityArgs

    Available int
    Number of currently available instances that can be used to stream sessions.
    DesiredInstances int
    Desired number of streaming instances.
    DesiredSessions int
    Desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
    InUse int
    Number of instances in use for streaming.
    Running int
    Total number of simultaneous streaming instances that are running.
    Available int
    Number of currently available instances that can be used to stream sessions.
    DesiredInstances int
    Desired number of streaming instances.
    DesiredSessions int
    Desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
    InUse int
    Number of instances in use for streaming.
    Running int
    Total number of simultaneous streaming instances that are running.
    available Integer
    Number of currently available instances that can be used to stream sessions.
    desiredInstances Integer
    Desired number of streaming instances.
    desiredSessions Integer
    Desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
    inUse Integer
    Number of instances in use for streaming.
    running Integer
    Total number of simultaneous streaming instances that are running.
    available number
    Number of currently available instances that can be used to stream sessions.
    desiredInstances number
    Desired number of streaming instances.
    desiredSessions number
    Desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
    inUse number
    Number of instances in use for streaming.
    running number
    Total number of simultaneous streaming instances that are running.
    available int
    Number of currently available instances that can be used to stream sessions.
    desired_instances int
    Desired number of streaming instances.
    desired_sessions int
    Desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
    in_use int
    Number of instances in use for streaming.
    running int
    Total number of simultaneous streaming instances that are running.
    available Number
    Number of currently available instances that can be used to stream sessions.
    desiredInstances Number
    Desired number of streaming instances.
    desiredSessions Number
    Desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
    inUse Number
    Number of instances in use for streaming.
    running Number
    Total number of simultaneous streaming instances that are running.

    FleetDomainJoinInfo, FleetDomainJoinInfoArgs

    DirectoryName string
    Fully qualified name of the directory (for example, corp.example.com).
    OrganizationalUnitDistinguishedName string
    Distinguished name of the organizational unit for computer accounts.
    DirectoryName string
    Fully qualified name of the directory (for example, corp.example.com).
    OrganizationalUnitDistinguishedName string
    Distinguished name of the organizational unit for computer accounts.
    directoryName String
    Fully qualified name of the directory (for example, corp.example.com).
    organizationalUnitDistinguishedName String
    Distinguished name of the organizational unit for computer accounts.
    directoryName string
    Fully qualified name of the directory (for example, corp.example.com).
    organizationalUnitDistinguishedName string
    Distinguished name of the organizational unit for computer accounts.
    directory_name str
    Fully qualified name of the directory (for example, corp.example.com).
    organizational_unit_distinguished_name str
    Distinguished name of the organizational unit for computer accounts.
    directoryName String
    Fully qualified name of the directory (for example, corp.example.com).
    organizationalUnitDistinguishedName String
    Distinguished name of the organizational unit for computer accounts.

    FleetVpcConfig, FleetVpcConfigArgs

    SecurityGroupIds List<string>
    Identifiers of the security groups for the fleet or image builder.
    SubnetIds List<string>
    Identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance.
    SecurityGroupIds []string
    Identifiers of the security groups for the fleet or image builder.
    SubnetIds []string
    Identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance.
    securityGroupIds List<String>
    Identifiers of the security groups for the fleet or image builder.
    subnetIds List<String>
    Identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance.
    securityGroupIds string[]
    Identifiers of the security groups for the fleet or image builder.
    subnetIds string[]
    Identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance.
    security_group_ids Sequence[str]
    Identifiers of the security groups for the fleet or image builder.
    subnet_ids Sequence[str]
    Identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance.
    securityGroupIds List<String>
    Identifiers of the security groups for the fleet or image builder.
    subnetIds List<String>
    Identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance.

    Import

    Using pulumi import, import aws_appstream_fleet using the id. For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws