#[non_exhaustive]pub struct RegisterImageInput {Show 18 fields
pub image_location: Option<String>,
pub billing_products: Option<Vec<String>>,
pub boot_mode: Option<BootModeValues>,
pub tpm_support: Option<TpmSupportValues>,
pub uefi_data: Option<String>,
pub imds_support: Option<ImdsSupportValues>,
pub tag_specifications: Option<Vec<TagSpecification>>,
pub dry_run: Option<bool>,
pub name: Option<String>,
pub description: Option<String>,
pub architecture: Option<ArchitectureValues>,
pub kernel_id: Option<String>,
pub ramdisk_id: Option<String>,
pub root_device_name: Option<String>,
pub block_device_mappings: Option<Vec<BlockDeviceMapping>>,
pub virtualization_type: Option<String>,
pub sriov_net_support: Option<String>,
pub ena_support: Option<bool>,
}Expand description
Contains the parameters for RegisterImage.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.image_location: Option<String>The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACL in the Amazon S3 Service Developer Guide.
billing_products: Option<Vec<String>>The billing product codes. Your account must be authorized to specify billing product codes.
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 Getting started as an Amazon Web Services Marketplace seller and AMI-based products in Amazon Web Services Marketplace in the Amazon Web Services Marketplace Seller Guide.
boot_mode: Option<BootModeValues>The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.
tpm_support: Option<TpmSupportValues>Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.
uefi_data: Option<String>Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot for Amazon EC2 instances in the Amazon EC2 User Guide.
imds_support: Option<ImdsSupportValues>Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
tag_specifications: Option<Vec<TagSpecification>>The tags to apply to the AMI.
To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.
To tag an AMI after it has been registered, see CreateTags.
dry_run: Option<bool>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.
name: Option<String>A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets (\[\]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
description: Option<String>A description for your AMI.
architecture: Option<ArchitectureValues>The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
kernel_id: Option<String>The ID of the kernel.
ramdisk_id: Option<String>The ID of the RAM disk.
root_device_name: Option<String>The device name of the root device volume (for example, /dev/sda1).
block_device_mappings: Option<Vec<BlockDeviceMapping>>The block device mapping entries.
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.
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, Create AMIs from local snapshots in the Amazon EBS User Guide.
virtualization_type: Option<String>The type of virtualization (hvm | paravirtual).
Default: paravirtual
sriov_net_support: Option<String>Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
ena_support: Option<bool>Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
Implementations§
Source§impl RegisterImageInput
impl RegisterImageInput
Sourcepub fn image_location(&self) -> Option<&str>
pub fn image_location(&self) -> Option<&str>
The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACL in the Amazon S3 Service Developer Guide.
Sourcepub fn billing_products(&self) -> &[String]
pub fn billing_products(&self) -> &[String]
The billing product codes. Your account must be authorized to specify billing product codes.
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 Getting started as an Amazon Web Services Marketplace seller and AMI-based products in Amazon Web Services Marketplace in the Amazon Web Services Marketplace Seller Guide.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .billing_products.is_none().
Sourcepub fn boot_mode(&self) -> Option<&BootModeValues>
pub fn boot_mode(&self) -> Option<&BootModeValues>
The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.
Sourcepub fn tpm_support(&self) -> Option<&TpmSupportValues>
pub fn tpm_support(&self) -> Option<&TpmSupportValues>
Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.
Sourcepub fn uefi_data(&self) -> Option<&str>
pub fn uefi_data(&self) -> Option<&str>
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot for Amazon EC2 instances in the Amazon EC2 User Guide.
Sourcepub fn imds_support(&self) -> Option<&ImdsSupportValues>
pub fn imds_support(&self) -> Option<&ImdsSupportValues>
Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
Sourcepub fn tag_specifications(&self) -> &[TagSpecification]
pub fn tag_specifications(&self) -> &[TagSpecification]
The tags to apply to the AMI.
To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.
To tag an AMI after it has been registered, see CreateTags.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_specifications.is_none().
Sourcepub fn dry_run(&self) -> Option<bool>
pub fn dry_run(&self) -> Option<bool>
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.
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets (\[\]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description for your AMI.
Sourcepub fn architecture(&self) -> Option<&ArchitectureValues>
pub fn architecture(&self) -> Option<&ArchitectureValues>
The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
Sourcepub fn ramdisk_id(&self) -> Option<&str>
pub fn ramdisk_id(&self) -> Option<&str>
The ID of the RAM disk.
Sourcepub fn root_device_name(&self) -> Option<&str>
pub fn root_device_name(&self) -> Option<&str>
The device name of the root device volume (for example, /dev/sda1).
Sourcepub fn block_device_mappings(&self) -> &[BlockDeviceMapping]
pub fn block_device_mappings(&self) -> &[BlockDeviceMapping]
The block device mapping entries.
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.
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, Create AMIs from local snapshots in the Amazon EBS User Guide.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .block_device_mappings.is_none().
Sourcepub fn virtualization_type(&self) -> Option<&str>
pub fn virtualization_type(&self) -> Option<&str>
The type of virtualization (hvm | paravirtual).
Default: paravirtual
Sourcepub fn sriov_net_support(&self) -> Option<&str>
pub fn sriov_net_support(&self) -> Option<&str>
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
Sourcepub fn ena_support(&self) -> Option<bool>
pub fn ena_support(&self) -> Option<bool>
Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
Source§impl RegisterImageInput
impl RegisterImageInput
Sourcepub fn builder() -> RegisterImageInputBuilder
pub fn builder() -> RegisterImageInputBuilder
Creates a new builder-style object to manufacture RegisterImageInput.
Trait Implementations§
Source§impl Clone for RegisterImageInput
impl Clone for RegisterImageInput
Source§fn clone(&self) -> RegisterImageInput
fn clone(&self) -> RegisterImageInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for RegisterImageInput
impl Debug for RegisterImageInput
Source§impl PartialEq for RegisterImageInput
impl PartialEq for RegisterImageInput
impl StructuralPartialEq for RegisterImageInput
Auto Trait Implementations§
impl Freeze for RegisterImageInput
impl RefUnwindSafe for RegisterImageInput
impl Send for RegisterImageInput
impl Sync for RegisterImageInput
impl Unpin for RegisterImageInput
impl UnwindSafe for RegisterImageInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);