#[non_exhaustive]pub struct Environment {Show 20 fields
pub environment_id: Option<String>,
pub environment_state: Option<EnvironmentState>,
pub state_details: Option<String>,
pub created_at: Option<DateTime>,
pub modified_at: Option<DateTime>,
pub environment_arn: Option<String>,
pub environment_name: Option<String>,
pub vpc_id: Option<String>,
pub service_access_subnet_id: Option<String>,
pub vcf_version: Option<VcfVersion>,
pub terms_accepted: Option<bool>,
pub license_info: Option<Vec<LicenseInfo>>,
pub site_id: Option<String>,
pub environment_status: Option<CheckResult>,
pub checks: Option<Vec<Check>>,
pub connectivity_info: Option<ConnectivityInfo>,
pub vcf_hostnames: Option<VcfHostnames>,
pub kms_key_id: Option<String>,
pub service_access_security_groups: Option<ServiceAccessSecurityGroups>,
pub credentials: Option<Vec<Secret>>,
}
Expand description
An object that represents an Amazon EVS environment.
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.environment_id: Option<String>
The unique ID for the environment.
environment_state: Option<EnvironmentState>
The state of an environment.
state_details: Option<String>
A detailed description of the environmentState
of an environment.
created_at: Option<DateTime>
The date and time that the environment was created.
modified_at: Option<DateTime>
The date and time that the environment was modified.
environment_arn: Option<String>
The Amazon Resource Name (ARN) that is associated with the environment.
environment_name: Option<String>
The name of the environment.
vpc_id: Option<String>
The VPC associated with the environment.
service_access_subnet_id: Option<String>
The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to perform validations and create the environment.
vcf_version: Option<VcfVersion>
The VCF version of the environment.
terms_accepted: Option<bool>
Customer confirmation that the customer has purchased and maintains sufficient VCF software licenses to cover all physical processor cores in the environment, in compliance with VMware's licensing requirements and terms of use.
license_info: Option<Vec<LicenseInfo>>
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.
site_id: Option<String>
The Broadcom Site ID that is associated with your Amazon EVS environment. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.
environment_status: Option<CheckResult>
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
checks: Option<Vec<Check>>
A check on the environment to identify instance health and VMware VCF licensing issues.
connectivity_info: Option<ConnectivityInfo>
The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.
vcf_hostnames: Option<VcfHostnames>
The DNS hostnames to be used by the VCF management appliances in your environment.
For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.
kms_key_id: Option<String>
The Amazon Web Services KMS key ID that Amazon Web Services Secrets Manager uses to encrypt secrets that are associated with the environment. These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
By default, Amazon EVS use the Amazon Web Services Secrets Manager managed key aws/secretsmanager
. You can also specify a customer managed key.
service_access_security_groups: Option<ServiceAccessSecurityGroups>
The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.
credentials: Option<Vec<Secret>>
The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.
Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
Implementations§
Source§impl Environment
impl Environment
Sourcepub fn environment_id(&self) -> Option<&str>
pub fn environment_id(&self) -> Option<&str>
The unique ID for the environment.
Sourcepub fn environment_state(&self) -> Option<&EnvironmentState>
pub fn environment_state(&self) -> Option<&EnvironmentState>
The state of an environment.
Sourcepub fn state_details(&self) -> Option<&str>
pub fn state_details(&self) -> Option<&str>
A detailed description of the environmentState
of an environment.
Sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The date and time that the environment was created.
Sourcepub fn modified_at(&self) -> Option<&DateTime>
pub fn modified_at(&self) -> Option<&DateTime>
The date and time that the environment was modified.
Sourcepub fn environment_arn(&self) -> Option<&str>
pub fn environment_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that is associated with the environment.
Sourcepub fn environment_name(&self) -> Option<&str>
pub fn environment_name(&self) -> Option<&str>
The name of the environment.
Sourcepub fn service_access_subnet_id(&self) -> Option<&str>
pub fn service_access_subnet_id(&self) -> Option<&str>
The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to perform validations and create the environment.
Sourcepub fn vcf_version(&self) -> Option<&VcfVersion>
pub fn vcf_version(&self) -> Option<&VcfVersion>
The VCF version of the environment.
Sourcepub fn terms_accepted(&self) -> Option<bool>
pub fn terms_accepted(&self) -> Option<bool>
Customer confirmation that the customer has purchased and maintains sufficient VCF software licenses to cover all physical processor cores in the environment, in compliance with VMware's licensing requirements and terms of use.
Sourcepub fn license_info(&self) -> &[LicenseInfo]
pub fn license_info(&self) -> &[LicenseInfo]
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.
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_info.is_none()
.
Sourcepub fn site_id(&self) -> Option<&str>
pub fn site_id(&self) -> Option<&str>
The Broadcom Site ID that is associated with your Amazon EVS environment. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.
Sourcepub fn environment_status(&self) -> Option<&CheckResult>
pub fn environment_status(&self) -> Option<&CheckResult>
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
Sourcepub fn checks(&self) -> &[Check]
pub fn checks(&self) -> &[Check]
A check on the environment to identify instance health and VMware VCF licensing issues.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .checks.is_none()
.
Sourcepub fn connectivity_info(&self) -> Option<&ConnectivityInfo>
pub fn connectivity_info(&self) -> Option<&ConnectivityInfo>
The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.
Sourcepub fn vcf_hostnames(&self) -> Option<&VcfHostnames>
pub fn vcf_hostnames(&self) -> Option<&VcfHostnames>
The DNS hostnames to be used by the VCF management appliances in your environment.
For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.
Sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The Amazon Web Services KMS key ID that Amazon Web Services Secrets Manager uses to encrypt secrets that are associated with the environment. These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
By default, Amazon EVS use the Amazon Web Services Secrets Manager managed key aws/secretsmanager
. You can also specify a customer managed key.
Sourcepub fn service_access_security_groups(
&self,
) -> Option<&ServiceAccessSecurityGroups>
pub fn service_access_security_groups( &self, ) -> Option<&ServiceAccessSecurityGroups>
The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.
Sourcepub fn credentials(&self) -> &[Secret]
pub fn credentials(&self) -> &[Secret]
The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.
Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .credentials.is_none()
.
Source§impl Environment
impl Environment
Sourcepub fn builder() -> EnvironmentBuilder
pub fn builder() -> EnvironmentBuilder
Creates a new builder-style object to manufacture Environment
.
Trait Implementations§
Source§impl Clone for Environment
impl Clone for Environment
Source§fn clone(&self) -> Environment
fn clone(&self) -> Environment
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for Environment
impl Debug for Environment
Source§impl PartialEq for Environment
impl PartialEq for Environment
impl StructuralPartialEq for Environment
Auto Trait Implementations§
impl Freeze for Environment
impl RefUnwindSafe for Environment
impl Send for Environment
impl Sync for Environment
impl Unpin for Environment
impl UnwindSafe for Environment
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);