#[non_exhaustive]pub struct ImportImageInput {Show 16 fields
pub architecture: Option<String>,
pub client_data: Option<ClientData>,
pub client_token: Option<String>,
pub description: Option<String>,
pub disk_containers: Option<Vec<ImageDiskContainer>>,
pub dry_run: Option<bool>,
pub encrypted: Option<bool>,
pub hypervisor: Option<String>,
pub kms_key_id: Option<String>,
pub license_type: Option<String>,
pub platform: Option<String>,
pub role_name: Option<String>,
pub license_specifications: Option<Vec<ImportImageLicenseConfigurationRequest>>,
pub tag_specifications: Option<Vec<TagSpecification>>,
pub usage_operation: Option<String>,
pub boot_mode: Option<BootModeValues>,
}
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.architecture: Option<String>
The architecture of the virtual machine.
Valid values: i386
| x86_64
client_data: Option<ClientData>
The client-specific data.
client_token: Option<String>
The token to enable idempotency for VM import requests.
description: Option<String>
A description string for the import image task.
disk_containers: Option<Vec<ImageDiskContainer>>
Information about the disk containers.
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
.
encrypted: Option<bool>
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.
hypervisor: Option<String>
The target hypervisor platform.
Valid values: xen
kms_key_id: Option<String>
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
-
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, thekey
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, thealias
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.
license_type: Option<String>
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.
platform: Option<String>
The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.
Valid values: Windows
| Linux
role_name: Option<String>
The name of the role to use when not using the default role, 'vmimport'.
license_specifications: Option<Vec<ImportImageLicenseConfigurationRequest>>
The ARNs of the license configurations.
tag_specifications: Option<Vec<TagSpecification>>
The tags to apply to the import image task during creation.
usage_operation: Option<String>
The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
boot_mode: Option<BootModeValues>
The boot mode of the virtual machine.
The uefi-preferred
boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.
Implementations§
Source§impl ImportImageInput
impl ImportImageInput
Sourcepub fn architecture(&self) -> Option<&str>
pub fn architecture(&self) -> Option<&str>
The architecture of the virtual machine.
Valid values: i386
| x86_64
Sourcepub fn client_data(&self) -> Option<&ClientData>
pub fn client_data(&self) -> Option<&ClientData>
The client-specific data.
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
The token to enable idempotency for VM import requests.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description string for the import image task.
Sourcepub fn disk_containers(&self) -> &[ImageDiskContainer]
pub fn disk_containers(&self) -> &[ImageDiskContainer]
Information about the disk containers.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .disk_containers.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 encrypted(&self) -> Option<bool>
pub fn encrypted(&self) -> Option<bool>
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.
Sourcepub fn hypervisor(&self) -> Option<&str>
pub fn hypervisor(&self) -> Option<&str>
The target hypervisor platform.
Valid values: xen
Sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
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
-
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, thekey
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, thealias
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.
Sourcepub fn license_type(&self) -> Option<&str>
pub fn license_type(&self) -> Option<&str>
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.
Sourcepub fn platform(&self) -> Option<&str>
pub fn platform(&self) -> Option<&str>
The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.
Valid values: Windows
| Linux
Sourcepub fn role_name(&self) -> Option<&str>
pub fn role_name(&self) -> Option<&str>
The name of the role to use when not using the default role, 'vmimport'.
Sourcepub fn license_specifications(
&self,
) -> &[ImportImageLicenseConfigurationRequest]
pub fn license_specifications( &self, ) -> &[ImportImageLicenseConfigurationRequest]
The ARNs of the license configurations.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .license_specifications.is_none()
.
Sourcepub fn tag_specifications(&self) -> &[TagSpecification]
pub fn tag_specifications(&self) -> &[TagSpecification]
The tags to apply to the import image task during creation.
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 usage_operation(&self) -> Option<&str>
pub fn usage_operation(&self) -> Option<&str>
The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
Sourcepub fn boot_mode(&self) -> Option<&BootModeValues>
pub fn boot_mode(&self) -> Option<&BootModeValues>
The boot mode of the virtual machine.
The uefi-preferred
boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.
Source§impl ImportImageInput
impl ImportImageInput
Sourcepub fn builder() -> ImportImageInputBuilder
pub fn builder() -> ImportImageInputBuilder
Creates a new builder-style object to manufacture ImportImageInput
.
Trait Implementations§
Source§impl Clone for ImportImageInput
impl Clone for ImportImageInput
Source§fn clone(&self) -> ImportImageInput
fn clone(&self) -> ImportImageInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ImportImageInput
impl Debug for ImportImageInput
Source§impl PartialEq for ImportImageInput
impl PartialEq for ImportImageInput
impl StructuralPartialEq for ImportImageInput
Auto Trait Implementations§
impl Freeze for ImportImageInput
impl RefUnwindSafe for ImportImageInput
impl Send for ImportImageInput
impl Sync for ImportImageInput
impl Unpin for ImportImageInput
impl UnwindSafe for ImportImageInput
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);