Struct CacheCluster

#[non_exhaustive]
pub struct CacheCluster {

    pub cache_cluster_id: Option<String>,
    pub configuration_endpoint: Option<Endpoint>,
    pub client_download_landing_page: Option<String>,
    pub cache_node_type: Option<String>,
    pub engine: Option<String>,
    pub engine_version: Option<String>,
    pub cache_cluster_status: Option<String>,
    pub num_cache_nodes: Option<i32>,
    pub preferred_availability_zone: Option<String>,
    pub preferred_outpost_arn: Option<String>,
    pub cache_cluster_create_time: Option<DateTime>,
    pub preferred_maintenance_window: Option<String>,
    pub pending_modified_values: Option<PendingModifiedValues>,
    pub notification_configuration: Option<NotificationConfiguration>,
    pub cache_security_groups: Option<Vec<CacheSecurityGroupMembership>>,
    pub cache_parameter_group: Option<CacheParameterGroupStatus>,
    pub cache_subnet_group_name: Option<String>,
    pub cache_nodes: Option<Vec<CacheNode>>,
    pub auto_minor_version_upgrade: Option<bool>,
    pub security_groups: Option<Vec<SecurityGroupMembership>>,
    pub replication_group_id: Option<String>,
    pub snapshot_retention_limit: Option<i32>,
    pub snapshot_window: Option<String>,
    pub auth_token_enabled: Option<bool>,
    pub auth_token_last_modified_date: Option<DateTime>,
    pub transit_encryption_enabled: Option<bool>,
    pub at_rest_encryption_enabled: Option<bool>,
    pub arn: Option<String>,
    pub replication_group_log_delivery_enabled: Option<bool>,
    pub log_delivery_configurations: Option<Vec<LogDeliveryConfiguration>>,
    pub network_type: Option<NetworkType>,
    pub ip_discovery: Option<IpDiscovery>,
    pub transit_encryption_mode: Option<TransitEncryptionMode>,
}

Contains all of the attributes of a specific cluster.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cache_cluster_id: Option<String>

The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

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

client_download_landing_page: Option<String>

The URL of the web page where you can download the latest ElastiCache client library.

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:

    M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

    For region availability, see Supported Node Types

    M6g node types (available only for Redis OSS 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

    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

    T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

    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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    C1 node types: cache.c1.xlarge

• Memory optimized:

  • Current generation:

    R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

    For region availability, see Supported Node Types

    R6g node types (available only for Redis OSS 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

    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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    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.

• Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

• Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

• The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

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.

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.

num_cache_nodes: Option<i32>

The number of cache nodes in the cluster.

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

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_outpost_arn: Option<String>

The outpost ARN in which the cache cluster is created.

cache_cluster_create_time: Option<DateTime>

The date and time when the cluster was created.

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

pending_modified_values: Option<PendingModifiedValues>

A group of settings that are applied to the cluster in the future, or that are currently being applied.

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).

cache_security_groups: Option<Vec<CacheSecurityGroupMembership>>

A list of cache security group elements, composed of name and status sub-elements.

cache_parameter_group: Option<CacheParameterGroupStatus>

Status of the cache parameter group.

cache_subnet_group_name: Option<String>

The name of the cache subnet group associated with the cluster.

cache_nodes: Option<Vec<CacheNode>>

A list of cache nodes that are members of the cluster.

auto_minor_version_upgrade: Option<bool>

 If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

security_groups: Option<Vec<SecurityGroupMembership>>

A list of VPC Security Groups associated with the cluster.

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.

snapshot_retention_limit: Option<i32>

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

auth_token_enabled: Option<bool>

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

Default: false

auth_token_last_modified_date: Option<DateTime>

The date the auth token was last modified

transit_encryption_enabled: Option<bool>

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

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 OSS version 3.2.6, 4.x or later.

Default: false

arn: Option<String>

The ARN (Amazon Resource Name) of the cache cluster.

replication_group_log_delivery_enabled: Option<bool>

A boolean value indicating whether log delivery is enabled for the replication group.

log_delivery_configurations: Option<Vec<LogDeliveryConfiguration>>

Returns the destination, format and type of the logs.

network_type: Option<NetworkType>

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

ip_discovery: Option<IpDiscovery>

The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

transit_encryption_mode: Option<TransitEncryptionMode>

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

Implementations

impl CacheCluster

pub fn cache_cluster_id(&self) -> Option<&str>

The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

pub fn configuration_endpoint(&self) -> 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

pub fn client_download_landing_page(&self) -> Option<&str>

The URL of the web page where you can download the latest ElastiCache client library.

pub fn cache_node_type(&self) -> Option<&str>

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:

    M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

    For region availability, see Supported Node Types

    M6g node types (available only for Redis OSS 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

    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

    T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

    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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    C1 node types: cache.c1.xlarge

• Memory optimized:

  • Current generation:

    R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

    For region availability, see Supported Node Types

    R6g node types (available only for Redis OSS 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

    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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    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.

• Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

• Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

• The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

pub fn engine(&self) -> Option<&str>

The name of the cache engine (memcached or redis) to be used for this cluster.

pub fn engine_version(&self) -> Option<&str>

The version of the cache engine that is used in this cluster.

pub fn cache_cluster_status(&self) -> Option<&str>

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.

pub fn num_cache_nodes(&self) -> Option<i32>

The number of cache nodes in the cluster.

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

pub fn preferred_availability_zone(&self) -> Option<&str>

The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

pub fn preferred_outpost_arn(&self) -> Option<&str>

The outpost ARN in which the cache cluster is created.

pub fn cache_cluster_create_time(&self) -> Option<&DateTime>

The date and time when the cluster was created.

pub fn preferred_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

pub fn pending_modified_values(&self) -> Option<&PendingModifiedValues>

A group of settings that are applied to the cluster in the future, or that are currently being applied.

pub fn notification_configuration(&self) -> 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).

pub fn cache_security_groups(&self) -> &[CacheSecurityGroupMembership]

A list of cache security group elements, composed of name and status sub-elements.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cache_security_groups.is_none().

pub fn cache_parameter_group(&self) -> Option<&CacheParameterGroupStatus>

Status of the cache parameter group.

pub fn cache_subnet_group_name(&self) -> Option<&str>

The name of the cache subnet group associated with the cluster.

pub fn cache_nodes(&self) -> &[CacheNode]

A list of cache nodes that are members of 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 .cache_nodes.is_none().

pub fn auto_minor_version_upgrade(&self) -> Option<bool>

 If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

pub fn security_groups(&self) -> &[SecurityGroupMembership]

A list of VPC Security Groups associated with 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 .security_groups.is_none().

pub fn replication_group_id(&self) -> Option<&str>

The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

pub fn snapshot_retention_limit(&self) -> Option<i32>

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.

pub fn snapshot_window(&self) -> Option<&str>

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Example: 05:00-09:00

pub fn auth_token_enabled(&self) -> Option<bool>

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

Default: false

pub fn auth_token_last_modified_date(&self) -> Option<&DateTime>

The date the auth token was last modified

pub fn transit_encryption_enabled(&self) -> Option<bool>

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

pub fn at_rest_encryption_enabled(&self) -> 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 OSS version 3.2.6, 4.x or later.

Default: false

pub fn arn(&self) -> Option<&str>

The ARN (Amazon Resource Name) of the cache cluster.

pub fn replication_group_log_delivery_enabled(&self) -> Option<bool>

A boolean value indicating whether log delivery is enabled for the replication group.

pub fn log_delivery_configurations(&self) -> &[LogDeliveryConfiguration]

Returns the destination, format and type of the logs.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .log_delivery_configurations.is_none().

pub fn network_type(&self) -> Option<&NetworkType>

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

pub fn ip_discovery(&self) -> Option<&IpDiscovery>

The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

pub fn transit_encryption_mode(&self) -> Option<&TransitEncryptionMode>

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

impl CacheCluster

pub fn builder() -> CacheClusterBuilder

Creates a new builder-style object to manufacture CacheCluster.

Trait Implementations

impl Clone for CacheCluster

fn clone(&self) -> CacheCluster

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CacheCluster

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CacheCluster

fn eq(&self, other: &CacheCluster) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CacheCluster