Struct aws_sdk_dax::types::Cluster

#[non_exhaustive]
pub struct Cluster {

    pub cluster_name: Option<String>,
    pub description: Option<String>,
    pub cluster_arn: Option<String>,
    pub total_nodes: Option<i32>,
    pub active_nodes: Option<i32>,
    pub node_type: Option<String>,
    pub status: Option<String>,
    pub cluster_discovery_endpoint: Option<Endpoint>,
    pub node_ids_to_remove: Option<Vec<String>>,
    pub nodes: Option<Vec<Node>>,
    pub preferred_maintenance_window: Option<String>,
    pub notification_configuration: Option<NotificationConfiguration>,
    pub subnet_group: Option<String>,
    pub security_groups: Option<Vec<SecurityGroupMembership>>,
    pub iam_role_arn: Option<String>,
    pub parameter_group: Option<ParameterGroupStatus>,
    pub sse_description: Option<SseDescription>,
    pub cluster_endpoint_encryption_type: Option<ClusterEndpointEncryptionType>,
}

Contains all of the attributes of a specific DAX 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.

cluster_name: Option<String>

The name of the DAX cluster.

description: Option<String>

The description of the cluster.

cluster_arn: Option<String>

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

total_nodes: Option<i32>

The total number of nodes in the cluster.

active_nodes: Option<i32>

The number of nodes in the cluster that are active (i.e., capable of serving requests).

node_type: Option<String>

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

status: Option<String>

The current status of the cluster.

cluster_discovery_endpoint: 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.

node_ids_to_remove: Option<Vec<String>>

A list of nodes to be removed from the cluster.

nodes: Option<Vec<Node>>

A list of nodes that are currently in the cluster.

preferred_maintenance_window: 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.

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

subnet_group: Option<String>

The subnet group where the DAX cluster is running.

security_groups: Option<Vec<SecurityGroupMembership>>

A list of security groups, and the status of each, for the nodes in the cluster.

iam_role_arn: 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.

parameter_group: Option<ParameterGroupStatus>

The parameter group being used by nodes in the cluster.

sse_description: Option<SseDescription>

The description of the server-side encryption status on the specified DAX cluster.

cluster_endpoint_encryption_type: Option<ClusterEndpointEncryptionType>

The type of encryption supported by the cluster's endpoint. Values are:

• NONE for no encryption

  TLS for Transport Layer Security

Implementations

impl Cluster

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

The name of the DAX cluster.

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

The description of the cluster.

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

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

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

The total number of nodes in the cluster.

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

The number of nodes in the cluster that are active (i.e., capable of serving requests).

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

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

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

The current status of the cluster.

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

pub fn node_ids_to_remove(&self) -> &[String]

A list of nodes to be removed from 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 .node_ids_to_remove.is_none().

pub fn nodes(&self) -> &[Node]

A list of nodes that are currently in 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 .nodes.is_none().

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

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.

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

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

The subnet group where the DAX cluster is running.

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

A list of security groups, and the status of each, for the nodes in 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 iam_role_arn(&self) -> Option<&str>

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.

pub fn parameter_group(&self) -> Option<&ParameterGroupStatus>

The parameter group being used by nodes in the cluster.

pub fn sse_description(&self) -> Option<&SseDescription>

The description of the server-side encryption status on the specified DAX cluster.

pub fn cluster_endpoint_encryption_type( &self ) -> Option<&ClusterEndpointEncryptionType>

The type of encryption supported by the cluster's endpoint. Values are:

• NONE for no encryption

  TLS for Transport Layer Security

impl Cluster

pub fn builder() -> ClusterBuilder

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 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: &Rhs) -> bool

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

impl StructuralPartialEq for Cluster