#[non_exhaustive]pub struct EnvironmentBuilder { /* private fields */ }
Expand description
A builder for Environment
.
Implementations§
Source§impl EnvironmentBuilder
impl EnvironmentBuilder
Sourcepub fn environment_id(self, input: impl Into<String>) -> Self
pub fn environment_id(self, input: impl Into<String>) -> Self
The unique ID for the environment.
Sourcepub fn set_environment_id(self, input: Option<String>) -> Self
pub fn set_environment_id(self, input: Option<String>) -> Self
The unique ID for the environment.
Sourcepub fn get_environment_id(&self) -> &Option<String>
pub fn get_environment_id(&self) -> &Option<String>
The unique ID for the environment.
Sourcepub fn environment_state(self, input: EnvironmentState) -> Self
pub fn environment_state(self, input: EnvironmentState) -> Self
The state of an environment.
Sourcepub fn set_environment_state(self, input: Option<EnvironmentState>) -> Self
pub fn set_environment_state(self, input: Option<EnvironmentState>) -> Self
The state of an environment.
Sourcepub fn get_environment_state(&self) -> &Option<EnvironmentState>
pub fn get_environment_state(&self) -> &Option<EnvironmentState>
The state of an environment.
Sourcepub fn state_details(self, input: impl Into<String>) -> Self
pub fn state_details(self, input: impl Into<String>) -> Self
A detailed description of the environmentState
of an environment.
Sourcepub fn set_state_details(self, input: Option<String>) -> Self
pub fn set_state_details(self, input: Option<String>) -> Self
A detailed description of the environmentState
of an environment.
Sourcepub fn get_state_details(&self) -> &Option<String>
pub fn get_state_details(&self) -> &Option<String>
A detailed description of the environmentState
of an environment.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The date and time that the environment was created.
Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The date and time that the environment was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The date and time that the environment was created.
Sourcepub fn modified_at(self, input: DateTime) -> Self
pub fn modified_at(self, input: DateTime) -> Self
The date and time that the environment was modified.
Sourcepub fn set_modified_at(self, input: Option<DateTime>) -> Self
pub fn set_modified_at(self, input: Option<DateTime>) -> Self
The date and time that the environment was modified.
Sourcepub fn get_modified_at(&self) -> &Option<DateTime>
pub fn get_modified_at(&self) -> &Option<DateTime>
The date and time that the environment was modified.
Sourcepub fn environment_arn(self, input: impl Into<String>) -> Self
pub fn environment_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) that is associated with the environment.
Sourcepub fn set_environment_arn(self, input: Option<String>) -> Self
pub fn set_environment_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) that is associated with the environment.
Sourcepub fn get_environment_arn(&self) -> &Option<String>
pub fn get_environment_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) that is associated with the environment.
Sourcepub fn environment_name(self, input: impl Into<String>) -> Self
pub fn environment_name(self, input: impl Into<String>) -> Self
The name of the environment.
Sourcepub fn set_environment_name(self, input: Option<String>) -> Self
pub fn set_environment_name(self, input: Option<String>) -> Self
The name of the environment.
Sourcepub fn get_environment_name(&self) -> &Option<String>
pub fn get_environment_name(&self) -> &Option<String>
The name of the environment.
Sourcepub fn set_vpc_id(self, input: Option<String>) -> Self
pub fn set_vpc_id(self, input: Option<String>) -> Self
The VPC associated with the environment.
Sourcepub fn get_vpc_id(&self) -> &Option<String>
pub fn get_vpc_id(&self) -> &Option<String>
The VPC associated with the environment.
Sourcepub fn service_access_subnet_id(self, input: impl Into<String>) -> Self
pub fn service_access_subnet_id(self, input: impl Into<String>) -> Self
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 set_service_access_subnet_id(self, input: Option<String>) -> Self
pub fn set_service_access_subnet_id(self, input: Option<String>) -> Self
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 get_service_access_subnet_id(&self) -> &Option<String>
pub fn get_service_access_subnet_id(&self) -> &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.
Sourcepub fn vcf_version(self, input: VcfVersion) -> Self
pub fn vcf_version(self, input: VcfVersion) -> Self
The VCF version of the environment.
Sourcepub fn set_vcf_version(self, input: Option<VcfVersion>) -> Self
pub fn set_vcf_version(self, input: Option<VcfVersion>) -> Self
The VCF version of the environment.
Sourcepub fn get_vcf_version(&self) -> &Option<VcfVersion>
pub fn get_vcf_version(&self) -> &Option<VcfVersion>
The VCF version of the environment.
Sourcepub fn terms_accepted(self, input: bool) -> Self
pub fn terms_accepted(self, input: bool) -> Self
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 set_terms_accepted(self, input: Option<bool>) -> Self
pub fn set_terms_accepted(self, input: Option<bool>) -> Self
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 get_terms_accepted(&self) -> &Option<bool>
pub fn get_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, input: LicenseInfo) -> Self
pub fn license_info(self, input: LicenseInfo) -> Self
Appends an item to license_info
.
To override the contents of this collection use set_license_info
.
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.
Sourcepub fn set_license_info(self, input: Option<Vec<LicenseInfo>>) -> Self
pub fn set_license_info(self, input: Option<Vec<LicenseInfo>>) -> Self
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.
Sourcepub fn get_license_info(&self) -> &Option<Vec<LicenseInfo>>
pub fn get_license_info(&self) -> &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.
Sourcepub fn site_id(self, input: impl Into<String>) -> Self
pub fn site_id(self, input: impl Into<String>) -> Self
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 set_site_id(self, input: Option<String>) -> Self
pub fn set_site_id(self, input: Option<String>) -> Self
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 get_site_id(&self) -> &Option<String>
pub fn get_site_id(&self) -> &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.
Sourcepub fn environment_status(self, input: CheckResult) -> Self
pub fn environment_status(self, input: CheckResult) -> Self
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
Sourcepub fn set_environment_status(self, input: Option<CheckResult>) -> Self
pub fn set_environment_status(self, input: Option<CheckResult>) -> Self
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
Sourcepub fn get_environment_status(&self) -> &Option<CheckResult>
pub fn get_environment_status(&self) -> &Option<CheckResult>
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
Sourcepub fn checks(self, input: Check) -> Self
pub fn checks(self, input: Check) -> Self
Appends an item to checks
.
To override the contents of this collection use set_checks
.
A check on the environment to identify instance health and VMware VCF licensing issues.
Sourcepub fn set_checks(self, input: Option<Vec<Check>>) -> Self
pub fn set_checks(self, input: Option<Vec<Check>>) -> Self
A check on the environment to identify instance health and VMware VCF licensing issues.
Sourcepub fn get_checks(&self) -> &Option<Vec<Check>>
pub fn get_checks(&self) -> &Option<Vec<Check>>
A check on the environment to identify instance health and VMware VCF licensing issues.
Sourcepub fn connectivity_info(self, input: ConnectivityInfo) -> Self
pub fn connectivity_info(self, input: ConnectivityInfo) -> Self
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 set_connectivity_info(self, input: Option<ConnectivityInfo>) -> Self
pub fn set_connectivity_info(self, input: Option<ConnectivityInfo>) -> Self
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 get_connectivity_info(&self) -> &Option<ConnectivityInfo>
pub fn get_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, input: VcfHostnames) -> Self
pub fn vcf_hostnames(self, input: VcfHostnames) -> Self
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 set_vcf_hostnames(self, input: Option<VcfHostnames>) -> Self
pub fn set_vcf_hostnames(self, input: Option<VcfHostnames>) -> Self
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 get_vcf_hostnames(&self) -> &Option<VcfHostnames>
pub fn get_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, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
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 set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
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 get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &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.
Sourcepub fn service_access_security_groups(
self,
input: ServiceAccessSecurityGroups,
) -> Self
pub fn service_access_security_groups( self, input: ServiceAccessSecurityGroups, ) -> Self
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 set_service_access_security_groups(
self,
input: Option<ServiceAccessSecurityGroups>,
) -> Self
pub fn set_service_access_security_groups( self, input: Option<ServiceAccessSecurityGroups>, ) -> Self
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 get_service_access_security_groups(
&self,
) -> &Option<ServiceAccessSecurityGroups>
pub fn get_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, input: Secret) -> Self
pub fn credentials(self, input: Secret) -> Self
Appends an item to credentials
.
To override the contents of this collection use set_credentials
.
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.
Sourcepub fn set_credentials(self, input: Option<Vec<Secret>>) -> Self
pub fn set_credentials(self, input: Option<Vec<Secret>>) -> Self
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.
Sourcepub fn get_credentials(&self) -> &Option<Vec<Secret>>
pub fn get_credentials(&self) -> &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.
Sourcepub fn build(self) -> Environment
pub fn build(self) -> Environment
Consumes the builder and constructs a Environment
.
Trait Implementations§
Source§impl Clone for EnvironmentBuilder
impl Clone for EnvironmentBuilder
Source§fn clone(&self) -> EnvironmentBuilder
fn clone(&self) -> EnvironmentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EnvironmentBuilder
impl Debug for EnvironmentBuilder
Source§impl Default for EnvironmentBuilder
impl Default for EnvironmentBuilder
Source§fn default() -> EnvironmentBuilder
fn default() -> EnvironmentBuilder
Source§impl PartialEq for EnvironmentBuilder
impl PartialEq for EnvironmentBuilder
impl StructuralPartialEq for EnvironmentBuilder
Auto Trait Implementations§
impl Freeze for EnvironmentBuilder
impl RefUnwindSafe for EnvironmentBuilder
impl Send for EnvironmentBuilder
impl Sync for EnvironmentBuilder
impl Unpin for EnvironmentBuilder
impl UnwindSafe for EnvironmentBuilder
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);