#[non_exhaustive]pub struct ClusterBuilder { /* private fields */ }
Expand description
A builder for Cluster
.
Implementations§
Source§impl ClusterBuilder
impl ClusterBuilder
Sourcepub fn cluster_name(self, input: impl Into<String>) -> Self
pub fn cluster_name(self, input: impl Into<String>) -> Self
The name of the DAX cluster.
Sourcepub fn set_cluster_name(self, input: Option<String>) -> Self
pub fn set_cluster_name(self, input: Option<String>) -> Self
The name of the DAX cluster.
Sourcepub fn get_cluster_name(&self) -> &Option<String>
pub fn get_cluster_name(&self) -> &Option<String>
The name of the DAX cluster.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the cluster.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the cluster.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the cluster.
Sourcepub fn cluster_arn(self, input: impl Into<String>) -> Self
pub fn cluster_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Sourcepub fn set_cluster_arn(self, input: Option<String>) -> Self
pub fn set_cluster_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Sourcepub fn get_cluster_arn(&self) -> &Option<String>
pub fn get_cluster_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Sourcepub fn total_nodes(self, input: i32) -> Self
pub fn total_nodes(self, input: i32) -> Self
The total number of nodes in the cluster.
Sourcepub fn set_total_nodes(self, input: Option<i32>) -> Self
pub fn set_total_nodes(self, input: Option<i32>) -> Self
The total number of nodes in the cluster.
Sourcepub fn get_total_nodes(&self) -> &Option<i32>
pub fn get_total_nodes(&self) -> &Option<i32>
The total number of nodes in the cluster.
Sourcepub fn active_nodes(self, input: i32) -> Self
pub fn active_nodes(self, input: i32) -> Self
The number of nodes in the cluster that are active (i.e., capable of serving requests).
Sourcepub fn set_active_nodes(self, input: Option<i32>) -> Self
pub fn set_active_nodes(self, input: Option<i32>) -> Self
The number of nodes in the cluster that are active (i.e., capable of serving requests).
Sourcepub fn get_active_nodes(&self) -> &Option<i32>
pub fn get_active_nodes(&self) -> &Option<i32>
The number of nodes in the cluster that are active (i.e., capable of serving requests).
Sourcepub fn node_type(self, input: impl Into<String>) -> Self
pub fn node_type(self, input: impl Into<String>) -> Self
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Sourcepub fn set_node_type(self, input: Option<String>) -> Self
pub fn set_node_type(self, input: Option<String>) -> Self
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Sourcepub fn get_node_type(&self) -> &Option<String>
pub fn get_node_type(&self) -> &Option<String>
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Sourcepub fn set_status(self, input: Option<String>) -> Self
pub fn set_status(self, input: Option<String>) -> Self
The current status of the cluster.
Sourcepub fn get_status(&self) -> &Option<String>
pub fn get_status(&self) -> &Option<String>
The current status of the cluster.
Sourcepub fn cluster_discovery_endpoint(self, input: Endpoint) -> Self
pub fn cluster_discovery_endpoint(self, input: Endpoint) -> Self
The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.
Sourcepub fn set_cluster_discovery_endpoint(self, input: Option<Endpoint>) -> Self
pub fn set_cluster_discovery_endpoint(self, input: Option<Endpoint>) -> Self
The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.
Sourcepub fn get_cluster_discovery_endpoint(&self) -> &Option<Endpoint>
pub fn get_cluster_discovery_endpoint(&self) -> &Option<Endpoint>
The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.
Sourcepub fn node_ids_to_remove(self, input: impl Into<String>) -> Self
pub fn node_ids_to_remove(self, input: impl Into<String>) -> Self
Appends an item to node_ids_to_remove
.
To override the contents of this collection use set_node_ids_to_remove
.
A list of nodes to be removed from the cluster.
Sourcepub fn set_node_ids_to_remove(self, input: Option<Vec<String>>) -> Self
pub fn set_node_ids_to_remove(self, input: Option<Vec<String>>) -> Self
A list of nodes to be removed from the cluster.
Sourcepub fn get_node_ids_to_remove(&self) -> &Option<Vec<String>>
pub fn get_node_ids_to_remove(&self) -> &Option<Vec<String>>
A list of nodes to be removed from the cluster.
Sourcepub fn nodes(self, input: Node) -> Self
pub fn nodes(self, input: Node) -> Self
Appends an item to nodes
.
To override the contents of this collection use set_nodes
.
A list of nodes that are currently in the cluster.
Sourcepub fn set_nodes(self, input: Option<Vec<Node>>) -> Self
pub fn set_nodes(self, input: Option<Vec<Node>>) -> Self
A list of nodes that are currently in the cluster.
Sourcepub fn get_nodes(&self) -> &Option<Vec<Node>>
pub fn get_nodes(&self) -> &Option<Vec<Node>>
A list of nodes that are currently in the cluster.
Sourcepub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self
pub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00
. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
Sourcepub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self
pub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00
. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
Sourcepub fn get_preferred_maintenance_window(&self) -> &Option<String>
pub fn get_preferred_maintenance_window(&self) -> &Option<String>
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00
. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
Sourcepub fn notification_configuration(
self,
input: NotificationConfiguration,
) -> Self
pub fn notification_configuration( self, input: NotificationConfiguration, ) -> Self
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
Sourcepub fn set_notification_configuration(
self,
input: Option<NotificationConfiguration>,
) -> Self
pub fn set_notification_configuration( self, input: Option<NotificationConfiguration>, ) -> Self
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
Sourcepub fn get_notification_configuration(
&self,
) -> &Option<NotificationConfiguration>
pub fn get_notification_configuration( &self, ) -> &Option<NotificationConfiguration>
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
Sourcepub fn subnet_group(self, input: impl Into<String>) -> Self
pub fn subnet_group(self, input: impl Into<String>) -> Self
The subnet group where the DAX cluster is running.
Sourcepub fn set_subnet_group(self, input: Option<String>) -> Self
pub fn set_subnet_group(self, input: Option<String>) -> Self
The subnet group where the DAX cluster is running.
Sourcepub fn get_subnet_group(&self) -> &Option<String>
pub fn get_subnet_group(&self) -> &Option<String>
The subnet group where the DAX cluster is running.
Sourcepub fn security_groups(self, input: SecurityGroupMembership) -> Self
pub fn security_groups(self, input: SecurityGroupMembership) -> Self
Appends an item to security_groups
.
To override the contents of this collection use set_security_groups
.
A list of security groups, and the status of each, for the nodes in the cluster.
Sourcepub fn set_security_groups(
self,
input: Option<Vec<SecurityGroupMembership>>,
) -> Self
pub fn set_security_groups( self, input: Option<Vec<SecurityGroupMembership>>, ) -> Self
A list of security groups, and the status of each, for the nodes in the cluster.
Sourcepub fn get_security_groups(&self) -> &Option<Vec<SecurityGroupMembership>>
pub fn get_security_groups(&self) -> &Option<Vec<SecurityGroupMembership>>
A list of security groups, and the status of each, for the nodes in the cluster.
Sourcepub fn iam_role_arn(self, input: impl Into<String>) -> Self
pub fn iam_role_arn(self, input: impl Into<String>) -> Self
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
Sourcepub fn set_iam_role_arn(self, input: Option<String>) -> Self
pub fn set_iam_role_arn(self, input: Option<String>) -> Self
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
Sourcepub fn get_iam_role_arn(&self) -> &Option<String>
pub fn get_iam_role_arn(&self) -> &Option<String>
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
Sourcepub fn parameter_group(self, input: ParameterGroupStatus) -> Self
pub fn parameter_group(self, input: ParameterGroupStatus) -> Self
The parameter group being used by nodes in the cluster.
Sourcepub fn set_parameter_group(self, input: Option<ParameterGroupStatus>) -> Self
pub fn set_parameter_group(self, input: Option<ParameterGroupStatus>) -> Self
The parameter group being used by nodes in the cluster.
Sourcepub fn get_parameter_group(&self) -> &Option<ParameterGroupStatus>
pub fn get_parameter_group(&self) -> &Option<ParameterGroupStatus>
The parameter group being used by nodes in the cluster.
Sourcepub fn sse_description(self, input: SseDescription) -> Self
pub fn sse_description(self, input: SseDescription) -> Self
The description of the server-side encryption status on the specified DAX cluster.
Sourcepub fn set_sse_description(self, input: Option<SseDescription>) -> Self
pub fn set_sse_description(self, input: Option<SseDescription>) -> Self
The description of the server-side encryption status on the specified DAX cluster.
Sourcepub fn get_sse_description(&self) -> &Option<SseDescription>
pub fn get_sse_description(&self) -> &Option<SseDescription>
The description of the server-side encryption status on the specified DAX cluster.
Sourcepub fn cluster_endpoint_encryption_type(
self,
input: ClusterEndpointEncryptionType,
) -> Self
pub fn cluster_endpoint_encryption_type( self, input: ClusterEndpointEncryptionType, ) -> Self
The type of encryption supported by the cluster's endpoint. Values are:
-
NONE
for no encryptionTLS
for Transport Layer Security
Sourcepub fn set_cluster_endpoint_encryption_type(
self,
input: Option<ClusterEndpointEncryptionType>,
) -> Self
pub fn set_cluster_endpoint_encryption_type( self, input: Option<ClusterEndpointEncryptionType>, ) -> Self
The type of encryption supported by the cluster's endpoint. Values are:
-
NONE
for no encryptionTLS
for Transport Layer Security
Sourcepub fn get_cluster_endpoint_encryption_type(
&self,
) -> &Option<ClusterEndpointEncryptionType>
pub fn get_cluster_endpoint_encryption_type( &self, ) -> &Option<ClusterEndpointEncryptionType>
The type of encryption supported by the cluster's endpoint. Values are:
-
NONE
for no encryptionTLS
for Transport Layer Security
Trait Implementations§
Source§impl Clone for ClusterBuilder
impl Clone for ClusterBuilder
Source§fn clone(&self) -> ClusterBuilder
fn clone(&self) -> ClusterBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ClusterBuilder
impl Debug for ClusterBuilder
Source§impl Default for ClusterBuilder
impl Default for ClusterBuilder
Source§fn default() -> ClusterBuilder
fn default() -> ClusterBuilder
Source§impl PartialEq for ClusterBuilder
impl PartialEq for ClusterBuilder
impl StructuralPartialEq for ClusterBuilder
Auto Trait Implementations§
impl Freeze for ClusterBuilder
impl RefUnwindSafe for ClusterBuilder
impl Send for ClusterBuilder
impl Sync for ClusterBuilder
impl Unpin for ClusterBuilder
impl UnwindSafe for ClusterBuilder
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>
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);