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 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::register_image::_register_image_output::RegisterImageOutputBuilder;
pub use crate::operation::register_image::_register_image_input::RegisterImageInputBuilder;
/// Fluent builder constructing a request to `RegisterImage`.
///
/// <p>Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Create your own AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <note>
/// <p>For Amazon EBS-backed instances, <code>CreateImage</code> creates and registers the AMI in a single request, so you don't have to register the AMI yourself. We recommend that you always use <code>CreateImage</code> unless you have a specific reason to use RegisterImage.</p>
/// </note>
/// <p>If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.</p>
/// <p> <b>Register a snapshot of a root device volume</b> </p>
/// <p>You can use <code>RegisterImage</code> to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#creating-launching-ami-from-snapshot">Create a Linux AMI from a snapshot</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html">Use encryption with Amazon EBS-backed AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
/// <p> <b>Amazon Web Services Marketplace product codes</b> </p>
/// <p>If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.</p>
/// <p>Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:</p>
/// <ol>
/// <li> <p>Launch an instance from an existing AMI with that billing product code.</p> </li>
/// <li> <p>Customize the instance.</p> </li>
/// <li> <p>Create an AMI from the instance using <code>CreateImage</code>.</p> </li>
/// </ol>
/// <p>If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html">Understand AMI billing information</a> in the <i>Amazon EC2 User Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct RegisterImageFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::register_image::builders::RegisterImageInputBuilder,
}
impl RegisterImageFluentBuilder {
/// Creates a new `RegisterImage`.
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::register_image::RegisterImage,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::operation::register_image::RegisterImageError>,
> {
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::register_image::RegisterImageOutput,
aws_smithy_http::result::SdkError<crate::operation::register_image::RegisterImageError>,
> {
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 full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the <code>aws-exec-read</code> canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl">Canned ACLs</a> in the <i>Amazon S3 Service Developer Guide</i>.</p>
pub fn image_location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.image_location(input.into());
self
}
/// <p>The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the <code>aws-exec-read</code> canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl">Canned ACLs</a> in the <i>Amazon S3 Service Developer Guide</i>.</p>
pub fn set_image_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_image_location(input);
self
}
/// <p>The architecture of the AMI.</p>
/// <p>Default: For Amazon EBS-backed AMIs, <code>i386</code>. For instance store-backed AMIs, the architecture specified in the manifest file.</p>
pub fn architecture(mut self, input: crate::types::ArchitectureValues) -> Self {
self.inner = self.inner.architecture(input);
self
}
/// <p>The architecture of the AMI.</p>
/// <p>Default: For Amazon EBS-backed AMIs, <code>i386</code>. For instance store-backed AMIs, the architecture specified in the manifest file.</p>
pub fn set_architecture(
mut self,
input: std::option::Option<crate::types::ArchitectureValues>,
) -> Self {
self.inner = self.inner.set_architecture(input);
self
}
/// Appends an item to `BlockDeviceMappings`.
///
/// To override the contents of this collection use [`set_block_device_mappings`](Self::set_block_device_mappings).
///
/// <p>The block device mapping entries.</p>
/// <p>If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.</p>
/// <p>If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami">Amazon EBS local snapshots on Outposts</a> in the <i>Amazon EC2 User Guide</i>.</p>
pub fn block_device_mappings(mut self, input: crate::types::BlockDeviceMapping) -> Self {
self.inner = self.inner.block_device_mappings(input);
self
}
/// <p>The block device mapping entries.</p>
/// <p>If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.</p>
/// <p>If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami">Amazon EBS local snapshots on Outposts</a> in the <i>Amazon EC2 User Guide</i>.</p>
pub fn set_block_device_mappings(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::BlockDeviceMapping>>,
) -> Self {
self.inner = self.inner.set_block_device_mappings(input);
self
}
/// <p>A description for your AMI.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A description for your AMI.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(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>Set to <code>true</code> to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.</p>
/// <p>This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.</p>
pub fn ena_support(mut self, input: bool) -> Self {
self.inner = self.inner.ena_support(input);
self
}
/// <p>Set to <code>true</code> to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.</p>
/// <p>This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.</p>
pub fn set_ena_support(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_ena_support(input);
self
}
/// <p>The ID of the kernel.</p>
pub fn kernel_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.kernel_id(input.into());
self
}
/// <p>The ID of the kernel.</p>
pub fn set_kernel_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_kernel_id(input);
self
}
/// <p>A name for your AMI.</p>
/// <p>Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A name for your AMI.</p>
/// <p>Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// Appends an item to `BillingProducts`.
///
/// To override the contents of this collection use [`set_billing_products`](Self::set_billing_products).
///
/// <p>The billing product codes. Your account must be authorized to specify billing product codes.</p>
/// <p>If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/user-guide-for-sellers.html">Getting started as a seller</a> and <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/ami-products.html">AMI-based products</a> in the <i>Amazon Web Services Marketplace Seller Guide</i>.</p>
pub fn billing_products(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.billing_products(input.into());
self
}
/// <p>The billing product codes. Your account must be authorized to specify billing product codes.</p>
/// <p>If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/user-guide-for-sellers.html">Getting started as a seller</a> and <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/ami-products.html">AMI-based products</a> in the <i>Amazon Web Services Marketplace Seller Guide</i>.</p>
pub fn set_billing_products(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_billing_products(input);
self
}
/// <p>The ID of the RAM disk.</p>
pub fn ramdisk_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.ramdisk_id(input.into());
self
}
/// <p>The ID of the RAM disk.</p>
pub fn set_ramdisk_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_ramdisk_id(input);
self
}
/// <p>The device name of the root device volume (for example, <code>/dev/sda1</code>).</p>
pub fn root_device_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.root_device_name(input.into());
self
}
/// <p>The device name of the root device volume (for example, <code>/dev/sda1</code>).</p>
pub fn set_root_device_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_root_device_name(input);
self
}
/// <p>Set to <code>simple</code> to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.</p>
/// <p>There is no way to disable <code>sriovNetSupport</code> at this time.</p>
/// <p>This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.</p>
pub fn sriov_net_support(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.sriov_net_support(input.into());
self
}
/// <p>Set to <code>simple</code> to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.</p>
/// <p>There is no way to disable <code>sriovNetSupport</code> at this time.</p>
/// <p>This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.</p>
pub fn set_sriov_net_support(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_sriov_net_support(input);
self
}
/// <p>The type of virtualization (<code>hvm</code> | <code>paravirtual</code>).</p>
/// <p>Default: <code>paravirtual</code> </p>
pub fn virtualization_type(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.virtualization_type(input.into());
self
}
/// <p>The type of virtualization (<code>hvm</code> | <code>paravirtual</code>).</p>
/// <p>Default: <code>paravirtual</code> </p>
pub fn set_virtualization_type(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_virtualization_type(input);
self
}
/// <p>The boot mode of the AMI. A value of <code>uefi-preferred</code> indicates that the AMI supports both UEFI and Legacy BIOS.</p> <note>
/// <p>The operating system contained in the AMI must be configured to support the specified boot mode.</p>
/// </note>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html">Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</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 AMI. A value of <code>uefi-preferred</code> indicates that the AMI supports both UEFI and Legacy BIOS.</p> <note>
/// <p>The operating system contained in the AMI must be configured to support the specified boot mode.</p>
/// </note>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html">Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</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
}
/// <p>Set to <code>v2.0</code> to enable Trusted Platform Module (TPM) support. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html">NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.</p>
pub fn tpm_support(mut self, input: crate::types::TpmSupportValues) -> Self {
self.inner = self.inner.tpm_support(input);
self
}
/// <p>Set to <code>v2.0</code> to enable Trusted Platform Module (TPM) support. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html">NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.</p>
pub fn set_tpm_support(
mut self,
input: std::option::Option<crate::types::TpmSupportValues>,
) -> Self {
self.inner = self.inner.set_tpm_support(input);
self
}
/// <p>Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData">GetInstanceUefiData</a> command. You can inspect and modify the UEFI data by using the <a href="https://github.com/awslabs/python-uefivars">python-uefivars tool</a> on GitHub. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html">UEFI Secure Boot</a> in the <i>Amazon EC2 User Guide</i>.</p>
pub fn uefi_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.uefi_data(input.into());
self
}
/// <p>Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData">GetInstanceUefiData</a> command. You can inspect and modify the UEFI data by using the <a href="https://github.com/awslabs/python-uefivars">python-uefivars tool</a> on GitHub. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html">UEFI Secure Boot</a> in the <i>Amazon EC2 User Guide</i>.</p>
pub fn set_uefi_data(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_uefi_data(input);
self
}
/// <p>Set to <code>v2.0</code> to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have <code>HttpTokens</code> automatically set to <code>required</code> so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, <code>HttpPutResponseHopLimit</code> is set to <code>2</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration">Configure the AMI</a> in the <i>Amazon EC2 User Guide</i>.</p> <note>
/// <p>If you set the value to <code>v2.0</code>, make sure that your AMI software can support IMDSv2.</p>
/// </note>
pub fn imds_support(mut self, input: crate::types::ImdsSupportValues) -> Self {
self.inner = self.inner.imds_support(input);
self
}
/// <p>Set to <code>v2.0</code> to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have <code>HttpTokens</code> automatically set to <code>required</code> so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, <code>HttpPutResponseHopLimit</code> is set to <code>2</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration">Configure the AMI</a> in the <i>Amazon EC2 User Guide</i>.</p> <note>
/// <p>If you set the value to <code>v2.0</code>, make sure that your AMI software can support IMDSv2.</p>
/// </note>
pub fn set_imds_support(
mut self,
input: std::option::Option<crate::types::ImdsSupportValues>,
) -> Self {
self.inner = self.inner.set_imds_support(input);
self
}
}