Skip to content

Creates an image builder

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.

Usage

appstream_create_image_builder(Name, ImageName, ImageArn, InstanceType,
  Description, DisplayName, VpcConfig, IamRoleArn,
  EnableDefaultInternetAccess, DomainJoinInfo, AppstreamAgentVersion,
  Tags, AccessEndpoints, RootVolumeConfig, SoftwaresToInstall,
  SoftwaresToUninstall, DisableIMDSV1)

Arguments

  • Name

    [required] A unique name for the image builder.

  • ImageName

    The name of the image used to create the image builder.

  • ImageArn

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

  • InstanceType

    [required] 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

  • Description

    The description to display.

  • DisplayName

    The image builder name to display.

  • VpcConfig

    The VPC configuration for the image builder. You can specify only one subnet.

  • IamRoleArn

    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.

  • EnableDefaultInternetAccess

    Enables or disables default internet access for the image builder.

  • DomainJoinInfo

    The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

  • AppstreamAgentVersion

    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].

  • Tags

    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.

  • AccessEndpoints

    The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

  • RootVolumeConfig

    The configuration for the root volume of the image builder. Use this to customize storage capacity from 200 GB up to 500 GB based on your application installation requirements.

  • SoftwaresToInstall

    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

  • SoftwaresToUninstall

    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

  • DisableIMDSV1

    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.

Value

A list with the following syntax:

list(
  ImageBuilder = list(
    Name = "string",
    Arn = "string",
    ImageArn = "string",
    Description = "string",
    DisplayName = "string",
    VpcConfig = list(
      SubnetIds = list(
        "string"
      ),
      SecurityGroupIds = list(
        "string"
      )
    ),
    InstanceType = "string",
    Platform = "WINDOWS"|"WINDOWS_SERVER_2016"|"WINDOWS_SERVER_2019"|"WINDOWS_SERVER_2022"|"WINDOWS_SERVER_2025"|"AMAZON_LINUX2"|"RHEL8"|"ROCKY_LINUX8"|"UBUNTU_PRO_2404",
    IamRoleArn = "string",
    State = "PENDING"|"UPDATING_AGENT"|"RUNNING"|"STOPPING"|"STOPPED"|"REBOOTING"|"SNAPSHOTTING"|"DELETING"|"FAILED"|"UPDATING"|"PENDING_QUALIFICATION"|"PENDING_SYNCING_APPS"|"SYNCING_APPS"|"PENDING_IMAGE_IMPORT",
    StateChangeReason = list(
      Code = "INTERNAL_ERROR"|"IMAGE_UNAVAILABLE",
      Message = "string"
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    EnableDefaultInternetAccess = TRUE|FALSE,
    DomainJoinInfo = list(
      DirectoryName = "string",
      OrganizationalUnitDistinguishedName = "string"
    ),
    NetworkAccessConfiguration = list(
      EniPrivateIpAddress = "string",
      EniIpv6Addresses = list(
        "string"
      ),
      EniId = "string"
    ),
    ImageBuilderErrors = list(
      list(
        ErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION"|"IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION"|"IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION"|"NETWORK_INTERFACE_LIMIT_EXCEEDED"|"INTERNAL_SERVICE_ERROR"|"IAM_SERVICE_ROLE_IS_MISSING"|"MACHINE_ROLE_IS_MISSING"|"STS_DISABLED_IN_REGION"|"SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES"|"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION"|"SUBNET_NOT_FOUND"|"IMAGE_NOT_FOUND"|"INVALID_SUBNET_CONFIGURATION"|"SECURITY_GROUPS_NOT_FOUND"|"IGW_NOT_ATTACHED"|"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION"|"FLEET_STOPPED"|"FLEET_INSTANCE_PROVISIONING_FAILURE"|"DOMAIN_JOIN_ERROR_FILE_NOT_FOUND"|"DOMAIN_JOIN_ERROR_ACCESS_DENIED"|"DOMAIN_JOIN_ERROR_LOGON_FAILURE"|"DOMAIN_JOIN_ERROR_INVALID_PARAMETER"|"DOMAIN_JOIN_ERROR_MORE_DATA"|"DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN"|"DOMAIN_JOIN_ERROR_NOT_SUPPORTED"|"DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME"|"DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED"|"DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED"|"DOMAIN_JOIN_NERR_PASSWORD_EXPIRED"|"DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"|"VALIDATION_ERROR",
        ErrorMessage = "string",
        ErrorTimestamp = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    AppstreamAgentVersion = "string",
    AccessEndpoints = list(
      list(
        EndpointType = "STREAMING",
        VpceId = "string"
      )
    ),
    RootVolumeConfig = list(
      VolumeSizeInGb = 123
    ),
    LatestAppstreamAgentVersion = "TRUE"|"FALSE",
    DisableIMDSV1 = TRUE|FALSE
  )
)

Request syntax

svc$create_image_builder(
  Name = "string",
  ImageName = "string",
  ImageArn = "string",
  InstanceType = "string",
  Description = "string",
  DisplayName = "string",
  VpcConfig = list(
    SubnetIds = list(
      "string"
    ),
    SecurityGroupIds = list(
      "string"
    )
  ),
  IamRoleArn = "string",
  EnableDefaultInternetAccess = TRUE|FALSE,
  DomainJoinInfo = list(
    DirectoryName = "string",
    OrganizationalUnitDistinguishedName = "string"
  ),
  AppstreamAgentVersion = "string",
  Tags = list(
    "string"
  ),
  AccessEndpoints = list(
    list(
      EndpointType = "STREAMING",
      VpceId = "string"
    )
  ),
  RootVolumeConfig = list(
    VolumeSizeInGb = 123
  ),
  SoftwaresToInstall = list(
    "string"
  ),
  SoftwaresToUninstall = list(
    "string"
  ),
  DisableIMDSV1 = TRUE|FALSE
)