We recommend new projects start with resources from the AWS provider.
aws-native.appstream.ImageBuilder
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::AppStream::ImageBuilder
Create ImageBuilder Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ImageBuilder(name: string, args: ImageBuilderArgs, opts?: CustomResourceOptions);
@overload
def ImageBuilder(resource_name: str,
args: ImageBuilderArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ImageBuilder(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_type: Optional[str] = None,
display_name: Optional[str] = None,
description: Optional[str] = None,
access_endpoints: Optional[Sequence[ImageBuilderAccessEndpointArgs]] = 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,
appstream_agent_version: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
vpc_config: Optional[ImageBuilderVpcConfigArgs] = 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-native:appstream:ImageBuilder
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 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ImageBuilder resource accepts the following input properties:
- Instance
Type 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
- Access
Endpoints List<Pulumi.Aws Native. App Stream. Inputs. Image Builder Access Endpoint> - The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
- Appstream
Agent stringVersion - 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.
- Display
Name string - The image builder name to display.
- Domain
Join Pulumi.Info Aws Native. App Stream. Inputs. Image Builder Domain Join Info - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
- Enable
Default boolInternet Access - Enables or disables default internet access for the image builder.
- Iam
Role stringArn 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 string - The ARN of the public, private, or shared image to use.
- Image
Name string - The name of the image used to create the image builder.
- Name string
- A unique name for the image builder.
- List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs.
- Vpc
Config Pulumi.Aws Native. App Stream. Inputs. Image Builder Vpc Config - The VPC configuration for the image builder. You can specify only one subnet.
- Instance
Type 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
- Access
Endpoints []ImageBuilder Access Endpoint Args - The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
- Appstream
Agent stringVersion - 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.
- Display
Name string - The image builder name to display.
- Domain
Join ImageInfo Builder Domain Join Info Args - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
- Enable
Default boolInternet Access - Enables or disables default internet access for the image builder.
- Iam
Role stringArn 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 string - The ARN of the public, private, or shared image to use.
- Image
Name string - The name of the image used to create the image builder.
- Name string
- A unique name for the image builder.
- Tag
Args - An array of key-value pairs.
- Vpc
Config ImageBuilder Vpc Config Args - The VPC configuration for the image builder. You can specify only one subnet.
- instance
Type 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
- access
Endpoints List<ImageBuilder Access Endpoint> - The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
- appstream
Agent StringVersion - 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.
- display
Name String - The image builder name to display.
- domain
Join ImageInfo Builder Domain Join Info - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
- enable
Default BooleanInternet Access - Enables or disables default internet access for the image builder.
- iam
Role StringArn 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 String - The ARN of the public, private, or shared image to use.
- image
Name String - The name of the image used to create the image builder.
- name String
- A unique name for the image builder.
- List<Tag>
- An array of key-value pairs.
- vpc
Config ImageBuilder Vpc Config - The VPC configuration for the image builder. You can specify only one subnet.
- instance
Type 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
- access
Endpoints ImageBuilder Access Endpoint[] - The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
- appstream
Agent stringVersion - 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.
- display
Name string - The image builder name to display.
- domain
Join ImageInfo Builder Domain Join Info - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
- enable
Default booleanInternet Access - Enables or disables default internet access for the image builder.
- iam
Role stringArn 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 string - The ARN of the public, private, or shared image to use.
- image
Name string - The name of the image used to create the image builder.
- name string
- A unique name for the image builder.
- Tag[]
- An array of key-value pairs.
- vpc
Config ImageBuilder Vpc Config - The VPC configuration for the image builder. You can specify only one subnet.
- 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
- access_
endpoints Sequence[ImageBuilder Access Endpoint Args] - The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
- appstream_
agent_ strversion - 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_ Imageinfo Builder Domain Join Info Args - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
- enable_
default_ boolinternet_ access - Enables or disables default internet access for the image builder.
- iam_
role_ strarn 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.
- name str
- A unique name for the image builder.
- Sequence[Tag
Args] - An array of key-value pairs.
- vpc_
config ImageBuilder Vpc Config Args - The VPC configuration for the image builder. You can specify only one subnet.
- instance
Type 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
- access
Endpoints 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.
- appstream
Agent StringVersion - 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.
- display
Name String - The image builder name to display.
- domain
Join Property MapInfo - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
- enable
Default BooleanInternet Access - Enables or disables default internet access for the image builder.
- iam
Role StringArn 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 String - The ARN of the public, private, or shared image to use.
- image
Name String - The name of the image used to create the image builder.
- name String
- A unique name for the image builder.
- List<Property Map>
- An array of key-value pairs.
- vpc
Config Property Map - The VPC configuration for the image builder. You can specify only one subnet.
Outputs
All input properties are implicitly available as output properties. Additionally, the ImageBuilder resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Streaming
Url string - The URL to start an image builder streaming session, returned as a string.
- Id string
- The provider-assigned unique ID for this managed resource.
- Streaming
Url string - The URL to start an image builder streaming session, returned as a string.
- id String
- The provider-assigned unique ID for this managed resource.
- streaming
Url String - The URL to start an image builder streaming session, returned as a string.
- id string
- The provider-assigned unique ID for this managed resource.
- streaming
Url string - The URL to start an image builder streaming session, returned as a string.
- id str
- The provider-assigned unique ID for this managed resource.
- streaming_
url str - The URL to start an image builder streaming session, returned as a string.
- id String
- The provider-assigned unique ID for this managed resource.
- streaming
Url String - The URL to start an image builder streaming session, returned as a string.
Supporting Types
ImageBuilderAccessEndpoint, ImageBuilderAccessEndpointArgs
- Endpoint
Type string - The type of interface endpoint.
- Vpce
Id string - The identifier (ID) of the VPC in which the interface endpoint is used.
- Endpoint
Type string - The type of interface endpoint.
- Vpce
Id string - The identifier (ID) of the VPC in which the interface endpoint is used.
- endpoint
Type String - The type of interface endpoint.
- vpce
Id String - The identifier (ID) of the VPC in which the interface endpoint is used.
- endpoint
Type string - The type of interface endpoint.
- vpce
Id string - The identifier (ID) of the VPC in which the interface endpoint is used.
- endpoint_
type str - The type of interface endpoint.
- vpce_
id str - The identifier (ID) of the VPC in which the interface endpoint is used.
- endpoint
Type String - The type of interface endpoint.
- vpce
Id String - The identifier (ID) of the VPC in which the interface endpoint is used.
ImageBuilderDomainJoinInfo, ImageBuilderDomainJoinInfoArgs
- Directory
Name string - The fully qualified name of the directory (for example, corp.example.com).
- Organizational
Unit stringDistinguished Name - The distinguished name of the organizational unit for computer accounts.
- Directory
Name string - The fully qualified name of the directory (for example, corp.example.com).
- Organizational
Unit stringDistinguished Name - The distinguished name of the organizational unit for computer accounts.
- directory
Name String - The fully qualified name of the directory (for example, corp.example.com).
- organizational
Unit StringDistinguished Name - The distinguished name of the organizational unit for computer accounts.
- directory
Name string - The fully qualified name of the directory (for example, corp.example.com).
- organizational
Unit stringDistinguished Name - 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_ strdistinguished_ name - The distinguished name of the organizational unit for computer accounts.
- directory
Name String - The fully qualified name of the directory (for example, corp.example.com).
- organizational
Unit StringDistinguished Name - The distinguished name of the organizational unit for computer accounts.
ImageBuilderVpcConfig, ImageBuilderVpcConfigArgs
- Security
Group List<string>Ids - The identifiers of the security groups for the image builder.
- Subnet
Ids 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.
- Security
Group []stringIds - The identifiers of the security groups for the image builder.
- Subnet
Ids []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 List<String>Ids - The identifiers of the security groups for the image builder.
- subnet
Ids 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.
- security
Group string[]Ids - The identifiers of the security groups for the image builder.
- subnet
Ids 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_ Sequence[str]ids - 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.
- security
Group List<String>Ids - The identifiers of the security groups for the image builder.
- subnet
Ids 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, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.