Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. appstream
  5. getImageBuilder

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.appstream.getImageBuilder

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::AppStream::ImageBuilder

Using getImageBuilder

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getImageBuilder(args: GetImageBuilderArgs, opts?: InvokeOptions): Promise<GetImageBuilderResult>
function getImageBuilderOutput(args: GetImageBuilderOutputArgs, opts?: InvokeOptions): Output<GetImageBuilderResult>
Copy
def get_image_builder(name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetImageBuilderResult
def get_image_builder_output(name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetImageBuilderResult]
Copy
func LookupImageBuilder(ctx *Context, args *LookupImageBuilderArgs, opts ...InvokeOption) (*LookupImageBuilderResult, error)
func LookupImageBuilderOutput(ctx *Context, args *LookupImageBuilderOutputArgs, opts ...InvokeOption) LookupImageBuilderResultOutput
Copy

> Note: This function is named LookupImageBuilder in the Go SDK.

public static class GetImageBuilder 
{
    public static Task<GetImageBuilderResult> InvokeAsync(GetImageBuilderArgs args, InvokeOptions? opts = null)
    public static Output<GetImageBuilderResult> Invoke(GetImageBuilderInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetImageBuilderResult> getImageBuilder(GetImageBuilderArgs args, InvokeOptions options)
public static Output<GetImageBuilderResult> getImageBuilder(GetImageBuilderArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:appstream:getImageBuilder
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
A unique name for the image builder.
Name This property is required. string
A unique name for the image builder.
name This property is required. String
A unique name for the image builder.
name This property is required. string
A unique name for the image builder.
name This property is required. str
A unique name for the image builder.
name This property is required. String
A unique name for the image builder.

getImageBuilder Result

The following output properties are available:

AccessEndpoints List<Pulumi.AwsNative.AppStream.Outputs.ImageBuilderAccessEndpoint>
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
AppstreamAgentVersion string
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
Description string
The description to display.
DisplayName string
The image builder name to display.
DomainJoinInfo Pulumi.AwsNative.AppStream.Outputs.ImageBuilderDomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
EnableDefaultInternetAccess bool
Enables or disables default internet access for the image builder.
IamRoleArn string

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

ImageArn string
The ARN of the public, private, or shared image to use.
ImageName string
The name of the image used to create the image builder.
InstanceType string
The instance type to use when launching the image builder. The following instance types are available:

  • stream.standard.small
  • stream.standard.medium
  • stream.standard.large
  • stream.compute.large
  • stream.compute.xlarge
  • stream.compute.2xlarge
  • stream.compute.4xlarge
  • stream.compute.8xlarge
  • stream.memory.large
  • stream.memory.xlarge
  • stream.memory.2xlarge
  • stream.memory.4xlarge
  • stream.memory.8xlarge
  • stream.memory.z1d.large
  • stream.memory.z1d.xlarge
  • stream.memory.z1d.2xlarge
  • stream.memory.z1d.3xlarge
  • stream.memory.z1d.6xlarge
  • stream.memory.z1d.12xlarge
  • stream.graphics-design.large
  • stream.graphics-design.xlarge
  • stream.graphics-design.2xlarge
  • stream.graphics-design.4xlarge
  • stream.graphics-desktop.2xlarge
  • stream.graphics.g4dn.xlarge
  • stream.graphics.g4dn.2xlarge
  • stream.graphics.g4dn.4xlarge
  • stream.graphics.g4dn.8xlarge
  • stream.graphics.g4dn.12xlarge
  • stream.graphics.g4dn.16xlarge
  • stream.graphics-pro.4xlarge
  • stream.graphics-pro.8xlarge
  • stream.graphics-pro.16xlarge
Name string
A unique name for the image builder.
StreamingUrl string
The URL to start an image builder streaming session, returned as a string.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs.
VpcConfig Pulumi.AwsNative.AppStream.Outputs.ImageBuilderVpcConfig
The VPC configuration for the image builder. You can specify only one subnet.
AccessEndpoints []ImageBuilderAccessEndpoint
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
AppstreamAgentVersion string
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
Description string
The description to display.
DisplayName string
The image builder name to display.
DomainJoinInfo ImageBuilderDomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
EnableDefaultInternetAccess bool
Enables or disables default internet access for the image builder.
IamRoleArn string

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

ImageArn string
The ARN of the public, private, or shared image to use.
ImageName string
The name of the image used to create the image builder.
InstanceType string
The instance type to use when launching the image builder. The following instance types are available:

  • stream.standard.small
  • stream.standard.medium
  • stream.standard.large
  • stream.compute.large
  • stream.compute.xlarge
  • stream.compute.2xlarge
  • stream.compute.4xlarge
  • stream.compute.8xlarge
  • stream.memory.large
  • stream.memory.xlarge
  • stream.memory.2xlarge
  • stream.memory.4xlarge
  • stream.memory.8xlarge
  • stream.memory.z1d.large
  • stream.memory.z1d.xlarge
  • stream.memory.z1d.2xlarge
  • stream.memory.z1d.3xlarge
  • stream.memory.z1d.6xlarge
  • stream.memory.z1d.12xlarge
  • stream.graphics-design.large
  • stream.graphics-design.xlarge
  • stream.graphics-design.2xlarge
  • stream.graphics-design.4xlarge
  • stream.graphics-desktop.2xlarge
  • stream.graphics.g4dn.xlarge
  • stream.graphics.g4dn.2xlarge
  • stream.graphics.g4dn.4xlarge
  • stream.graphics.g4dn.8xlarge
  • stream.graphics.g4dn.12xlarge
  • stream.graphics.g4dn.16xlarge
  • stream.graphics-pro.4xlarge
  • stream.graphics-pro.8xlarge
  • stream.graphics-pro.16xlarge
Name string
A unique name for the image builder.
StreamingUrl string
The URL to start an image builder streaming session, returned as a string.
Tags Tag
An array of key-value pairs.
VpcConfig ImageBuilderVpcConfig
The VPC configuration for the image builder. You can specify only one subnet.
accessEndpoints List<ImageBuilderAccessEndpoint>
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
appstreamAgentVersion String
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
description String
The description to display.
displayName String
The image builder name to display.
domainJoinInfo ImageBuilderDomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
enableDefaultInternetAccess Boolean
Enables or disables default internet access for the image builder.
iamRoleArn String

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

imageArn String
The ARN of the public, private, or shared image to use.
imageName String
The name of the image used to create the image builder.
instanceType String
The instance type to use when launching the image builder. The following instance types are available:

  • stream.standard.small
  • stream.standard.medium
  • stream.standard.large
  • stream.compute.large
  • stream.compute.xlarge
  • stream.compute.2xlarge
  • stream.compute.4xlarge
  • stream.compute.8xlarge
  • stream.memory.large
  • stream.memory.xlarge
  • stream.memory.2xlarge
  • stream.memory.4xlarge
  • stream.memory.8xlarge
  • stream.memory.z1d.large
  • stream.memory.z1d.xlarge
  • stream.memory.z1d.2xlarge
  • stream.memory.z1d.3xlarge
  • stream.memory.z1d.6xlarge
  • stream.memory.z1d.12xlarge
  • stream.graphics-design.large
  • stream.graphics-design.xlarge
  • stream.graphics-design.2xlarge
  • stream.graphics-design.4xlarge
  • stream.graphics-desktop.2xlarge
  • stream.graphics.g4dn.xlarge
  • stream.graphics.g4dn.2xlarge
  • stream.graphics.g4dn.4xlarge
  • stream.graphics.g4dn.8xlarge
  • stream.graphics.g4dn.12xlarge
  • stream.graphics.g4dn.16xlarge
  • stream.graphics-pro.4xlarge
  • stream.graphics-pro.8xlarge
  • stream.graphics-pro.16xlarge
name String
A unique name for the image builder.
streamingUrl String
The URL to start an image builder streaming session, returned as a string.
tags List<Tag>
An array of key-value pairs.
vpcConfig ImageBuilderVpcConfig
The VPC configuration for the image builder. You can specify only one subnet.
accessEndpoints ImageBuilderAccessEndpoint[]
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
appstreamAgentVersion string
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
description string
The description to display.
displayName string
The image builder name to display.
domainJoinInfo ImageBuilderDomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
enableDefaultInternetAccess boolean
Enables or disables default internet access for the image builder.
iamRoleArn string

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

imageArn string
The ARN of the public, private, or shared image to use.
imageName string
The name of the image used to create the image builder.
instanceType string
The instance type to use when launching the image builder. The following instance types are available:

  • stream.standard.small
  • stream.standard.medium
  • stream.standard.large
  • stream.compute.large
  • stream.compute.xlarge
  • stream.compute.2xlarge
  • stream.compute.4xlarge
  • stream.compute.8xlarge
  • stream.memory.large
  • stream.memory.xlarge
  • stream.memory.2xlarge
  • stream.memory.4xlarge
  • stream.memory.8xlarge
  • stream.memory.z1d.large
  • stream.memory.z1d.xlarge
  • stream.memory.z1d.2xlarge
  • stream.memory.z1d.3xlarge
  • stream.memory.z1d.6xlarge
  • stream.memory.z1d.12xlarge
  • stream.graphics-design.large
  • stream.graphics-design.xlarge
  • stream.graphics-design.2xlarge
  • stream.graphics-design.4xlarge
  • stream.graphics-desktop.2xlarge
  • stream.graphics.g4dn.xlarge
  • stream.graphics.g4dn.2xlarge
  • stream.graphics.g4dn.4xlarge
  • stream.graphics.g4dn.8xlarge
  • stream.graphics.g4dn.12xlarge
  • stream.graphics.g4dn.16xlarge
  • stream.graphics-pro.4xlarge
  • stream.graphics-pro.8xlarge
  • stream.graphics-pro.16xlarge
name string
A unique name for the image builder.
streamingUrl string
The URL to start an image builder streaming session, returned as a string.
tags Tag[]
An array of key-value pairs.
vpcConfig ImageBuilderVpcConfig
The VPC configuration for the image builder. You can specify only one subnet.
access_endpoints Sequence[ImageBuilderAccessEndpoint]
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
appstream_agent_version str
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
description str
The description to display.
display_name str
The image builder name to display.
domain_join_info ImageBuilderDomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
enable_default_internet_access bool
Enables or disables default internet access for the image builder.
iam_role_arn str

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

image_arn str
The ARN of the public, private, or shared image to use.
image_name str
The name of the image used to create the image builder.
instance_type str
The instance type to use when launching the image builder. The following instance types are available:

  • stream.standard.small
  • stream.standard.medium
  • stream.standard.large
  • stream.compute.large
  • stream.compute.xlarge
  • stream.compute.2xlarge
  • stream.compute.4xlarge
  • stream.compute.8xlarge
  • stream.memory.large
  • stream.memory.xlarge
  • stream.memory.2xlarge
  • stream.memory.4xlarge
  • stream.memory.8xlarge
  • stream.memory.z1d.large
  • stream.memory.z1d.xlarge
  • stream.memory.z1d.2xlarge
  • stream.memory.z1d.3xlarge
  • stream.memory.z1d.6xlarge
  • stream.memory.z1d.12xlarge
  • stream.graphics-design.large
  • stream.graphics-design.xlarge
  • stream.graphics-design.2xlarge
  • stream.graphics-design.4xlarge
  • stream.graphics-desktop.2xlarge
  • stream.graphics.g4dn.xlarge
  • stream.graphics.g4dn.2xlarge
  • stream.graphics.g4dn.4xlarge
  • stream.graphics.g4dn.8xlarge
  • stream.graphics.g4dn.12xlarge
  • stream.graphics.g4dn.16xlarge
  • stream.graphics-pro.4xlarge
  • stream.graphics-pro.8xlarge
  • stream.graphics-pro.16xlarge
name str
A unique name for the image builder.
streaming_url str
The URL to start an image builder streaming session, returned as a string.
tags Sequence[root_Tag]
An array of key-value pairs.
vpc_config ImageBuilderVpcConfig
The VPC configuration for the image builder. You can specify only one subnet.
accessEndpoints List<Property Map>
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
appstreamAgentVersion String
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
description String
The description to display.
displayName String
The image builder name to display.
domainJoinInfo Property Map
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
enableDefaultInternetAccess Boolean
Enables or disables default internet access for the image builder.
iamRoleArn String

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

imageArn String
The ARN of the public, private, or shared image to use.
imageName String
The name of the image used to create the image builder.
instanceType String
The instance type to use when launching the image builder. The following instance types are available:

  • stream.standard.small
  • stream.standard.medium
  • stream.standard.large
  • stream.compute.large
  • stream.compute.xlarge
  • stream.compute.2xlarge
  • stream.compute.4xlarge
  • stream.compute.8xlarge
  • stream.memory.large
  • stream.memory.xlarge
  • stream.memory.2xlarge
  • stream.memory.4xlarge
  • stream.memory.8xlarge
  • stream.memory.z1d.large
  • stream.memory.z1d.xlarge
  • stream.memory.z1d.2xlarge
  • stream.memory.z1d.3xlarge
  • stream.memory.z1d.6xlarge
  • stream.memory.z1d.12xlarge
  • stream.graphics-design.large
  • stream.graphics-design.xlarge
  • stream.graphics-design.2xlarge
  • stream.graphics-design.4xlarge
  • stream.graphics-desktop.2xlarge
  • stream.graphics.g4dn.xlarge
  • stream.graphics.g4dn.2xlarge
  • stream.graphics.g4dn.4xlarge
  • stream.graphics.g4dn.8xlarge
  • stream.graphics.g4dn.12xlarge
  • stream.graphics.g4dn.16xlarge
  • stream.graphics-pro.4xlarge
  • stream.graphics-pro.8xlarge
  • stream.graphics-pro.16xlarge
name String
A unique name for the image builder.
streamingUrl String
The URL to start an image builder streaming session, returned as a string.
tags List<Property Map>
An array of key-value pairs.
vpcConfig Property Map
The VPC configuration for the image builder. You can specify only one subnet.

Supporting Types

ImageBuilderAccessEndpoint

EndpointType This property is required. string
The type of interface endpoint.
VpceId This property is required. string
The identifier (ID) of the VPC in which the interface endpoint is used.
EndpointType This property is required. string
The type of interface endpoint.
VpceId This property is required. string
The identifier (ID) of the VPC in which the interface endpoint is used.
endpointType This property is required. String
The type of interface endpoint.
vpceId This property is required. String
The identifier (ID) of the VPC in which the interface endpoint is used.
endpointType This property is required. string
The type of interface endpoint.
vpceId This property is required. string
The identifier (ID) of the VPC in which the interface endpoint is used.
endpoint_type This property is required. str
The type of interface endpoint.
vpce_id This property is required. str
The identifier (ID) of the VPC in which the interface endpoint is used.
endpointType This property is required. String
The type of interface endpoint.
vpceId This property is required. String
The identifier (ID) of the VPC in which the interface endpoint is used.

ImageBuilderDomainJoinInfo

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

ImageBuilderVpcConfig

SecurityGroupIds List<string>
The identifiers of the security groups for the image builder.
SubnetIds List<string>
The identifier of the subnet to which a network interface is attached from the image builder instance. An image builder instance can use one subnet.
SecurityGroupIds []string
The identifiers of the security groups for the image builder.
SubnetIds []string
The identifier of the subnet to which a network interface is attached from the image builder instance. An image builder instance can use one subnet.
securityGroupIds List<String>
The identifiers of the security groups for the image builder.
subnetIds List<String>
The identifier of the subnet to which a network interface is attached from the image builder instance. An image builder instance can use one subnet.
securityGroupIds string[]
The identifiers of the security groups for the image builder.
subnetIds string[]
The identifier of the subnet to which a network interface is attached from the image builder instance. An image builder instance can use one subnet.
security_group_ids Sequence[str]
The identifiers of the security groups for the image builder.
subnet_ids Sequence[str]
The identifier of the subnet to which a network interface is attached from the image builder instance. An image builder instance can use one subnet.
securityGroupIds List<String>
The identifiers of the security groups for the image builder.
subnetIds List<String>
The identifier of the subnet to which a network interface is attached from the image builder instance. An image builder instance can use one subnet.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native