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
The ImageBuilder resource accepts the following input properties:
- 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
 
- AccessEndpoints 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.
- AppstreamAgent 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.
- DisplayName string
- The image builder name to display.
- DomainJoin 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.
- EnableDefault boolInternet Access 
- Enables or disables default internet access for the image builder.
- IamRole 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 - AssumeRoleAPI 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.
- Name string
- A unique name for the image builder.
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- An array of key-value pairs.
- VpcConfig Pulumi.Aws Native. App Stream. Inputs. Image Builder Vpc Config 
- The VPC configuration for the image builder. You can specify only one subnet.
- 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
 
- AccessEndpoints []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.
- AppstreamAgent 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.
- DisplayName string
- The image builder name to display.
- DomainJoin 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.
- EnableDefault boolInternet Access 
- Enables or disables default internet access for the image builder.
- IamRole 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 - AssumeRoleAPI 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.
- Name string
- A unique name for the image builder.
- 
TagArgs 
- An array of key-value pairs.
- VpcConfig ImageBuilder Vpc Config Args 
- The VPC configuration for the image builder. You can specify only one subnet.
- 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
 
- accessEndpoints 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.
- appstreamAgent 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.
- displayName String
- The image builder name to display.
- domainJoin 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.
- enableDefault BooleanInternet Access 
- Enables or disables default internet access for the image builder.
- iamRole 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 - AssumeRoleAPI 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.
- name String
- A unique name for the image builder.
- List<Tag>
- An array of key-value pairs.
- vpcConfig ImageBuilder Vpc Config 
- The VPC configuration for the image builder. You can specify only one subnet.
- 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
 
- accessEndpoints 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.
- appstreamAgent 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.
- displayName string
- The image builder name to display.
- domainJoin 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.
- enableDefault booleanInternet Access 
- Enables or disables default internet access for the image builder.
- iamRole 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 - AssumeRoleAPI 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.
- name string
- A unique name for the image builder.
- Tag[]
- An array of key-value pairs.
- vpcConfig 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 - AssumeRoleAPI 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[TagArgs] 
- 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.
- 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
 
- 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.
- appstreamAgent 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.
- displayName String
- The image builder name to display.
- domainJoin Property MapInfo 
- The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
- enableDefault BooleanInternet Access 
- Enables or disables default internet access for the image builder.
- iamRole 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 - AssumeRoleAPI 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.
- name String
- A unique name for the image builder.
- 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.
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.
- StreamingUrl 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.
- StreamingUrl 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.
- streamingUrl 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.
- streamingUrl 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.
- streamingUrl String
- The URL to start an image builder streaming session, returned as a string.
Supporting Types
ImageBuilderAccessEndpoint, ImageBuilderAccessEndpointArgs        
- EndpointType string
- The type of interface endpoint.
- VpceId string
- The identifier (ID) of the VPC in which the interface endpoint is used.
- EndpointType string
- The type of interface endpoint.
- VpceId string
- The identifier (ID) of the VPC in which the interface endpoint is used.
- endpointType String
- The type of interface endpoint.
- vpceId String
- The identifier (ID) of the VPC in which the interface endpoint is used.
- endpointType string
- The type of interface endpoint.
- vpceId 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.
- endpointType String
- The type of interface endpoint.
- vpceId String
- The identifier (ID) of the VPC in which the interface endpoint is used.
ImageBuilderDomainJoinInfo, ImageBuilderDomainJoinInfoArgs          
- DirectoryName string
- The fully qualified name of the directory (for example, corp.example.com).
- OrganizationalUnit stringDistinguished Name 
- The distinguished name of the organizational unit for computer accounts.
- DirectoryName string
- The fully qualified name of the directory (for example, corp.example.com).
- OrganizationalUnit stringDistinguished Name 
- The distinguished name of the organizational unit for computer accounts.
- directoryName String
- The fully qualified name of the directory (for example, corp.example.com).
- organizationalUnit StringDistinguished Name 
- The distinguished name of the organizational unit for computer accounts.
- directoryName string
- The fully qualified name of the directory (for example, corp.example.com).
- organizationalUnit 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.
- directoryName String
- The fully qualified name of the directory (for example, corp.example.com).
- organizationalUnit StringDistinguished Name 
- The distinguished name of the organizational unit for computer accounts.
ImageBuilderVpcConfig, ImageBuilderVpcConfigArgs        
- SecurityGroup List<string>Ids 
- 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.
- SecurityGroup []stringIds 
- 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.
- securityGroup List<String>Ids 
- 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.
- securityGroup string[]Ids 
- 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_ 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.
- securityGroup List<String>Ids 
- 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, 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.