aws_appstream_image

account_id

Type: STRING

applications

Type: UNORDERED_LIST_STRUCT
Provider name: Applications
Description: The applications associated with the image.

  • app_block_arn
    Type: STRING
    Provider name: AppBlockArn
    Description: The app block ARN of the application.
  • arn
    Type: STRING
    Provider name: Arn
    Description: The ARN of the application.
  • created_time
    Type: TIMESTAMP
    Provider name: CreatedTime
    Description: The time at which the application was created within the app block.
  • description
    Type: STRING
    Provider name: Description
    Description: The description of the application.
  • enabled
    Type: BOOLEAN
    Provider name: Enabled
    Description: If there is a problem, the application can be disabled after image creation.
  • icon_s3_location
    Type: STRUCT
    Provider name: IconS3Location
    Description: The S3 location of the application icon.
    • s3_bucket
      Type: STRING
      Provider name: S3Bucket
      Description: The S3 bucket of the S3 object.
    • s3_key
      Type: STRING
      Provider name: S3Key
      Description: The S3 key of the S3 object. This is required when used for the following:
      • IconS3Location (Actions: CreateApplication and UpdateApplication)
      • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
      • ScriptDetails (Actions: CreateAppBlock)
      • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
      • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)
  • icon_url
    Type: STRING
    Provider name: IconURL
    Description: The URL for the application icon. This URL might be time-limited.
  • instance_families
    Type: UNORDERED_LIST_STRING
    Provider name: InstanceFamilies
    Description: The instance families for the application.
  • launch_parameters
    Type: STRING
    Provider name: LaunchParameters
    Description: The arguments that are passed to the application at launch.
  • launch_path
    Type: STRING
    Provider name: LaunchPath
    Description: The path to the application executable in the instance.
  • metadata
    Type: MAP_STRING_STRING
    Provider name: Metadata
    Description: Additional attributes that describe the application.
  • name
    Type: STRING
    Provider name: Name
    Description: The name of the application.
  • platforms
    Type: UNORDERED_LIST_STRING
    Provider name: Platforms
    Description: The platforms on which the application can run.
  • working_directory
    Type: STRING
    Provider name: WorkingDirectory
    Description: The working directory for the application.

appstream_agent_version

Type: STRING
Provider name: AppstreamAgentVersion
Description: The version of the AppStream 2.0 agent to use for instances that are launched from this image.

arn

Type: STRING
Provider name: Arn
Description: The ARN of the image.

base_image_arn

Type: STRING
Provider name: BaseImageArn
Description: The ARN of the image from which this image was created.

created_time

Type: TIMESTAMP
Provider name: CreatedTime
Description: The time the image was created.

description

Type: STRING
Provider name: Description
Description: The description to display.

dynamic_app_providers_enabled

Type: STRING
Provider name: DynamicAppProvidersEnabled
Description: Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.

image_builder_name

Type: STRING
Provider name: ImageBuilderName
Description: The name of the image builder that was used to create the private image. If the image is shared, this value is null.

image_builder_supported

Type: BOOLEAN
Provider name: ImageBuilderSupported
Description: Indicates whether an image builder can be launched from this image.

image_errors

Type: UNORDERED_LIST_STRUCT
Provider name: ImageErrors
Description: Describes the errors that are returned when a new image can’t be created.

  • error_code
    Type: STRING
    Provider name: ErrorCode
    Description: The error code.
  • error_message
    Type: STRING
    Provider name: ErrorMessage
    Description: The error message.
  • error_timestamp
    Type: TIMESTAMP
    Provider name: ErrorTimestamp
    Description: The time the error occurred.

image_permissions

Type: STRUCT
Provider name: ImagePermissions
Description: The permissions to provide to the destination AWS account for the specified image.

  • allow_fleet
    Type: BOOLEAN
    Provider name: allowFleet
    Description: Indicates whether the image can be used for a fleet.
  • allow_image_builder
    Type: BOOLEAN
    Provider name: allowImageBuilder
    Description: Indicates whether the image can be used for an image builder.

image_shared_with_others

Type: STRING
Provider name: ImageSharedWithOthers
Description: Indicates whether the image is shared with another account ID.

latest_appstream_agent_version

Type: STRING
Provider name: LatestAppstreamAgentVersion
Description: Indicates whether the image is using the latest AppStream 2.0 agent version or not.

name

Type: STRING
Provider name: Name
Description: The name of the image.

platform

Type: STRING
Provider name: Platform
Description: The operating system platform of the image.

public_base_image_released_date

Type: TIMESTAMP
Provider name: PublicBaseImageReleasedDate
Description: The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

state

Type: STRING
Provider name: State
Description: The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

state_change_reason

Type: STRUCT
Provider name: StateChangeReason
Description: The reason why the last state change occurred.

  • code
    Type: STRING
    Provider name: Code
    Description: The state change reason code.
  • message
    Type: STRING
    Provider name: Message
    Description: The state change reason message.

supported_instance_families

Type: UNORDERED_LIST_STRING
Provider name: SupportedInstanceFamilies
Description: The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:

  • General Purpose
  • Compute Optimized
  • Memory Optimized
  • Graphics
  • Graphics Design
  • Graphics Pro
  • Graphics G4
  • Graphics G5

tags

Type: UNORDERED_LIST_STRING

visibility

Type: STRING
Provider name: Visibility
Description: Indicates whether the image is public or private.