#[non_exhaustive]pub struct Instance {Show 22 fields
pub name: Option<String>,
pub arn: Option<String>,
pub support_code: Option<String>,
pub created_at: Option<DateTime>,
pub location: Option<ResourceLocation>,
pub resource_type: Option<ResourceType>,
pub tags: Option<Vec<Tag>>,
pub blueprint_id: Option<String>,
pub blueprint_name: Option<String>,
pub bundle_id: Option<String>,
pub add_ons: Option<Vec<AddOn>>,
pub is_static_ip: Option<bool>,
pub private_ip_address: Option<String>,
pub public_ip_address: Option<String>,
pub ipv6_addresses: Option<Vec<String>>,
pub ip_address_type: Option<IpAddressType>,
pub hardware: Option<InstanceHardware>,
pub networking: Option<InstanceNetworking>,
pub state: Option<InstanceState>,
pub username: Option<String>,
pub ssh_key_name: Option<String>,
pub metadata_options: Option<InstanceMetadataOptions>,
}Expand description
Describes an instance (a virtual private server).
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.name: Option<String>The name the user gave the instance (Amazon_Linux_2023-1).
arn: Option<String>The Amazon Resource Name (ARN) of the instance (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
support_code: Option<String>The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
created_at: Option<DateTime>The timestamp when the instance was created (1479734909.17) in Unix time format.
location: Option<ResourceLocation>The region name and Availability Zone where the instance is located.
resource_type: Option<ResourceType>The type of resource (usually Instance).
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
blueprint_id: Option<String>The blueprint ID (amazon_linux_2023).
blueprint_name: Option<String>The friendly name of the blueprint (Amazon Linux 2023).
bundle_id: Option<String>The bundle for the instance (micro_x_x).
add_ons: Option<Vec<AddOn>>An array of objects representing the add-ons enabled on the instance.
is_static_ip: Option<bool>A Boolean value indicating whether this instance has a static IP assigned to it.
private_ip_address: Option<String>The private IP address of the instance.
public_ip_address: Option<String>The public IP address of the instance.
ipv6_addresses: Option<Vec<String>>The IPv6 addresses of the instance.
ip_address_type: Option<IpAddressType>The IP address type of the instance.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.
hardware: Option<InstanceHardware>The size of the vCPU and the amount of RAM for the instance.
networking: Option<InstanceNetworking>Information about the public ports and monthly data transfer rates for the instance.
state: Option<InstanceState>The status code and the state (running) for the instance.
username: Option<String>The user name for connecting to the instance (ec2-user).
ssh_key_name: Option<String>The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).
metadata_options: Option<InstanceMetadataOptions>The metadata options for the Amazon Lightsail instance.
Implementations§
Source§impl Instance
impl Instance
Sourcepub fn arn(&self) -> Option<&str>
pub fn arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the instance (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
Sourcepub fn support_code(&self) -> Option<&str>
pub fn support_code(&self) -> Option<&str>
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The timestamp when the instance was created (1479734909.17) in Unix time format.
Sourcepub fn location(&self) -> Option<&ResourceLocation>
pub fn location(&self) -> Option<&ResourceLocation>
The region name and Availability Zone where the instance is located.
Sourcepub fn resource_type(&self) -> Option<&ResourceType>
pub fn resource_type(&self) -> Option<&ResourceType>
The type of resource (usually Instance).
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer 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 .tags.is_none().
Sourcepub fn blueprint_id(&self) -> Option<&str>
pub fn blueprint_id(&self) -> Option<&str>
The blueprint ID (amazon_linux_2023).
Sourcepub fn blueprint_name(&self) -> Option<&str>
pub fn blueprint_name(&self) -> Option<&str>
The friendly name of the blueprint (Amazon Linux 2023).
Sourcepub fn add_ons(&self) -> &[AddOn]
pub fn add_ons(&self) -> &[AddOn]
An array of objects representing the add-ons enabled on the instance.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .add_ons.is_none().
Sourcepub fn is_static_ip(&self) -> Option<bool>
pub fn is_static_ip(&self) -> Option<bool>
A Boolean value indicating whether this instance has a static IP assigned to it.
Sourcepub fn private_ip_address(&self) -> Option<&str>
pub fn private_ip_address(&self) -> Option<&str>
The private IP address of the instance.
Sourcepub fn public_ip_address(&self) -> Option<&str>
pub fn public_ip_address(&self) -> Option<&str>
The public IP address of the instance.
Sourcepub fn ipv6_addresses(&self) -> &[String]
pub fn ipv6_addresses(&self) -> &[String]
The IPv6 addresses of the instance.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ipv6_addresses.is_none().
Sourcepub fn ip_address_type(&self) -> Option<&IpAddressType>
pub fn ip_address_type(&self) -> Option<&IpAddressType>
The IP address type of the instance.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.
Sourcepub fn hardware(&self) -> Option<&InstanceHardware>
pub fn hardware(&self) -> Option<&InstanceHardware>
The size of the vCPU and the amount of RAM for the instance.
Sourcepub fn networking(&self) -> Option<&InstanceNetworking>
pub fn networking(&self) -> Option<&InstanceNetworking>
Information about the public ports and monthly data transfer rates for the instance.
Sourcepub fn state(&self) -> Option<&InstanceState>
pub fn state(&self) -> Option<&InstanceState>
The status code and the state (running) for the instance.
Sourcepub fn username(&self) -> Option<&str>
pub fn username(&self) -> Option<&str>
The user name for connecting to the instance (ec2-user).
Sourcepub fn ssh_key_name(&self) -> Option<&str>
pub fn ssh_key_name(&self) -> Option<&str>
The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).
Sourcepub fn metadata_options(&self) -> Option<&InstanceMetadataOptions>
pub fn metadata_options(&self) -> Option<&InstanceMetadataOptions>
The metadata options for the Amazon Lightsail instance.
Trait Implementations§
impl StructuralPartialEq for Instance
Auto Trait Implementations§
impl Freeze for Instance
impl RefUnwindSafe for Instance
impl Send for Instance
impl Sync for Instance
impl Unpin for Instance
impl UnwindSafe for Instance
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);