#[non_exhaustive]pub struct ModifyInstanceAttributeInput {Show 17 fields
pub source_dest_check: Option<AttributeBooleanValue>,
pub attribute: Option<InstanceAttributeName>,
pub block_device_mappings: Option<Vec<InstanceBlockDeviceMappingSpecification>>,
pub disable_api_termination: Option<AttributeBooleanValue>,
pub dry_run: Option<bool>,
pub ebs_optimized: Option<AttributeBooleanValue>,
pub ena_support: Option<AttributeBooleanValue>,
pub groups: Option<Vec<String>>,
pub instance_id: Option<String>,
pub instance_initiated_shutdown_behavior: Option<AttributeValue>,
pub instance_type: Option<AttributeValue>,
pub kernel: Option<AttributeValue>,
pub ramdisk: Option<AttributeValue>,
pub sriov_net_support: Option<AttributeValue>,
pub user_data: Option<BlobAttributeValue>,
pub value: Option<String>,
pub disable_api_stop: Option<AttributeBooleanValue>,
}
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.source_dest_check: Option<AttributeBooleanValue>
Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true
, source/destination checks are enabled; otherwise, they are disabled. The default value is true
. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
attribute: Option<InstanceAttributeName>
The name of the attribute to modify.
You can modify the following attributes only: disableApiTermination
| instanceType
| kernel
| ramdisk
| instanceInitiatedShutdownBehavior
| blockDeviceMapping
| userData
| sourceDestCheck
| groupSet
| ebsOptimized
| sriovNetSupport
| enaSupport
| nvmeSupport
| disableApiStop
| enclaveOptions
block_device_mappings: Option<Vec<InstanceBlockDeviceMappingSpecification>>
Modifies the DeleteOnTermination
attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination
, the default is true
and the volume is deleted when the instance is terminated. You can't modify the DeleteOnTermination
attribute for volumes that are attached to Fargate tasks.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
disable_api_termination: Option<AttributeBooleanValue>
If the value is true
, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.
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
.
ebs_optimized: Option<AttributeBooleanValue>
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
ena_support: Option<AttributeBooleanValue>
Set to true
to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
groups: Option<Vec<String>>
Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it's just the default security group for the VPC.
instance_id: Option<String>
The ID of the instance.
instance_initiated_shutdown_behavior: Option<AttributeValue>
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
instance_type: Option<AttributeValue>
Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue
.
kernel: Option<AttributeValue>
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
ramdisk: Option<AttributeValue>
Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
sriov_net_support: Option<AttributeValue>
Set to simple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
user_data: Option<BlobAttributeValue>
Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data.
value: Option<String>
A new value for the attribute. Use only with the kernel
, ramdisk
, userData
, disableApiTermination
, or instanceInitiatedShutdownBehavior
attribute.
disable_api_stop: Option<AttributeBooleanValue>
Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance.
Implementations§
source§impl ModifyInstanceAttributeInput
impl ModifyInstanceAttributeInput
sourcepub fn source_dest_check(&self) -> Option<&AttributeBooleanValue>
pub fn source_dest_check(&self) -> Option<&AttributeBooleanValue>
Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true
, source/destination checks are enabled; otherwise, they are disabled. The default value is true
. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
sourcepub fn attribute(&self) -> Option<&InstanceAttributeName>
pub fn attribute(&self) -> Option<&InstanceAttributeName>
The name of the attribute to modify.
You can modify the following attributes only: disableApiTermination
| instanceType
| kernel
| ramdisk
| instanceInitiatedShutdownBehavior
| blockDeviceMapping
| userData
| sourceDestCheck
| groupSet
| ebsOptimized
| sriovNetSupport
| enaSupport
| nvmeSupport
| disableApiStop
| enclaveOptions
sourcepub fn block_device_mappings(
&self,
) -> &[InstanceBlockDeviceMappingSpecification]
pub fn block_device_mappings( &self, ) -> &[InstanceBlockDeviceMappingSpecification]
Modifies the DeleteOnTermination
attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination
, the default is true
and the volume is deleted when the instance is terminated. You can't modify the DeleteOnTermination
attribute for volumes that are attached to Fargate tasks.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 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 disable_api_termination(&self) -> Option<&AttributeBooleanValue>
pub fn disable_api_termination(&self) -> Option<&AttributeBooleanValue>
If the value is true
, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.
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 ebs_optimized(&self) -> Option<&AttributeBooleanValue>
pub fn ebs_optimized(&self) -> Option<&AttributeBooleanValue>
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
sourcepub fn ena_support(&self) -> Option<&AttributeBooleanValue>
pub fn ena_support(&self) -> Option<&AttributeBooleanValue>
Set to true
to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
sourcepub fn groups(&self) -> &[String]
pub fn groups(&self) -> &[String]
Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it's just the default security group for the VPC.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .groups.is_none()
.
sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The ID of the instance.
sourcepub fn instance_initiated_shutdown_behavior(&self) -> Option<&AttributeValue>
pub fn instance_initiated_shutdown_behavior(&self) -> Option<&AttributeValue>
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
sourcepub fn instance_type(&self) -> Option<&AttributeValue>
pub fn instance_type(&self) -> Option<&AttributeValue>
Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue
.
sourcepub fn kernel(&self) -> Option<&AttributeValue>
pub fn kernel(&self) -> Option<&AttributeValue>
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
sourcepub fn ramdisk(&self) -> Option<&AttributeValue>
pub fn ramdisk(&self) -> Option<&AttributeValue>
Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
sourcepub fn sriov_net_support(&self) -> Option<&AttributeValue>
pub fn sriov_net_support(&self) -> Option<&AttributeValue>
Set to simple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
sourcepub fn user_data(&self) -> Option<&BlobAttributeValue>
pub fn user_data(&self) -> Option<&BlobAttributeValue>
Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data.
sourcepub fn value(&self) -> Option<&str>
pub fn value(&self) -> Option<&str>
A new value for the attribute. Use only with the kernel
, ramdisk
, userData
, disableApiTermination
, or instanceInitiatedShutdownBehavior
attribute.
sourcepub fn disable_api_stop(&self) -> Option<&AttributeBooleanValue>
pub fn disable_api_stop(&self) -> Option<&AttributeBooleanValue>
Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance.
source§impl ModifyInstanceAttributeInput
impl ModifyInstanceAttributeInput
sourcepub fn builder() -> ModifyInstanceAttributeInputBuilder
pub fn builder() -> ModifyInstanceAttributeInputBuilder
Creates a new builder-style object to manufacture ModifyInstanceAttributeInput
.
Trait Implementations§
source§impl Clone for ModifyInstanceAttributeInput
impl Clone for ModifyInstanceAttributeInput
source§fn clone(&self) -> ModifyInstanceAttributeInput
fn clone(&self) -> ModifyInstanceAttributeInput
1.6.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ModifyInstanceAttributeInput
impl Debug for ModifyInstanceAttributeInput
source§impl PartialEq for ModifyInstanceAttributeInput
impl PartialEq for ModifyInstanceAttributeInput
source§fn eq(&self, other: &ModifyInstanceAttributeInput) -> bool
fn eq(&self, other: &ModifyInstanceAttributeInput) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ModifyInstanceAttributeInput
Auto Trait Implementations§
impl Freeze for ModifyInstanceAttributeInput
impl RefUnwindSafe for ModifyInstanceAttributeInput
impl Send for ModifyInstanceAttributeInput
impl Sync for ModifyInstanceAttributeInput
impl Unpin for ModifyInstanceAttributeInput
impl UnwindSafe for ModifyInstanceAttributeInput
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);