Struct aws_sdk_memorydb::operation::create_cluster::CreateClusterInput

#[non_exhaustive]
pub struct CreateClusterInput {

    pub cluster_name: Option<String>,
    pub node_type: 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_version: Option<String>,
    pub auto_minor_version_upgrade: Option<bool>,
    pub data_tiering: Option<bool>,
}

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

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.

tags: Option<Vec<Tag>>

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

The version number of the Redis 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.

Implementations

impl CreateClusterInput

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.

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

The compute and memory capacity of the nodes in the cluster.

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

The name of the parameter group associated with the cluster.

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

An optional description of the cluster.

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

The number of shards the cluster will contain. The default value is 1.

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.

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

The name of the subnet group to be used for the cluster.

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

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

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

The port number on which each of the nodes accepts connections.

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.

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

A flag to enable in-transit encryption on the cluster.

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

The ID of the KMS key used to encrypt the cluster.

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

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.

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 tags(&self) -> &[Tag]

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

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 to associate with the cluster.

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

The version number of the Redis engine to be used for the 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.

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.

impl CreateClusterInput

pub fn builder() -> CreateClusterInputBuilder

Creates a new builder-style object to manufacture CreateClusterInput.

Trait Implementations

impl Clone for CreateClusterInput

fn clone(&self) -> CreateClusterInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateClusterInput

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

Formats the value using the given formatter.

impl PartialEq for CreateClusterInput

fn eq(&self, other: &CreateClusterInput) -> 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 CreateClusterInput