AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon AppStream CreateImageBuilder API operation.

Syntax

New-APSImageBuilder
-ImageName <String>
-AccessEndpoint <AccessEndpoint[]>
-AppstreamAgentVersion <String>
-Description <String>
-DomainJoinInfo_DirectoryName <String>
-DisableIMDSV1 <Boolean>
-DisplayName <String>
-EnableDefaultInternetAccess <Boolean>
-IamRoleArn <String>
-ImageArn <String>
-InstanceType <String>
-Name <String>
-DomainJoinInfo_OrganizationalUnitDistinguishedName <String>
-VpcConfig_SecurityGroupId <String[]>
-SoftwaresToInstall <String[]>
-SoftwaresToUninstall <String[]>
-VpcConfig_SubnetId <String[]>
-Tag <Hashtable>
-RootVolumeConfig_VolumeSizeInGb <Int32>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonAppStreamConfig>

Description

Creates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

Parameters

-AccessEndpoint <AccessEndpoint[]>
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccessEndpoints
-AppstreamAgentVersion <String>
The version of the WorkSpaces Applications agent to use for this image builder. To use the latest version of the WorkSpaces Applications agent, specify [LATEST].
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonAppStreamConfig>
Amazon.PowerShell.Cmdlets.APS.AmazonAppStreamClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description to display.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisableIMDSV1 <Boolean>
Set to true to disable Instance Metadata Service Version 1 (IMDSv1) and enforce IMDSv2. Set to false to enable both IMDSv1 and IMDSv2.Before disabling IMDSv1, ensure your WorkSpaces Applications images are running the agent version or managed image update released on or after January 16, 2024 to support IMDSv2 enforcement.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisplayName <String>
The image builder name to display.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainJoinInfo_DirectoryName <String>
The fully qualified name of the directory (for example, corp.example.com).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainJoinInfo_OrganizationalUnitDistinguishedName <String>
The distinguished name of the organizational unit for computer accounts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableDefaultInternetAccess <Boolean>
Enables or disables default internet access for the image builder.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IamRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageArn <String>
The ARN of the public, private, or shared image to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageName <String>
The name of the image used to create the image builder.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-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.g4dn.xlarge
  • stream.graphics.g4dn.2xlarge
  • stream.graphics.g4dn.4xlarge
  • stream.graphics.g4dn.8xlarge
  • stream.graphics.g4dn.12xlarge
  • stream.graphics.g4dn.16xlarge
  • stream.graphics.g5.xlarge
  • stream.graphics.g5.2xlarge
  • stream.graphics.g5.4xlarge
  • stream.graphics.g5.8xlarge
  • stream.graphics.g5.16xlarge
  • stream.graphics.g5.12xlarge
  • stream.graphics.g5.24xlarge
  • stream.graphics.g6.xlarge
  • stream.graphics.g6.2xlarge
  • stream.graphics.g6.4xlarge
  • stream.graphics.g6.8xlarge
  • stream.graphics.g6.16xlarge
  • stream.graphics.g6.12xlarge
  • stream.graphics.g6.24xlarge
  • stream.graphics.gr6.4xlarge
  • stream.graphics.gr6.8xlarge
  • stream.graphics.g6f.large
  • stream.graphics.g6f.xlarge
  • stream.graphics.g6f.2xlarge
  • stream.graphics.g6f.4xlarge
  • stream.graphics.gr6f.4xlarge
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
A unique name for the image builder.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RootVolumeConfig_VolumeSizeInGb <Int32>
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ImageBuilder'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppStream.Model.CreateImageBuilderResponse). Specifying the name of a property of type Amazon.AppStream.Model.CreateImageBuilderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SoftwaresToInstall <String[]>
The list of license included applications to install on the image builder during creation.Possible values include the following:
  • Microsoft_Office_2021_LTSC_Professional_Plus_32Bit
  • Microsoft_Office_2021_LTSC_Professional_Plus_64Bit
  • Microsoft_Office_2024_LTSC_Professional_Plus_32Bit
  • Microsoft_Office_2024_LTSC_Professional_Plus_64Bit
  • Microsoft_Visio_2021_LTSC_Professional_32Bit
  • Microsoft_Visio_2021_LTSC_Professional_64Bit
  • Microsoft_Visio_2024_LTSC_Professional_32Bit
  • Microsoft_Visio_2024_LTSC_Professional_64Bit
  • Microsoft_Project_2021_Professional_32Bit
  • Microsoft_Project_2021_Professional_64Bit
  • Microsoft_Project_2024_Professional_32Bit
  • Microsoft_Project_2024_Professional_64Bit
  • Microsoft_Office_2021_LTSC_Standard_32Bit
  • Microsoft_Office_2021_LTSC_Standard_64Bit
  • Microsoft_Office_2024_LTSC_Standard_32Bit
  • Microsoft_Office_2024_LTSC_Standard_64Bit
  • Microsoft_Visio_2021_LTSC_Standard_32Bit
  • Microsoft_Visio_2021_LTSC_Standard_64Bit
  • Microsoft_Visio_2024_LTSC_Standard_32Bit
  • Microsoft_Visio_2024_LTSC_Standard_64Bit
  • Microsoft_Project_2021_Standard_32Bit
  • Microsoft_Project_2021_Standard_64Bit
  • Microsoft_Project_2024_Standard_32Bit
  • Microsoft_Project_2024_Standard_64Bit
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SoftwaresToUninstall <String[]>
The list of license included applications to uninstall from the image builder during creation.Possible values include the following:
  • Microsoft_Office_2021_LTSC_Professional_Plus_32Bit
  • Microsoft_Office_2021_LTSC_Professional_Plus_64Bit
  • Microsoft_Office_2024_LTSC_Professional_Plus_32Bit
  • Microsoft_Office_2024_LTSC_Professional_Plus_64Bit
  • Microsoft_Visio_2021_LTSC_Professional_32Bit
  • Microsoft_Visio_2021_LTSC_Professional_64Bit
  • Microsoft_Visio_2024_LTSC_Professional_32Bit
  • Microsoft_Visio_2024_LTSC_Professional_64Bit
  • Microsoft_Project_2021_Professional_32Bit
  • Microsoft_Project_2021_Professional_64Bit
  • Microsoft_Project_2024_Professional_32Bit
  • Microsoft_Project_2024_Professional_64Bit
  • Microsoft_Office_2021_LTSC_Standard_32Bit
  • Microsoft_Office_2021_LTSC_Standard_64Bit
  • Microsoft_Office_2024_LTSC_Standard_32Bit
  • Microsoft_Office_2024_LTSC_Standard_64Bit
  • Microsoft_Visio_2021_LTSC_Standard_32Bit
  • Microsoft_Visio_2021_LTSC_Standard_64Bit
  • Microsoft_Visio_2024_LTSC_Standard_32Bit
  • Microsoft_Visio_2024_LTSC_Standard_64Bit
  • Microsoft_Project_2021_Standard_32Bit
  • Microsoft_Project_2021_Standard_64Bit
  • Microsoft_Project_2024_Standard_32Bit
  • Microsoft_Project_2024_Standard_64Bit
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @If you do not specify a value, the value is set to an empty string.For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcConfig_SecurityGroupId <String[]>
The identifiers of the security groups for the fleet or image builder. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfig_SecurityGroupIds
-VpcConfig_SubnetId <String[]>
The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfig_SubnetIds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.AppStream.Model.ImageBuilder or Amazon.AppStream.Model.CreateImageBuilderResponse
This cmdlet returns an Amazon.AppStream.Model.ImageBuilder object. The service call response (type Amazon.AppStream.Model.CreateImageBuilderResponse) can be returned by specifying '-Select *'.

Examples

Example 1

New-APSImageBuilder -InstanceType stream.standard.medium -Name TestIB -DisplayName TestIB -ImageName AppStream-WinServer2012R2-12-12-2019 -EnableDefaultInternetAccess $True -VpcConfig_SubnetId subnet-a1234cfd -VpcConfig_SecurityGroupIds sg-2d012a34 -Region us-west-2

AccessEndpoints             : {}
AppstreamAgentVersion       : 12-16-2019
Arn                         : arn:aws:appstream:us-west-2:123456789012:image-builder/TestIB
CreatedTime                 : 12/27/2019 11:39:24 AM
Description                 :
DisplayName                 : TestIB
DomainJoinInfo              :
EnableDefaultInternetAccess : True
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-west-2::image/AppStream-WinServer2012R2-12-12-2019
ImageBuilderErrors          : {}
InstanceType                : stream.standard.medium
Name                        : TestIB
NetworkAccessConfiguration  :
Platform                    : WINDOWS
State                       : PENDING
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig
This sample creates an Image Builder in AppStream
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z