1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::import_image::_import_image_output::ImportImageOutputBuilder;
pub use crate::operation::import_image::_import_image_input::ImportImageInputBuilder;
/// Fluent builder constructing a request to `ImportImage`.
///
/// <note>
/// <p>To import your virtual machines (VMs) with a console-based experience, you can use the <i>Import virtual machine images to Amazon Web Services</i> template in the <a href="https://console.aws.amazon.com/migrationhub/orchestrator">Migration Hub Orchestrator console</a>. For more information, see the <a href="https://docs.aws.amazon.com/migrationhub-orchestrator/latest/userguide/import-vm-images.html"> <i>Migration Hub Orchestrator User Guide</i> </a>.</p>
/// </note>
/// <p>Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).</p> <important>
/// <p>Amazon Web Services VM Import/Export strongly recommends specifying a value for either the <code>--license-type</code> or <code>--usage-operation</code> parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.</p>
/// </important>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html">Importing a VM as an image using VM Import/Export</a> in the <i>VM Import/Export User Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ImportImageFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::import_image::builders::ImportImageInputBuilder,
}
impl ImportImageFluentBuilder {
/// Creates a new `ImportImage`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::import_image::ImportImage,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::operation::import_image::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::client::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::operation::import_image::ImportImageOutput,
aws_smithy_http::result::SdkError<crate::operation::import_image::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
}
/// <p>The architecture of the virtual machine.</p>
/// <p>Valid values: <code>i386</code> | <code>x86_64</code> </p>
pub fn architecture(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.architecture(input.into());
self
}
/// <p>The architecture of the virtual machine.</p>
/// <p>Valid values: <code>i386</code> | <code>x86_64</code> </p>
pub fn set_architecture(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_architecture(input);
self
}
/// <p>The client-specific data.</p>
pub fn client_data(mut self, input: crate::types::ClientData) -> Self {
self.inner = self.inner.client_data(input);
self
}
/// <p>The client-specific data.</p>
pub fn set_client_data(mut self, input: std::option::Option<crate::types::ClientData>) -> Self {
self.inner = self.inner.set_client_data(input);
self
}
/// <p>The token to enable idempotency for VM import requests.</p>
pub fn client_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_token(input.into());
self
}
/// <p>The token to enable idempotency for VM import requests.</p>
pub fn set_client_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_token(input);
self
}
/// <p>A description string for the import image task.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A description string for the import image task.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// Appends an item to `DiskContainers`.
///
/// To override the contents of this collection use [`set_disk_containers`](Self::set_disk_containers).
///
/// <p>Information about the disk containers.</p>
pub fn disk_containers(mut self, input: crate::types::ImageDiskContainer) -> Self {
self.inner = self.inner.disk_containers(input);
self
}
/// <p>Information about the disk containers.</p>
pub fn set_disk_containers(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::ImageDiskContainer>>,
) -> Self {
self.inner = self.inner.set_disk_containers(input);
self
}
/// <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn dry_run(mut self, input: bool) -> Self {
self.inner = self.inner.dry_run(input);
self
}
/// <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn set_dry_run(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_dry_run(input);
self
}
/// <p>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 <code>KmsKeyId</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub fn encrypted(mut self, input: bool) -> Self {
self.inner = self.inner.encrypted(input);
self
}
/// <p>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 <code>KmsKeyId</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub fn set_encrypted(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_encrypted(input);
self
}
/// <p>The target hypervisor platform.</p>
/// <p>Valid values: <code>xen</code> </p>
pub fn hypervisor(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.hypervisor(input.into());
self
}
/// <p>The target hypervisor platform.</p>
/// <p>Valid values: <code>xen</code> </p>
pub fn set_hypervisor(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_hypervisor(input);
self
}
/// <p>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 <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set. </p>
/// <p>The KMS key identifier may be provided in any of the following formats: </p>
/// <ul>
/// <li> <p>Key ID</p> </li>
/// <li> <p>Key alias. The alias ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>alias</code> namespace, and then the key alias. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:alias/<i>ExampleAlias</i>.</p> </li>
/// <li> <p>ARN using key ID. The ID ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>key</code> namespace, and then the key ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>.</p> </li>
/// <li> <p>ARN using key alias. The alias ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>alias</code> namespace, and then the key alias. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:alias/<i>ExampleAlias</i>. </p> </li>
/// </ul>
/// <p>Amazon Web Services parses <code>KmsKeyId</code> asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. </p>
/// <p>The specified KMS key must exist in the Region that the AMI is being copied to.</p>
/// <p>Amazon EBS does not support asymmetric KMS keys.</p>
pub fn kms_key_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.kms_key_id(input.into());
self
}
/// <p>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 <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set. </p>
/// <p>The KMS key identifier may be provided in any of the following formats: </p>
/// <ul>
/// <li> <p>Key ID</p> </li>
/// <li> <p>Key alias. The alias ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>alias</code> namespace, and then the key alias. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:alias/<i>ExampleAlias</i>.</p> </li>
/// <li> <p>ARN using key ID. The ID ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>key</code> namespace, and then the key ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>.</p> </li>
/// <li> <p>ARN using key alias. The alias ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>alias</code> namespace, and then the key alias. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:alias/<i>ExampleAlias</i>. </p> </li>
/// </ul>
/// <p>Amazon Web Services parses <code>KmsKeyId</code> asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. </p>
/// <p>The specified KMS key must exist in the Region that the AMI is being copied to.</p>
/// <p>Amazon EBS does not support asymmetric KMS keys.</p>
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
}
/// <p>The license type to be used for the Amazon Machine Image (AMI) after importing.</p>
/// <p>Specify <code>AWS</code> to replace the source-system license with an Amazon Web Services license or <code>BYOL</code> to retain the source-system license. Leaving this parameter undefined is the same as choosing <code>AWS</code> when importing a Windows Server operating system, and the same as choosing <code>BYOL</code> when importing a Windows client operating system (such as Windows 10) or a Linux operating system.</p>
/// <p>To use <code>BYOL</code>, 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 <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html#prerequisites-image">Prerequisites</a> in the VM Import/Export User Guide.</p>
pub fn license_type(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.license_type(input.into());
self
}
/// <p>The license type to be used for the Amazon Machine Image (AMI) after importing.</p>
/// <p>Specify <code>AWS</code> to replace the source-system license with an Amazon Web Services license or <code>BYOL</code> to retain the source-system license. Leaving this parameter undefined is the same as choosing <code>AWS</code> when importing a Windows Server operating system, and the same as choosing <code>BYOL</code> when importing a Windows client operating system (such as Windows 10) or a Linux operating system.</p>
/// <p>To use <code>BYOL</code>, 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 <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html#prerequisites-image">Prerequisites</a> in the VM Import/Export User Guide.</p>
pub fn set_license_type(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_license_type(input);
self
}
/// <p>The operating system of the virtual machine.</p>
/// <p>Valid values: <code>Windows</code> | <code>Linux</code> </p>
pub fn platform(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.platform(input.into());
self
}
/// <p>The operating system of the virtual machine.</p>
/// <p>Valid values: <code>Windows</code> | <code>Linux</code> </p>
pub fn set_platform(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_platform(input);
self
}
/// <p>The name of the role to use when not using the default role, 'vmimport'.</p>
pub fn role_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.role_name(input.into());
self
}
/// <p>The name of the role to use when not using the default role, 'vmimport'.</p>
pub fn set_role_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_role_name(input);
self
}
/// Appends an item to `LicenseSpecifications`.
///
/// To override the contents of this collection use [`set_license_specifications`](Self::set_license_specifications).
///
/// <p>The ARNs of the license configurations.</p>
pub fn license_specifications(
mut self,
input: crate::types::ImportImageLicenseConfigurationRequest,
) -> Self {
self.inner = self.inner.license_specifications(input);
self
}
/// <p>The ARNs of the license configurations.</p>
pub fn set_license_specifications(
mut self,
input: std::option::Option<
std::vec::Vec<crate::types::ImportImageLicenseConfigurationRequest>,
>,
) -> Self {
self.inner = self.inner.set_license_specifications(input);
self
}
/// Appends an item to `TagSpecifications`.
///
/// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
///
/// <p>The tags to apply to the import image task during creation.</p>
pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
self.inner = self.inner.tag_specifications(input);
self
}
/// <p>The tags to apply to the import image task during creation.</p>
pub fn set_tag_specifications(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::TagSpecification>>,
) -> Self {
self.inner = self.inner.set_tag_specifications(input);
self
}
/// <p>The usage operation value. For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#prerequisites">Licensing options</a> in the <i>VM Import/Export User Guide</i>.</p>
pub fn usage_operation(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.usage_operation(input.into());
self
}
/// <p>The usage operation value. For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#prerequisites">Licensing options</a> in the <i>VM Import/Export User Guide</i>.</p>
pub fn set_usage_operation(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_usage_operation(input);
self
}
/// <p>The boot mode of the virtual machine.</p>
pub fn boot_mode(mut self, input: crate::types::BootModeValues) -> Self {
self.inner = self.inner.boot_mode(input);
self
}
/// <p>The boot mode of the virtual machine.</p>
pub fn set_boot_mode(
mut self,
input: std::option::Option<crate::types::BootModeValues>,
) -> Self {
self.inner = self.inner.set_boot_mode(input);
self
}
}