Struct aws_sdk_memorydb::model::Cluster

#[non_exhaustive]
pub struct Cluster {

    pub name: Option<String>,
    pub description: Option<String>,
    pub status: Option<String>,
    pub pending_updates: Option<ClusterPendingUpdates>,
    pub number_of_shards: Option<i32>,
    pub shards: Option<Vec<Shard>>,
    pub availability_mode: Option<AzStatus>,
    pub cluster_endpoint: Option<Endpoint>,
    pub node_type: Option<String>,
    pub engine_version: Option<String>,
    pub engine_patch_version: Option<String>,
    pub parameter_group_name: Option<String>,
    pub parameter_group_status: Option<String>,
    pub security_groups: Option<Vec<SecurityGroupMembership>>,
    pub subnet_group_name: Option<String>,
    pub tls_enabled: Option<bool>,
    pub kms_key_id: Option<String>,
    pub arn: Option<String>,
    pub sns_topic_arn: Option<String>,
    pub sns_topic_status: Option<String>,
    pub snapshot_retention_limit: Option<i32>,
    pub maintenance_window: Option<String>,
    pub snapshot_window: Option<String>,
    pub acl_name: Option<String>,
    pub auto_minor_version_upgrade: Option<bool>,
}

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.

name: Option<String>

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

description: Option<String>

A description of the cluster

status: Option<String>

The status of the cluster. For example, Available, Updating, Creating.

pending_updates: Option<ClusterPendingUpdates>

A group of settings that are currently being applied.

number_of_shards: Option<i32>

The number of shards in the cluster

shards: Option<Vec<Shard>>

A list of shards that are members of the cluster.

availability_mode: Option<AzStatus>

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

cluster_endpoint: Option<Endpoint>

The cluster's configuration endpoint

node_type: Option<String>

The cluster's node type

engine_version: Option<String>

The Redis engine version used by the cluster

engine_patch_version: Option<String>

The Redis engine patch version used by the cluster

parameter_group_name: Option<String>

The name of the parameter group used by the cluster

parameter_group_status: Option<String>

The status of the parameter group used by the cluster, for example 'active' or 'applying'.

security_groups: Option<Vec<SecurityGroupMembership>>

A list of security groups used by the cluster

subnet_group_name: Option<String>

The name of the subnet group used by the cluster

tls_enabled: Option<bool>

A flag to indicate if In-transit encryption is enabled

kms_key_id: Option<String>

The ID of the KMS key used to encrypt the cluster

arn: Option<String>

The Amazon Resource Name (ARN) of the cluster.

sns_topic_arn: Option<String>

The Amazon Resource Name (ARN) of the SNS notification topic

sns_topic_status: Option<String>

The SNS topic must be in Active status to receive notifications

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.

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.

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 associated with this cluster.

auto_minor_version_upgrade: Option<bool>

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Implementations

impl Cluster

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

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

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

A description of the cluster

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

The status of the cluster. For example, Available, Updating, Creating.

pub fn pending_updates(&self) -> Option<&ClusterPendingUpdates>

A group of settings that are currently being applied.

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

The number of shards in the cluster

pub fn shards(&self) -> Option<&[Shard]>

A list of shards that are members of the cluster.

pub fn availability_mode(&self) -> Option<&AzStatus>

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

pub fn cluster_endpoint(&self) -> Option<&Endpoint>

The cluster's configuration endpoint

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

The cluster's node type

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

The Redis engine version used by the cluster

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

The Redis engine patch version used by the cluster

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

The name of the parameter group used by the cluster

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

The status of the parameter group used by the cluster, for example 'active' or 'applying'.

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

A list of security groups used by the cluster

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

The name of the subnet group used by the cluster

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

A flag to indicate if In-transit encryption is enabled

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

The ID of the KMS key used to encrypt the cluster

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

The Amazon Resource Name (ARN) of the cluster.

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

The Amazon Resource Name (ARN) of the SNS notification topic

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

The SNS topic must be in Active status to receive notifications

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.

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.

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.

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

The name of the Access Control List associated with this cluster.

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

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

impl Cluster

pub fn builder() -> Builder

Creates a new builder-style object to manufacture Cluster

Trait Implementations

impl Clone for Cluster

fn clone(&self) -> Cluster

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cluster

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

Formats the value using the given formatter.

impl PartialEq<Cluster> for Cluster

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Cluster