Struct rusoto_elasticache::CacheCluster
source · [−]pub struct CacheCluster {Show 30 fields
pub arn: Option<String>,
pub at_rest_encryption_enabled: Option<bool>,
pub auth_token_enabled: Option<bool>,
pub auth_token_last_modified_date: Option<String>,
pub auto_minor_version_upgrade: Option<bool>,
pub cache_cluster_create_time: Option<String>,
pub cache_cluster_id: Option<String>,
pub cache_cluster_status: Option<String>,
pub cache_node_type: Option<String>,
pub cache_nodes: Option<Vec<CacheNode>>,
pub cache_parameter_group: Option<CacheParameterGroupStatus>,
pub cache_security_groups: Option<Vec<CacheSecurityGroupMembership>>,
pub cache_subnet_group_name: Option<String>,
pub client_download_landing_page: Option<String>,
pub configuration_endpoint: Option<Endpoint>,
pub engine: Option<String>,
pub engine_version: Option<String>,
pub log_delivery_configurations: Option<Vec<LogDeliveryConfiguration>>,
pub notification_configuration: Option<NotificationConfiguration>,
pub num_cache_nodes: Option<i64>,
pub pending_modified_values: Option<PendingModifiedValues>,
pub preferred_availability_zone: Option<String>,
pub preferred_maintenance_window: Option<String>,
pub preferred_outpost_arn: Option<String>,
pub replication_group_id: Option<String>,
pub replication_group_log_delivery_enabled: Option<bool>,
pub security_groups: Option<Vec<SecurityGroupMembership>>,
pub snapshot_retention_limit: Option<i64>,
pub snapshot_window: Option<String>,
pub transit_encryption_enabled: Option<bool>,
}
Expand description
Contains all of the attributes of a specific cluster.
Fields
arn: Option<String>
The ARN (Amazon Resource Name) of the cache cluster.
at_rest_encryption_enabled: Option<bool>
A flag that enables encryption at-rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled
to true
when you create a cluster.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
Default: false
auth_token_enabled: Option<bool>
A flag that enables using an AuthToken
(password) when issuing Redis commands.
Default: false
auth_token_last_modified_date: Option<String>
The date the auth token was last modified
auto_minor_version_upgrade: Option<bool>
This parameter is currently disabled.
cache_cluster_create_time: Option<String>
The date and time when the cluster was created.
cache_cluster_id: Option<String>
The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
cache_cluster_status: Option<String>
The current state of this cluster, one of the following values: available
, creating
, deleted
, deleting
, incompatible-network
, modifying
, rebooting cluster nodes
, restore-failed
, or snapshotting
.
cache_node_type: Option<String>
The name of the compute and memory capacity node type for the cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
-
General purpose:
-
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.m6g.large
,cache.m6g.xlarge
,cache.m6g.2xlarge
,cache.m6g.4xlarge
,cache.m6g.8xlarge
,cache.m6g.12xlarge
,cache.m6g.16xlarge
For region availability, see Supported Node Types
M5 node types:
cache.m5.large
,cache.m5.xlarge
,cache.m5.2xlarge
,cache.m5.4xlarge
,cache.m5.12xlarge
,cache.m5.24xlarge
M4 node types:
cache.m4.large
,cache.m4.xlarge
,cache.m4.2xlarge
,cache.m4.4xlarge
,cache.m4.10xlarge
T3 node types:
cache.t3.micro
,cache.t3.small
,cache.t3.medium
T2 node types:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
-
Previous generation: (not recommended)
T1 node types:
cache.t1.micro
M1 node types:
cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
M3 node types:
cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
-
-
Compute optimized:
-
Previous generation: (not recommended)
C1 node types:
cache.c1.xlarge
-
-
Memory optimized:
-
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large
,cache.r6g.xlarge
,cache.r6g.2xlarge
,cache.r6g.4xlarge
,cache.r6g.8xlarge
,cache.r6g.12xlarge
,cache.r6g.16xlarge
For region availability, see Supported Node Types
R5 node types:
cache.r5.large
,cache.r5.xlarge
,cache.r5.2xlarge
,cache.r5.4xlarge
,cache.r5.12xlarge
,cache.r5.24xlarge
R4 node types:
cache.r4.large
,cache.r4.xlarge
,cache.r4.2xlarge
,cache.r4.4xlarge
,cache.r4.8xlarge
,cache.r4.16xlarge
-
Previous generation: (not recommended)
M2 node types:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
R3 node types:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
-
Additional node type info
-
All current generation instance types are created in Amazon VPC by default.
-
Redis append-only files (AOF) are not supported for T1 or T2 instances.
-
Redis Multi-AZ with automatic failover is not supported on T1 instances.
-
Redis configuration variables
appendonly
andappendfsync
are not supported on Redis version 2.8.22 and later.
cache_nodes: Option<Vec<CacheNode>>
A list of cache nodes that are members of the cluster.
cache_parameter_group: Option<CacheParameterGroupStatus>
Status of the cache parameter group.
cache_security_groups: Option<Vec<CacheSecurityGroupMembership>>
A list of cache security group elements, composed of name and status sub-elements.
cache_subnet_group_name: Option<String>
The name of the cache subnet group associated with the cluster.
client_download_landing_page: Option<String>
The URL of the web page where you can download the latest ElastiCache client library.
configuration_endpoint: Option<Endpoint>
Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg
in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
engine: Option<String>
The name of the cache engine (memcached
or redis
) to be used for this cluster.
engine_version: Option<String>
The version of the cache engine that is used in this cluster.
log_delivery_configurations: Option<Vec<LogDeliveryConfiguration>>
Returns the destination, format and type of the logs.
notification_configuration: Option<NotificationConfiguration>
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
num_cache_nodes: Option<i64>
The number of cache nodes in the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
pending_modified_values: Option<PendingModifiedValues>
preferred_availability_zone: Option<String>
The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
preferred_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
preferred_outpost_arn: Option<String>
The outpost ARN in which the cache cluster is created.
replication_group_id: Option<String>
The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
replication_group_log_delivery_enabled: Option<bool>
A boolean value indicating whether log delivery is enabled for the replication group.
security_groups: Option<Vec<SecurityGroupMembership>>
A list of VPC Security Groups associated with the cluster.
snapshot_retention_limit: Option<i64>
The number of days for which ElastiCache retains automatic cluster 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.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
snapshot_window: Option<String>
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Example: 05:00-09:00
transit_encryption_enabled: Option<bool>
A flag that enables in-transit encryption when set to true
.
You cannot modify the value of TransitEncryptionEnabled
after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled
to true
when you create a cluster.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
Default: false
Trait Implementations
sourceimpl Clone for CacheCluster
impl Clone for CacheCluster
sourcefn clone(&self) -> CacheCluster
fn clone(&self) -> CacheCluster
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CacheCluster
impl Debug for CacheCluster
sourceimpl Default for CacheCluster
impl Default for CacheCluster
sourcefn default() -> CacheCluster
fn default() -> CacheCluster
Returns the “default value” for a type. Read more
sourceimpl PartialEq<CacheCluster> for CacheCluster
impl PartialEq<CacheCluster> for CacheCluster
sourcefn eq(&self, other: &CacheCluster) -> bool
fn eq(&self, other: &CacheCluster) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CacheCluster) -> bool
fn ne(&self, other: &CacheCluster) -> bool
This method tests for !=
.
impl StructuralPartialEq for CacheCluster
Auto Trait Implementations
impl RefUnwindSafe for CacheCluster
impl Send for CacheCluster
impl Sync for CacheCluster
impl Unpin for CacheCluster
impl UnwindSafe for CacheCluster
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more