AWS SDK Version 3 for .NET
API 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.

Describes a virtual machine that is used to create an image.

Inheritance Hierarchy

System.Object
  Amazon.AppStream.Model.ImageBuilder

Namespace: Amazon.AppStream.Model
Assembly: AWSSDK.AppStream.dll
Version: 3.x.y.z

Syntax

C#
public class ImageBuilder

The ImageBuilder type exposes the following members

Constructors

NameDescription
Public Method ImageBuilder()

Properties

NameTypeDescription
Public Property AccessEndpoints System.Collections.Generic.List<Amazon.AppStream.Model.AccessEndpoint>

Gets and sets the property AccessEndpoints.

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

Public Property AppstreamAgentVersion System.String

Gets and sets the property AppstreamAgentVersion.

The version of the AppStream 2.0 agent that is currently being used by the image builder.

Public Property Arn System.String

Gets and sets the property Arn.

The ARN for the image builder.

Public Property CreatedTime System.DateTime

Gets and sets the property CreatedTime.

The time stamp when the image builder was created.

Public Property Description System.String

Gets and sets the property Description.

The description to display.

Public Property DisplayName System.String

Gets and sets the property DisplayName.

The image builder name to display.

Public Property DomainJoinInfo Amazon.AppStream.Model.DomainJoinInfo

Gets and sets the property DomainJoinInfo.

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

Public Property EnableDefaultInternetAccess System.Boolean

Gets and sets the property EnableDefaultInternetAccess.

Enables or disables default internet access for the image builder.

Public Property IamRoleArn System.String

Gets and sets the property IamRoleArn.

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 (STS) 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.

Public Property ImageArn System.String

Gets and sets the property ImageArn.

The ARN of the image from which this builder was created.

Public Property ImageBuilderErrors System.Collections.Generic.List<Amazon.AppStream.Model.ResourceError>

Gets and sets the property ImageBuilderErrors.

The image builder errors.

Public Property InstanceType System.String

Gets and sets the property InstanceType.

The instance type for the image builder. The following instance types are available:

  • 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.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

Public Property Name System.String

Gets and sets the property Name.

The name of the image builder.

Public Property NetworkAccessConfiguration Amazon.AppStream.Model.NetworkAccessConfiguration

Gets and sets the property NetworkAccessConfiguration.

Public Property Platform Amazon.AppStream.PlatformType

Gets and sets the property Platform.

The operating system platform of the image builder.

Public Property State Amazon.AppStream.ImageBuilderState

Gets and sets the property State.

The state of the image builder.

Public Property StateChangeReason Amazon.AppStream.Model.ImageBuilderStateChangeReason

Gets and sets the property StateChangeReason.

The reason why the last state change occurred.

Public Property VpcConfig Amazon.AppStream.Model.VpcConfig

Gets and sets the property VpcConfig.

The VPC configuration of the image builder.

Version Information

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms