Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. appstream
  5. ImageBuilder

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.12.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-aws

aws.appstream.ImageBuilder

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.12.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-aws

    Provides an AppStream image builder.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var testFleet = new Aws.AppStream.ImageBuilder("testFleet", new()
    {
        Description = "Description of a ImageBuilder",
        DisplayName = "Display name of a ImageBuilder",
        EnableDefaultInternetAccess = false,
        ImageName = "AppStream-WinServer2019-10-05-2022",
        InstanceType = "stream.standard.large",
        VpcConfig = new Aws.AppStream.Inputs.ImageBuilderVpcConfigArgs
        {
            SubnetIds = new[]
            {
                aws_subnet.Example.Id,
            },
        },
        Tags = 
        {
            { "Name", "Example Image Builder" },
        },
    });

});

    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.NewImageBuilder(ctx, "testFleet", &appstream.ImageBuilderArgs{
			Description:                 pulumi.String("Description of a ImageBuilder"),
			DisplayName:                 pulumi.String("Display name of a ImageBuilder"),
			EnableDefaultInternetAccess: pulumi.Bool(false),
			ImageName:                   pulumi.String("AppStream-WinServer2019-10-05-2022"),
			InstanceType:                pulumi.String("stream.standard.large"),
			VpcConfig: &appstream.ImageBuilderVpcConfigArgs{
				SubnetIds: pulumi.StringArray{
					aws_subnet.Example.Id,
				},
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example Image Builder"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appstream.ImageBuilder;
import com.pulumi.aws.appstream.ImageBuilderArgs;
import com.pulumi.aws.appstream.inputs.ImageBuilderVpcConfigArgs;
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 ImageBuilder("testFleet", ImageBuilderArgs.builder()        
            .description("Description of a ImageBuilder")
            .displayName("Display name of a ImageBuilder")
            .enableDefaultInternetAccess(false)
            .imageName("AppStream-WinServer2019-10-05-2022")
            .instanceType("stream.standard.large")
            .vpcConfig(ImageBuilderVpcConfigArgs.builder()
                .subnetIds(aws_subnet.example().id())
                .build())
            .tags(Map.of("Name", "Example Image Builder"))
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

test_fleet = aws.appstream.ImageBuilder("testFleet",
    description="Description of a ImageBuilder",
    display_name="Display name of a ImageBuilder",
    enable_default_internet_access=False,
    image_name="AppStream-WinServer2019-10-05-2022",
    instance_type="stream.standard.large",
    vpc_config=aws.appstream.ImageBuilderVpcConfigArgs(
        subnet_ids=[aws_subnet["example"]["id"]],
    ),
    tags={
        "Name": "Example Image Builder",
    })

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

const testFleet = new aws.appstream.ImageBuilder("testFleet", {
    description: "Description of a ImageBuilder",
    displayName: "Display name of a ImageBuilder",
    enableDefaultInternetAccess: false,
    imageName: "AppStream-WinServer2019-10-05-2022",
    instanceType: "stream.standard.large",
    vpcConfig: {
        subnetIds: [aws_subnet.example.id],
    },
    tags: {
        Name: "Example Image Builder",
    },
});

    resources:
  testFleet:
    type: aws:appstream:ImageBuilder
    properties:
      description: Description of a ImageBuilder
      displayName: Display name of a ImageBuilder
      enableDefaultInternetAccess: false
      imageName: AppStream-WinServer2019-10-05-2022
      instanceType: stream.standard.large
      vpcConfig:
        subnetIds:
          - ${aws_subnet.example.id}
      tags:
        Name: Example Image Builder

    Create ImageBuilder Resource

    new ImageBuilder(name: string, args: ImageBuilderArgs, opts?: CustomResourceOptions);
    @overload
def ImageBuilder(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 access_endpoints: Optional[Sequence[ImageBuilderAccessEndpointArgs]] = None,
                 appstream_agent_version: Optional[str] = None,
                 description: Optional[str] = None,
                 display_name: Optional[str] = None,
                 domain_join_info: Optional[ImageBuilderDomainJoinInfoArgs] = None,
                 enable_default_internet_access: Optional[bool] = None,
                 iam_role_arn: Optional[str] = None,
                 image_arn: Optional[str] = None,
                 image_name: Optional[str] = None,
                 instance_type: Optional[str] = None,
                 name: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 vpc_config: Optional[ImageBuilderVpcConfigArgs] = None)
@overload
def ImageBuilder(resource_name: str,
                 args: ImageBuilderArgs,
                 opts: Optional[ResourceOptions] = None)
    func NewImageBuilder(ctx *Context, name string, args ImageBuilderArgs, opts ...ResourceOption) (*ImageBuilder, error)
    public ImageBuilder(string name, ImageBuilderArgs args, CustomResourceOptions? opts = null)
    public ImageBuilder(String name, ImageBuilderArgs args)
public ImageBuilder(String name, ImageBuilderArgs args, CustomResourceOptions options)

    type: aws:appstream:ImageBuilder
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ImageBuilderArgs
    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 ImageBuilderArgs
    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 ImageBuilderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ImageBuilderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ImageBuilderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ImageBuilder Resource Properties

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

    Inputs

    The ImageBuilder resource accepts the following input properties:

    InstanceType string

    Instance type to use when launching the image builder.

    AccessEndpoints List<ImageBuilderAccessEndpoint>

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    AppstreamAgentVersion string

    Version of the AppStream 2.0 agent to use for this image builder.

    Description string

    Description to display.

    DisplayName string

    Human-readable friendly name for the AppStream image builder.

    DomainJoinInfo ImageBuilderDomainJoinInfo

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    EnableDefaultInternetAccess bool

    Enables or disables default internet access for the image builder.

    IamRoleArn string

    ARN of the IAM role to apply to the image builder.

    ImageArn string

    ARN of the public, private, or shared image to use.

    ImageName string

    Name of the image used to create the image builder.

    Name string

    Unique name for the image builder.

    The following arguments are optional:

    Tags Dictionary<string, string>

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    VpcConfig ImageBuilderVpcConfig

    Configuration block for the VPC configuration for the image builder. See below.

    InstanceType string

    Instance type to use when launching the image builder.

    AccessEndpoints []ImageBuilderAccessEndpointArgs

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    AppstreamAgentVersion string

    Version of the AppStream 2.0 agent to use for this image builder.

    Description string

    Description to display.

    DisplayName string

    Human-readable friendly name for the AppStream image builder.

    DomainJoinInfo ImageBuilderDomainJoinInfoArgs

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    EnableDefaultInternetAccess bool

    Enables or disables default internet access for the image builder.

    IamRoleArn string

    ARN of the IAM role to apply to the image builder.

    ImageArn string

    ARN of the public, private, or shared image to use.

    ImageName string

    Name of the image used to create the image builder.

    Name string

    Unique name for the image builder.

    The following arguments are optional:

    Tags map[string]string

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    VpcConfig ImageBuilderVpcConfigArgs

    Configuration block for the VPC configuration for the image builder. See below.

    instanceType String

    Instance type to use when launching the image builder.

    accessEndpoints List<ImageBuilderAccessEndpoint>

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    appstreamAgentVersion String

    Version of the AppStream 2.0 agent to use for this image builder.

    description String

    Description to display.

    displayName String

    Human-readable friendly name for the AppStream image builder.

    domainJoinInfo ImageBuilderDomainJoinInfo

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    enableDefaultInternetAccess Boolean

    Enables or disables default internet access for the image builder.

    iamRoleArn String

    ARN of the IAM role to apply to the image builder.

    imageArn String

    ARN of the public, private, or shared image to use.

    imageName String

    Name of the image used to create the image builder.

    name String

    Unique name for the image builder.

    The following arguments are optional:

    tags Map<String,String>

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    vpcConfig ImageBuilderVpcConfig

    Configuration block for the VPC configuration for the image builder. See below.

    instanceType string

    Instance type to use when launching the image builder.

    accessEndpoints ImageBuilderAccessEndpoint[]

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    appstreamAgentVersion string

    Version of the AppStream 2.0 agent to use for this image builder.

    description string

    Description to display.

    displayName string

    Human-readable friendly name for the AppStream image builder.

    domainJoinInfo ImageBuilderDomainJoinInfo

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    enableDefaultInternetAccess boolean

    Enables or disables default internet access for the image builder.

    iamRoleArn string

    ARN of the IAM role to apply to the image builder.

    imageArn string

    ARN of the public, private, or shared image to use.

    imageName string

    Name of the image used to create the image builder.

    name string

    Unique name for the image builder.

    The following arguments are optional:

    tags {[key: string]: string}

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    vpcConfig ImageBuilderVpcConfig

    Configuration block for the VPC configuration for the image builder. See below.

    instance_type str

    Instance type to use when launching the image builder.

    access_endpoints Sequence[ImageBuilderAccessEndpointArgs]

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    appstream_agent_version str

    Version of the AppStream 2.0 agent to use for this image builder.

    description str

    Description to display.

    display_name str

    Human-readable friendly name for the AppStream image builder.

    domain_join_info ImageBuilderDomainJoinInfoArgs

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    enable_default_internet_access bool

    Enables or disables default internet access for the image builder.

    iam_role_arn str

    ARN of the IAM role to apply to the image builder.

    image_arn str

    ARN of the public, private, or shared image to use.

    image_name str

    Name of the image used to create the image builder.

    name str

    Unique name for the image builder.

    The following arguments are optional:

    tags Mapping[str, str]

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    vpc_config ImageBuilderVpcConfigArgs

    Configuration block for the VPC configuration for the image builder. See below.

    instanceType String

    Instance type to use when launching the image builder.

    accessEndpoints List<Property Map>

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    appstreamAgentVersion String

    Version of the AppStream 2.0 agent to use for this image builder.

    description String

    Description to display.

    displayName String

    Human-readable friendly name for the AppStream image builder.

    domainJoinInfo Property Map

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    enableDefaultInternetAccess Boolean

    Enables or disables default internet access for the image builder.

    iamRoleArn String

    ARN of the IAM role to apply to the image builder.

    imageArn String

    ARN of the public, private, or shared image to use.

    imageName String

    Name of the image used to create the image builder.

    name String

    Unique name for the image builder.

    The following arguments are optional:

    tags Map<String>

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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 ImageBuilder resource produces the following output properties:

    Arn string

    ARN of the appstream image builder.

    CreatedTime string

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    Id string

    The provider-assigned unique ID for this managed resource.

    State string

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    TagsAll Dictionary<string, string>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    ARN of the appstream image builder.

    CreatedTime string

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    Id string

    The provider-assigned unique ID for this managed resource.

    State string

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    TagsAll map[string]string

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    ARN of the appstream image builder.

    createdTime String

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    id String

    The provider-assigned unique ID for this managed resource.

    state String

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    tagsAll Map<String,String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    ARN of the appstream image builder.

    createdTime string

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    id string

    The provider-assigned unique ID for this managed resource.

    state string

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    tagsAll {[key: string]: string}

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    ARN of the appstream image builder.

    created_time str

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    id str

    The provider-assigned unique ID for this managed resource.

    state str

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    tags_all Mapping[str, str]

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    ARN of the appstream image builder.

    createdTime String

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    id String

    The provider-assigned unique ID for this managed resource.

    state String

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    tagsAll Map<String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Look up Existing ImageBuilder Resource

    Get an existing ImageBuilder 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?: ImageBuilderState, opts?: CustomResourceOptions): ImageBuilder
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_endpoints: Optional[Sequence[ImageBuilderAccessEndpointArgs]] = None,
        appstream_agent_version: Optional[str] = None,
        arn: Optional[str] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        domain_join_info: Optional[ImageBuilderDomainJoinInfoArgs] = None,
        enable_default_internet_access: Optional[bool] = None,
        iam_role_arn: Optional[str] = None,
        image_arn: Optional[str] = None,
        image_name: Optional[str] = None,
        instance_type: Optional[str] = None,
        name: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_config: Optional[ImageBuilderVpcConfigArgs] = None) -> ImageBuilder
    func GetImageBuilder(ctx *Context, name string, id IDInput, state *ImageBuilderState, opts ...ResourceOption) (*ImageBuilder, error)
    public static ImageBuilder Get(string name, Input<string> id, ImageBuilderState? state, CustomResourceOptions? opts = null)
    public static ImageBuilder get(String name, Output<String> id, ImageBuilderState 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:
    AccessEndpoints List<ImageBuilderAccessEndpoint>

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    AppstreamAgentVersion string

    Version of the AppStream 2.0 agent to use for this image builder.

    Arn string

    ARN of the appstream image builder.

    CreatedTime string

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    Description string

    Description to display.

    DisplayName string

    Human-readable friendly name for the AppStream image builder.

    DomainJoinInfo ImageBuilderDomainJoinInfo

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    EnableDefaultInternetAccess bool

    Enables or disables default internet access for the image builder.

    IamRoleArn string

    ARN of the IAM role to apply to the image builder.

    ImageArn string

    ARN of the public, private, or shared image to use.

    ImageName string

    Name of the image used to create the image builder.

    InstanceType string

    Instance type to use when launching the image builder.

    Name string

    Unique name for the image builder.

    The following arguments are optional:

    State string

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    Tags Dictionary<string, string>

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    VpcConfig ImageBuilderVpcConfig

    Configuration block for the VPC configuration for the image builder. See below.

    AccessEndpoints []ImageBuilderAccessEndpointArgs

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    AppstreamAgentVersion string

    Version of the AppStream 2.0 agent to use for this image builder.

    Arn string

    ARN of the appstream image builder.

    CreatedTime string

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    Description string

    Description to display.

    DisplayName string

    Human-readable friendly name for the AppStream image builder.

    DomainJoinInfo ImageBuilderDomainJoinInfoArgs

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    EnableDefaultInternetAccess bool

    Enables or disables default internet access for the image builder.

    IamRoleArn string

    ARN of the IAM role to apply to the image builder.

    ImageArn string

    ARN of the public, private, or shared image to use.

    ImageName string

    Name of the image used to create the image builder.

    InstanceType string

    Instance type to use when launching the image builder.

    Name string

    Unique name for the image builder.

    The following arguments are optional:

    State string

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    Tags map[string]string

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    VpcConfig ImageBuilderVpcConfigArgs

    Configuration block for the VPC configuration for the image builder. See below.

    accessEndpoints List<ImageBuilderAccessEndpoint>

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    appstreamAgentVersion String

    Version of the AppStream 2.0 agent to use for this image builder.

    arn String

    ARN of the appstream image builder.

    createdTime String

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    description String

    Description to display.

    displayName String

    Human-readable friendly name for the AppStream image builder.

    domainJoinInfo ImageBuilderDomainJoinInfo

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    enableDefaultInternetAccess Boolean

    Enables or disables default internet access for the image builder.

    iamRoleArn String

    ARN of the IAM role to apply to the image builder.

    imageArn String

    ARN of the public, private, or shared image to use.

    imageName String

    Name of the image used to create the image builder.

    instanceType String

    Instance type to use when launching the image builder.

    name String

    Unique name for the image builder.

    The following arguments are optional:

    state String

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    tags Map<String,String>

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    vpcConfig ImageBuilderVpcConfig

    Configuration block for the VPC configuration for the image builder. See below.

    accessEndpoints ImageBuilderAccessEndpoint[]

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    appstreamAgentVersion string

    Version of the AppStream 2.0 agent to use for this image builder.

    arn string

    ARN of the appstream image builder.

    createdTime string

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    description string

    Description to display.

    displayName string

    Human-readable friendly name for the AppStream image builder.

    domainJoinInfo ImageBuilderDomainJoinInfo

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    enableDefaultInternetAccess boolean

    Enables or disables default internet access for the image builder.

    iamRoleArn string

    ARN of the IAM role to apply to the image builder.

    imageArn string

    ARN of the public, private, or shared image to use.

    imageName string

    Name of the image used to create the image builder.

    instanceType string

    Instance type to use when launching the image builder.

    name string

    Unique name for the image builder.

    The following arguments are optional:

    state string

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    tags {[key: string]: string}

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    vpcConfig ImageBuilderVpcConfig

    Configuration block for the VPC configuration for the image builder. See below.

    access_endpoints Sequence[ImageBuilderAccessEndpointArgs]

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    appstream_agent_version str

    Version of the AppStream 2.0 agent to use for this image builder.

    arn str

    ARN of the appstream image builder.

    created_time str

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    description str

    Description to display.

    display_name str

    Human-readable friendly name for the AppStream image builder.

    domain_join_info ImageBuilderDomainJoinInfoArgs

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    enable_default_internet_access bool

    Enables or disables default internet access for the image builder.

    iam_role_arn str

    ARN of the IAM role to apply to the image builder.

    image_arn str

    ARN of the public, private, or shared image to use.

    image_name str

    Name of the image used to create the image builder.

    instance_type str

    Instance type to use when launching the image builder.

    name str

    Unique name for the image builder.

    The following arguments are optional:

    state str

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    tags Mapping[str, str]

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    vpc_config ImageBuilderVpcConfigArgs

    Configuration block for the VPC configuration for the image builder. See below.

    accessEndpoints List<Property Map>

    Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.

    appstreamAgentVersion String

    Version of the AppStream 2.0 agent to use for this image builder.

    arn String

    ARN of the appstream image builder.

    createdTime String

    Date and time, in UTC and extended RFC 3339 format, when the image builder was created.

    description String

    Description to display.

    displayName String

    Human-readable friendly name for the AppStream image builder.

    domainJoinInfo Property Map

    Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.

    enableDefaultInternetAccess Boolean

    Enables or disables default internet access for the image builder.

    iamRoleArn String

    ARN of the IAM role to apply to the image builder.

    imageArn String

    ARN of the public, private, or shared image to use.

    imageName String

    Name of the image used to create the image builder.

    instanceType String

    Instance type to use when launching the image builder.

    name String

    Unique name for the image builder.

    The following arguments are optional:

    state String

    State of the image builder. Can be: PENDING, UPDATING_AGENT, RUNNING, STOPPING, STOPPED, REBOOTING, SNAPSHOTTING, DELETING, FAILED, UPDATING, PENDING_QUALIFICATION

    tags Map<String>

    Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    vpcConfig Property Map

    Configuration block for the VPC configuration for the image builder. See below.

    Supporting Types

    ImageBuilderAccessEndpoint, ImageBuilderAccessEndpointArgs

    EndpointType string

    Type of interface endpoint.

    VpceId string

    Identifier (ID) of the VPC in which the interface endpoint is used.

    EndpointType string

    Type of interface endpoint.

    VpceId string

    Identifier (ID) of the VPC in which the interface endpoint is used.

    endpointType String

    Type of interface endpoint.

    vpceId String

    Identifier (ID) of the VPC in which the interface endpoint is used.

    endpointType string

    Type of interface endpoint.

    vpceId string

    Identifier (ID) of the VPC in which the interface endpoint is used.

    endpoint_type str

    Type of interface endpoint.

    vpce_id str

    Identifier (ID) of the VPC in which the interface endpoint is used.

    endpointType String

    Type of interface endpoint.

    vpceId String

    Identifier (ID) of the VPC in which the interface endpoint is used.

    ImageBuilderDomainJoinInfo, ImageBuilderDomainJoinInfoArgs

    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.

    ImageBuilderVpcConfig, ImageBuilderVpcConfigArgs

    SecurityGroupIds List<string>

    Identifiers of the security groups for the image builder or image builder.

    SubnetIds List<string>

    Identifier of the subnet to which a network interface is attached from the image builder instance.

    SecurityGroupIds []string

    Identifiers of the security groups for the image builder or image builder.

    SubnetIds []string

    Identifier of the subnet to which a network interface is attached from the image builder instance.

    securityGroupIds List<String>

    Identifiers of the security groups for the image builder or image builder.

    subnetIds List<String>

    Identifier of the subnet to which a network interface is attached from the image builder instance.

    securityGroupIds string[]

    Identifiers of the security groups for the image builder or image builder.

    subnetIds string[]

    Identifier of the subnet to which a network interface is attached from the image builder instance.

    security_group_ids Sequence[str]

    Identifiers of the security groups for the image builder or image builder.

    subnet_ids Sequence[str]

    Identifier of the subnet to which a network interface is attached from the image builder instance.

    securityGroupIds List<String>

    Identifiers of the security groups for the image builder or image builder.

    subnetIds List<String>

    Identifier of the subnet to which a network interface is attached from the image builder instance.

    Import

    Using pulumi import, import aws_appstream_image_builder using the name. For example:

     $ pulumi import aws:appstream/imageBuilder:ImageBuilder example imageBuilderExample

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.12.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-aws