#[non_exhaustive]pub struct Cluster {Show 18 fields
pub backup_policy: Option<BackupPolicy>,
pub backup_retention_policy: Option<BackupRetentionPolicy>,
pub cluster_id: Option<String>,
pub create_timestamp: Option<DateTime>,
pub hsms: Option<Vec<Hsm>>,
pub hsm_type: Option<String>,
pub hsm_type_rollback_expiration: Option<DateTime>,
pub pre_co_password: Option<String>,
pub security_group: Option<String>,
pub source_backup_id: Option<String>,
pub state: Option<ClusterState>,
pub state_message: Option<String>,
pub subnet_mapping: Option<HashMap<String, String>>,
pub vpc_id: Option<String>,
pub network_type: Option<NetworkType>,
pub certificates: Option<Certificates>,
pub tag_list: Option<Vec<Tag>>,
pub mode: Option<ClusterMode>,
}Expand description
Contains information about an CloudHSM cluster.
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.backup_policy: Option<BackupPolicy>The cluster's backup policy.
backup_retention_policy: Option<BackupRetentionPolicy>A policy that defines how the service retains backups.
cluster_id: Option<String>The cluster's identifier (ID).
create_timestamp: Option<DateTime>The date and time when the cluster was created.
hsms: Option<Vec<Hsm>>Contains information about the HSMs in the cluster.
hsm_type: Option<String>The type of HSM that the cluster contains.
hsm_type_rollback_expiration: Option<DateTime>The timestamp until when the cluster can be rolled back to its original HSM type.
pre_co_password: Option<String>The default password for the cluster's Pre-Crypto Officer (PRECO) user.
security_group: Option<String>The identifier (ID) of the cluster's security group.
source_backup_id: Option<String>The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
state: Option<ClusterState>The cluster's state.
state_message: Option<String>A description of the cluster's state.
subnet_mapping: Option<HashMap<String, String>>A map from availability zone to the cluster’s subnet in that availability zone.
vpc_id: Option<String>The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
network_type: Option<NetworkType>The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.
certificates: Option<Certificates>Contains one or more certificates or a certificate signing request (CSR).
tag_list: Option<Vec<Tag>>The list of tags for the cluster.
mode: Option<ClusterMode>The mode of the cluster.
Implementations§
Source§impl Cluster
impl Cluster
Sourcepub fn backup_policy(&self) -> Option<&BackupPolicy>
pub fn backup_policy(&self) -> Option<&BackupPolicy>
The cluster's backup policy.
Sourcepub fn backup_retention_policy(&self) -> Option<&BackupRetentionPolicy>
pub fn backup_retention_policy(&self) -> Option<&BackupRetentionPolicy>
A policy that defines how the service retains backups.
Sourcepub fn cluster_id(&self) -> Option<&str>
pub fn cluster_id(&self) -> Option<&str>
The cluster's identifier (ID).
Sourcepub fn create_timestamp(&self) -> Option<&DateTime>
pub fn create_timestamp(&self) -> Option<&DateTime>
The date and time when the cluster was created.
Sourcepub fn hsms(&self) -> &[Hsm]
pub fn hsms(&self) -> &[Hsm]
Contains information about the HSMs in the cluster.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .hsms.is_none().
Sourcepub fn hsm_type_rollback_expiration(&self) -> Option<&DateTime>
pub fn hsm_type_rollback_expiration(&self) -> Option<&DateTime>
The timestamp until when the cluster can be rolled back to its original HSM type.
Sourcepub fn pre_co_password(&self) -> Option<&str>
pub fn pre_co_password(&self) -> Option<&str>
The default password for the cluster's Pre-Crypto Officer (PRECO) user.
Sourcepub fn security_group(&self) -> Option<&str>
pub fn security_group(&self) -> Option<&str>
The identifier (ID) of the cluster's security group.
Sourcepub fn source_backup_id(&self) -> Option<&str>
pub fn source_backup_id(&self) -> Option<&str>
The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
Sourcepub fn state(&self) -> Option<&ClusterState>
pub fn state(&self) -> Option<&ClusterState>
The cluster's state.
Sourcepub fn state_message(&self) -> Option<&str>
pub fn state_message(&self) -> Option<&str>
A description of the cluster's state.
Sourcepub fn subnet_mapping(&self) -> Option<&HashMap<String, String>>
pub fn subnet_mapping(&self) -> Option<&HashMap<String, String>>
A map from availability zone to the cluster’s subnet in that availability zone.
Sourcepub fn vpc_id(&self) -> Option<&str>
pub fn vpc_id(&self) -> Option<&str>
The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
Sourcepub fn network_type(&self) -> Option<&NetworkType>
pub fn network_type(&self) -> Option<&NetworkType>
The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.
Sourcepub fn certificates(&self) -> Option<&Certificates>
pub fn certificates(&self) -> Option<&Certificates>
Contains one or more certificates or a certificate signing request (CSR).
Sourcepub fn tag_list(&self) -> &[Tag]
pub fn tag_list(&self) -> &[Tag]
The list of tags for the cluster.
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_list.is_none().
Sourcepub fn mode(&self) -> Option<&ClusterMode>
pub fn mode(&self) -> Option<&ClusterMode>
The mode of the cluster.
Trait Implementations§
impl StructuralPartialEq for Cluster
Auto Trait Implementations§
impl Freeze for Cluster
impl RefUnwindSafe for Cluster
impl Send for Cluster
impl Sync for Cluster
impl Unpin for Cluster
impl UnwindSafe for Cluster
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);