#[non_exhaustive]pub struct CreateClusterInput {Show 26 fields
pub cluster_name: Option<String>,
pub node_type: Option<String>,
pub multi_region_cluster_name: Option<String>,
pub parameter_group_name: Option<String>,
pub description: Option<String>,
pub num_shards: Option<i32>,
pub num_replicas_per_shard: Option<i32>,
pub subnet_group_name: Option<String>,
pub security_group_ids: Option<Vec<String>>,
pub maintenance_window: Option<String>,
pub port: Option<i32>,
pub sns_topic_arn: Option<String>,
pub tls_enabled: Option<bool>,
pub kms_key_id: Option<String>,
pub snapshot_arns: Option<Vec<String>>,
pub snapshot_name: Option<String>,
pub snapshot_retention_limit: Option<i32>,
pub tags: Option<Vec<Tag>>,
pub snapshot_window: Option<String>,
pub acl_name: Option<String>,
pub engine: Option<String>,
pub engine_version: Option<String>,
pub auto_minor_version_upgrade: Option<bool>,
pub data_tiering: Option<bool>,
pub network_type: Option<NetworkType>,
pub ip_discovery: Option<IpDiscovery>,
}
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.cluster_name: Option<String>
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
node_type: Option<String>
The compute and memory capacity of the nodes in the cluster.
multi_region_cluster_name: Option<String>
The name of the multi-Region cluster to be created.
parameter_group_name: Option<String>
The name of the parameter group associated with the cluster.
description: Option<String>
An optional description of the cluster.
num_shards: Option<i32>
The number of shards the cluster will contain. The default value is 1.
num_replicas_per_shard: Option<i32>
The number of replicas to apply to each shard. The default value is 1. The maximum is 5.
subnet_group_name: Option<String>
The name of the subnet group to be used for the cluster.
security_group_ids: Option<Vec<String>>
A list of security group names to associate with this cluster.
maintenance_window: Option<String>
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd
are:
-
sun
-
mon
-
tue
-
wed
-
thu
-
fri
-
sat
Example: sun:23:00-mon:01:30
port: Option<i32>
The port number on which each of the nodes accepts connections.
sns_topic_arn: Option<String>
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
tls_enabled: Option<bool>
A flag to enable in-transit encryption on the cluster.
kms_key_id: Option<String>
The ID of the KMS key used to encrypt the cluster.
snapshot_arns: Option<Vec<String>>
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
snapshot_name: Option<String>
The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
snapshot_retention_limit: Option<i32>
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
snapshot_window: Option<String>
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
acl_name: Option<String>
The name of the Access Control List to associate with the cluster.
engine: Option<String>
The name of the engine to be used for the cluster.
engine_version: Option<String>
The version number of the Redis OSS engine to be used for the cluster.
auto_minor_version_upgrade: Option<bool>
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
data_tiering: Option<bool>
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
network_type: Option<NetworkType>
Specifies the IP address type for the cluster. Valid values are 'ipv4', 'ipv6', or 'dual_stack'. When set to 'ipv4', the cluster will only be accessible via IPv4 addresses. When set to 'ipv6', the cluster will only be accessible via IPv6 addresses. When set to 'dual_stack', the cluster will be accessible via both IPv4 and IPv6 addresses. If not specified, the default is 'ipv4'.
ip_discovery: Option<IpDiscovery>
The mechanism for discovering IP addresses for the cluster discovery protocol. Valid values are 'ipv4' or 'ipv6'. When set to 'ipv4', cluster discovery functions such as cluster slots, cluster shards, and cluster nodes return IPv4 addresses for cluster nodes. When set to 'ipv6', the cluster discovery functions return IPv6 addresses for cluster nodes. The value must be compatible with the NetworkType parameter. If not specified, the default is 'ipv4'.
Implementations§
Source§impl CreateClusterInput
impl CreateClusterInput
Sourcepub fn cluster_name(&self) -> Option<&str>
pub fn cluster_name(&self) -> Option<&str>
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
Sourcepub fn node_type(&self) -> Option<&str>
pub fn node_type(&self) -> Option<&str>
The compute and memory capacity of the nodes in the cluster.
Sourcepub fn multi_region_cluster_name(&self) -> Option<&str>
pub fn multi_region_cluster_name(&self) -> Option<&str>
The name of the multi-Region cluster to be created.
Sourcepub fn parameter_group_name(&self) -> Option<&str>
pub fn parameter_group_name(&self) -> Option<&str>
The name of the parameter group associated with the cluster.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
An optional description of the cluster.
Sourcepub fn num_shards(&self) -> Option<i32>
pub fn num_shards(&self) -> Option<i32>
The number of shards the cluster will contain. The default value is 1.
Sourcepub fn num_replicas_per_shard(&self) -> Option<i32>
pub fn num_replicas_per_shard(&self) -> Option<i32>
The number of replicas to apply to each shard. The default value is 1. The maximum is 5.
Sourcepub fn subnet_group_name(&self) -> Option<&str>
pub fn subnet_group_name(&self) -> Option<&str>
The name of the subnet group to be used for the cluster.
Sourcepub fn security_group_ids(&self) -> &[String]
pub fn security_group_ids(&self) -> &[String]
A list of security group names to associate with this 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 .security_group_ids.is_none()
.
Sourcepub fn maintenance_window(&self) -> Option<&str>
pub fn maintenance_window(&self) -> Option<&str>
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd
are:
-
sun
-
mon
-
tue
-
wed
-
thu
-
fri
-
sat
Example: sun:23:00-mon:01:30
Sourcepub fn port(&self) -> Option<i32>
pub fn port(&self) -> Option<i32>
The port number on which each of the nodes accepts connections.
Sourcepub fn sns_topic_arn(&self) -> Option<&str>
pub fn sns_topic_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
Sourcepub fn tls_enabled(&self) -> Option<bool>
pub fn tls_enabled(&self) -> Option<bool>
A flag to enable in-transit encryption on the cluster.
Sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The ID of the KMS key used to encrypt the cluster.
Sourcepub fn snapshot_arns(&self) -> &[String]
pub fn snapshot_arns(&self) -> &[String]
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .snapshot_arns.is_none()
.
Sourcepub fn snapshot_name(&self) -> Option<&str>
pub fn snapshot_name(&self) -> Option<&str>
The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
Sourcepub fn snapshot_retention_limit(&self) -> Option<i32>
pub fn snapshot_retention_limit(&self) -> Option<i32>
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
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 snapshot_window(&self) -> Option<&str>
pub fn snapshot_window(&self) -> Option<&str>
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
Sourcepub fn acl_name(&self) -> Option<&str>
pub fn acl_name(&self) -> Option<&str>
The name of the Access Control List to associate with the cluster.
Sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
The version number of the Redis OSS engine to be used for the cluster.
Sourcepub fn auto_minor_version_upgrade(&self) -> Option<bool>
pub fn auto_minor_version_upgrade(&self) -> Option<bool>
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
Sourcepub fn data_tiering(&self) -> Option<bool>
pub fn data_tiering(&self) -> Option<bool>
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Sourcepub fn network_type(&self) -> Option<&NetworkType>
pub fn network_type(&self) -> Option<&NetworkType>
Specifies the IP address type for the cluster. Valid values are 'ipv4', 'ipv6', or 'dual_stack'. When set to 'ipv4', the cluster will only be accessible via IPv4 addresses. When set to 'ipv6', the cluster will only be accessible via IPv6 addresses. When set to 'dual_stack', the cluster will be accessible via both IPv4 and IPv6 addresses. If not specified, the default is 'ipv4'.
Sourcepub fn ip_discovery(&self) -> Option<&IpDiscovery>
pub fn ip_discovery(&self) -> Option<&IpDiscovery>
The mechanism for discovering IP addresses for the cluster discovery protocol. Valid values are 'ipv4' or 'ipv6'. When set to 'ipv4', cluster discovery functions such as cluster slots, cluster shards, and cluster nodes return IPv4 addresses for cluster nodes. When set to 'ipv6', the cluster discovery functions return IPv6 addresses for cluster nodes. The value must be compatible with the NetworkType parameter. If not specified, the default is 'ipv4'.
Source§impl CreateClusterInput
impl CreateClusterInput
Sourcepub fn builder() -> CreateClusterInputBuilder
pub fn builder() -> CreateClusterInputBuilder
Creates a new builder-style object to manufacture CreateClusterInput
.
Trait Implementations§
Source§impl Clone for CreateClusterInput
impl Clone for CreateClusterInput
Source§fn clone(&self) -> CreateClusterInput
fn clone(&self) -> CreateClusterInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateClusterInput
impl Debug for CreateClusterInput
Source§impl PartialEq for CreateClusterInput
impl PartialEq for CreateClusterInput
impl StructuralPartialEq for CreateClusterInput
Auto Trait Implementations§
impl Freeze for CreateClusterInput
impl RefUnwindSafe for CreateClusterInput
impl Send for CreateClusterInput
impl Sync for CreateClusterInput
impl Unpin for CreateClusterInput
impl UnwindSafe for CreateClusterInput
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);