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.

Container for the parameters to the CreateImageBuilder operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AppStream.AmazonAppStreamRequest
      Amazon.AppStream.Model.CreateImageBuilderRequest

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

Syntax

C#
public class CreateImageBuilderRequest : AmazonAppStreamRequest
         IAmazonWebServiceRequest

The CreateImageBuilderRequest type exposes the following members

Constructors

NameDescription
Public Method CreateImageBuilderRequest()

Properties

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

Gets and sets the property AccessEndpoints.

The list of interface VPC endpoint (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 to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

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 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. 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 public, private, or shared image to use.

Public Property ImageName System.String

Gets and sets the property ImageName.

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

Public Property InstanceType System.String

Gets and sets the property InstanceType.

The instance type to use when launching 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.

A unique name for the image builder.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property 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 AppStream 2.0 Administration Guide.

Public Property VpcConfig Amazon.AppStream.Model.VpcConfig

Gets and sets the property VpcConfig.

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

Version Information

.NET Standard:
Supported in: 1.3

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

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