Struct aws_sdk_appstream::client::fluent_builders::CreateImageBuilder

pub struct CreateImageBuilder<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to CreateImageBuilder.

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.

Implementations

impl<C, M, R> CreateImageBuilder<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateImageBuilderOutput, SdkError<CreateImageBuilderError>> where
    R::Policy: SmithyRetryPolicy<CreateImageBuilderInputOperationOutputAlias, CreateImageBuilderOutput, CreateImageBuilderError, CreateImageBuilderInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

A unique name for the image builder.

pub fn set_name(self, input: Option<String>) -> Self

A unique name for the image builder.

pub fn image_name(self, input: impl Into<String>) -> Self

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

pub fn set_image_name(self, input: Option<String>) -> Self

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

pub fn image_arn(self, input: impl Into<String>) -> Self

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

pub fn set_image_arn(self, input: Option<String>) -> Self

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

pub fn instance_type(self, input: impl Into<String>) -> Self

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

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• 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-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

pub fn set_instance_type(self, input: Option<String>) -> Self

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

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• 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-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

pub fn description(self, input: impl Into<String>) -> Self

The description to display.

pub fn set_description(self, input: Option<String>) -> Self

The description to display.

pub fn display_name(self, input: impl Into<String>) -> Self

The image builder name to display.

pub fn set_display_name(self, input: Option<String>) -> Self

The image builder name to display.

pub fn vpc_config(self, input: VpcConfig) -> Self

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

pub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self

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

pub fn iam_role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_iam_role_arn(self, input: Option<String>) -> Self

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.

pub fn enable_default_internet_access(self, input: bool) -> Self

Enables or disables default internet access for the image builder.

pub fn set_enable_default_internet_access(self, input: Option<bool>) -> Self

Enables or disables default internet access for the image builder.

pub fn domain_join_info(self, input: DomainJoinInfo) -> Self

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

pub fn set_domain_join_info(self, input: Option<DomainJoinInfo>) -> Self

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

pub fn appstream_agent_version(self, input: impl Into<String>) -> Self

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

pub fn set_appstream_agent_version(self, input: Option<String>) -> Self

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

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Tags.

To override the contents of this collection use set_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.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

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.

pub fn access_endpoints(self, input: AccessEndpoint) -> Self

Appends an item to AccessEndpoints.

To override the contents of this collection use set_access_endpoints.

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

pub fn set_access_endpoints(self, input: Option<Vec<AccessEndpoint>>) -> Self

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

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for CreateImageBuilder<C, M, R>

fn clone(&self) -> CreateImageBuilder<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for CreateImageBuilder<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.