Struct aws_sdk_ec2::input::import_image_input::Builder

pub struct Builder { /* private fields */ }

A builder for ImportImageInput.

Implementations

impl Builder

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

The architecture of the virtual machine.

Valid values: i386 | x86_64

Examples found in repository

src/client.rs (line 61736)

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

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

The architecture of the virtual machine.

Valid values: i386 | x86_64

Examples found in repository

src/client.rs (line 61742)

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

pub fn client_data(self, input: ClientData) -> Self

The client-specific data.

Examples found in repository

src/client.rs (line 61747)

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

pub fn set_client_data(self, input: Option<ClientData>) -> Self

The client-specific data.

Examples found in repository

src/client.rs (line 61755)

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

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

The token to enable idempotency for VM import requests.

Examples found in repository

src/client.rs (line 61760)

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

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

The token to enable idempotency for VM import requests.

Examples found in repository

src/client.rs (line 61765)

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

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

A description string for the import image task.

Examples found in repository

src/client.rs (line 61770)

        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

A description string for the import image task.

Examples found in repository

src/client.rs (line 61775)

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

pub fn disk_containers(self, input: ImageDiskContainer) -> Self

Appends an item to disk_containers.

To override the contents of this collection use set_disk_containers.

Information about the disk containers.

Examples found in repository

src/client.rs (line 61784)

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

pub fn set_disk_containers(self, input: Option<Vec<ImageDiskContainer>>) -> Self

Information about the disk containers.

Examples found in repository

src/client.rs (line 61792)

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

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

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Examples found in repository

src/client.rs (line 61797)

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

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

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Examples found in repository

src/client.rs (line 61802)

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

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

Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Examples found in repository

src/client.rs (line 61807)

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

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

Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Examples found in repository

src/client.rs (line 61812)

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

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

The target hypervisor platform.

Valid values: xen

Examples found in repository

src/client.rs (line 61818)

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

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

The target hypervisor platform.

Valid values: xen

Examples found in repository

src/client.rs (line 61824)

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

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

An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The KMS key identifier may be provided in any of the following formats:

• Key ID

• Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

• ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

• ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified KMS key must exist in the Region that the AMI is being copied to.

Amazon EBS does not support asymmetric KMS keys.

Examples found in repository

src/client.rs (line 61839)

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

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

An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The KMS key identifier may be provided in any of the following formats:

• Key ID

• Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

• ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

• ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified KMS key must exist in the Region that the AMI is being copied to.

Amazon EBS does not support asymmetric KMS keys.

Examples found in repository

src/client.rs (line 61854)

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

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

The license type to be used for the Amazon Machine Image (AMI) after importing.

Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.

Examples found in repository

src/client.rs (line 61861)

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

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

The license type to be used for the Amazon Machine Image (AMI) after importing.

Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.

Examples found in repository

src/client.rs (line 61868)

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

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

The operating system of the virtual machine.

Valid values: Windows | Linux

Examples found in repository

src/client.rs (line 61874)

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

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

The operating system of the virtual machine.

Valid values: Windows | Linux

Examples found in repository

src/client.rs (line 61880)

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

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

The name of the role to use when not using the default role, 'vmimport'.

Examples found in repository

src/client.rs (line 61885)

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

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

The name of the role to use when not using the default role, 'vmimport'.

Examples found in repository

src/client.rs (line 61890)

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

pub fn license_specifications(
    self,
    input: ImportImageLicenseConfigurationRequest
) -> Self

Appends an item to license_specifications.

To override the contents of this collection use set_license_specifications.

The ARNs of the license configurations.

Examples found in repository

src/client.rs (line 61902)

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

pub fn set_license_specifications(
    self,
    input: Option<Vec<ImportImageLicenseConfigurationRequest>>
) -> Self

The ARNs of the license configurations.

Examples found in repository

src/client.rs (line 61912)

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

pub fn tag_specifications(self, input: TagSpecification) -> Self

Appends an item to tag_specifications.

To override the contents of this collection use set_tag_specifications.

The tags to apply to the import image task during creation.

Examples found in repository

src/client.rs (line 61921)

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

pub fn set_tag_specifications(self, input: Option<Vec<TagSpecification>>) -> Self

The tags to apply to the import image task during creation.

Examples found in repository

src/client.rs (line 61929)

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

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

The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.

Examples found in repository

src/client.rs (line 61934)

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

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

The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.

Examples found in repository

src/client.rs (line 61942)

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

pub fn boot_mode(self, input: BootModeValues) -> Self

The boot mode of the virtual machine.

Examples found in repository

src/client.rs (line 61947)

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

pub fn set_boot_mode(self, input: Option<BootModeValues>) -> Self

The boot mode of the virtual machine.

Examples found in repository

src/client.rs (line 61955)

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

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

Consumes the builder and constructs a ImportImageInput.

Examples found in repository

src/client.rs (line 61702)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::ImportImage,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::ImportImageError>,
        > {
            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::ImportImageOutput,
            aws_smithy_http::result::SdkError<crate::error::ImportImageError>,
        > {
            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