Struct aws_sdk_appstream::input::create_image_builder_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateImageBuilderInput.

Implementations

impl Builder

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

A unique name for the image builder.

Examples found in repository

src/client.rs (line 2648)

        pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.name(input.into());
            self
        }

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

A unique name for the image builder.

Examples found in repository

src/client.rs (line 2653)

        pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_name(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2658)

        pub fn image_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.image_name(input.into());
            self
        }

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

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

Examples found in repository

src/client.rs (line 2663)

        pub fn set_image_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_image_name(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2668)

        pub fn image_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.image_arn(input.into());
            self
        }

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

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

Examples found in repository

src/client.rs (line 2673)

        pub fn set_image_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_image_arn(input);
            self
        }

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

Examples found in repository

src/client.rs (line 2713)

        pub fn instance_type(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.instance_type(input.into());
            self
        }

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

Examples found in repository

src/client.rs (line 2756)

        pub fn set_instance_type(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_instance_type(input);
            self
        }

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

The description to display.

Examples found in repository

src/client.rs (line 2761)

        pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.description(input.into());
            self
        }

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

The description to display.

Examples found in repository

src/client.rs (line 2766)

        pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_description(input);
            self
        }

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

The image builder name to display.

Examples found in repository

src/client.rs (line 2771)

        pub fn display_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.display_name(input.into());
            self
        }

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

The image builder name to display.

Examples found in repository

src/client.rs (line 2776)

        pub fn set_display_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_display_name(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2781)

        pub fn vpc_config(mut self, input: crate::model::VpcConfig) -> Self {
            self.inner = self.inner.vpc_config(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2789)

        pub fn set_vpc_config(
            mut self,
            input: std::option::Option<crate::model::VpcConfig>,
        ) -> Self {
            self.inner = self.inner.set_vpc_config(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2795)

        pub fn iam_role_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.iam_role_arn(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 2801)

        pub fn set_iam_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_iam_role_arn(input);
            self
        }

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

Enables or disables default internet access for the image builder.

Examples found in repository

src/client.rs (line 2806)

        pub fn enable_default_internet_access(mut self, input: bool) -> Self {
            self.inner = self.inner.enable_default_internet_access(input);
            self
        }

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

Enables or disables default internet access for the image builder.

Examples found in repository

src/client.rs (line 2814)

        pub fn set_enable_default_internet_access(
            mut self,
            input: std::option::Option<bool>,
        ) -> Self {
            self.inner = self.inner.set_enable_default_internet_access(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2819)

        pub fn domain_join_info(mut self, input: crate::model::DomainJoinInfo) -> Self {
            self.inner = self.inner.domain_join_info(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2827)

        pub fn set_domain_join_info(
            mut self,
            input: std::option::Option<crate::model::DomainJoinInfo>,
        ) -> Self {
            self.inner = self.inner.set_domain_join_info(input);
            self
        }

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

Examples found in repository

src/client.rs (line 2832)

        pub fn appstream_agent_version(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.appstream_agent_version(input.into());
            self
        }

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

Examples found in repository

src/client.rs (line 2840)

        pub fn set_appstream_agent_version(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_appstream_agent_version(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2857)

        pub fn tags(
            mut self,
            k: impl Into<std::string::String>,
            v: impl Into<std::string::String>,
        ) -> Self {
            self.inner = self.inner.tags(k.into(), v.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 2871)

        pub fn set_tags(
            mut self,
            input: std::option::Option<
                std::collections::HashMap<std::string::String, std::string::String>,
            >,
        ) -> Self {
            self.inner = self.inner.set_tags(input);
            self
        }

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

Appends an item to access_endpoints.

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.

Examples found in repository

src/client.rs (line 2880)

        pub fn access_endpoints(mut self, input: crate::model::AccessEndpoint) -> Self {
            self.inner = self.inner.access_endpoints(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2888)

        pub fn set_access_endpoints(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::AccessEndpoint>>,
        ) -> Self {
            self.inner = self.inner.set_access_endpoints(input);
            self
        }

pub fn build(self) -> Result<CreateImageBuilderInput, BuildError>

Consumes the builder and constructs a CreateImageBuilderInput.

Examples found in repository

src/client.rs (line 2615)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateImageBuilder,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateImageBuilderError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateImageBuilderOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateImageBuilderError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder