Struct aws_sdk_elasticache::input::CreateCacheClusterInput

source · [−]

#[non_exhaustive]
pub struct CreateCacheClusterInput {Show 27 fields
    pub cache_cluster_id: Option<String>,
    pub replication_group_id: Option<String>,
    pub az_mode: Option<AzMode>,
    pub preferred_availability_zone: Option<String>,
    pub preferred_availability_zones: Option<Vec<String>>,
    pub num_cache_nodes: Option<i32>,
    pub cache_node_type: Option<String>,
    pub engine: Option<String>,
    pub engine_version: Option<String>,
    pub cache_parameter_group_name: Option<String>,
    pub cache_subnet_group_name: Option<String>,
    pub cache_security_group_names: Option<Vec<String>>,
    pub security_group_ids: Option<Vec<String>>,
    pub tags: Option<Vec<Tag>>,
    pub snapshot_arns: Option<Vec<String>>,
    pub snapshot_name: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub port: Option<i32>,
    pub notification_topic_arn: Option<String>,
    pub auto_minor_version_upgrade: Option<bool>,
    pub snapshot_retention_limit: Option<i32>,
    pub snapshot_window: Option<String>,
    pub auth_token: Option<String>,
    pub outpost_mode: Option<OutpostMode>,
    pub preferred_outpost_arn: Option<String>,
    pub preferred_outpost_arns: Option<Vec<String>>,
    pub log_delivery_configurations: Option<Vec<LogDeliveryConfigurationRequest>>,
}

Expand description

Represents the input of a CreateCacheCluster operation.

Fields (Non-exhaustive)

This struct is marked as 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 node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

A name must contain from 1 to 50 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.

replication_group_id: Option<String>

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

az_mode: Option<AzMode>

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

preferred_availability_zone: Option<String>

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

preferred_availability_zones: Option<Vec<String>>

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheNodes.

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

num_cache_nodes: Option<i32>

The initial number of cache nodes that the cluster has.

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

If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

cache_node_type: Option<String>

The compute and memory capacity of the nodes in the node group (shard).

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
  
  T4g node types (available only for Redis 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)
  
  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 with data tiering:
- Current generation:
  
  R6gd node types (available only for Redis engine version 6.2 onward).
  
  cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge
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 and appendfsync are not supported on Redis version 2.8.22 and later.

engine: Option<String>

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

engine_version: Option<String>

The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

cache_parameter_group_name: Option<String>

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

cache_subnet_group_name: Option<String>

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

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

cache_security_group_names: Option<Vec<String>>

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

security_group_ids: Option<Vec<String>>

One or more VPC security groups associated with the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

tags: Option<Vec<Tag>>

A list of tags to be added to this resource.

snapshot_arns: Option<Vec<String>>

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

snapshot_name: Option<String>

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

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:

port: Option<i32>

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

notification_topic_arn: Option<String>

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

auto_minor_version_upgrade: Option<bool>

If you are running Redis 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.

snapshot_retention_limit: Option<i32>

The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

snapshot_window: Option<String>

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

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

auth_token: Option<String>

Reserved parameter. The password used to access a password protected server.

Password constraints:

Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

outpost_mode: Option<OutpostMode>

Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

preferred_outpost_arn: Option<String>

The outpost ARN in which the cache cluster is created.

preferred_outpost_arns: Option<Vec<String>>

The outpost ARNs in which the cache cluster is created.

log_delivery_configurations: Option<Vec<LogDeliveryConfigurationRequest>>

Specifies the destination, format and type of the logs.

Struct aws_sdk_elasticache::input::CreateCacheClusterInput

Fields (Non-exhaustive)

Implementations

impl CreateCacheClusterInput

pub async fn make_operation( &self, _config: &Config) -> Result<Operation<CreateCacheCluster, AwsErrorRetryPolicy>, BuildError>

pub fn builder() -> Builder

impl CreateCacheClusterInput

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

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

pub fn az_mode(&self) -> Option<&AzMode>

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

pub fn preferred_availability_zones(&self) -> Option<&[String]>

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

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

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

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

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

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

pub fn cache_security_group_names(&self) -> Option<&[String]>

pub fn security_group_ids(&self) -> Option<&[String]>

pub fn tags(&self) -> Option<&[Tag]>

pub fn snapshot_arns(&self) -> Option<&[String]>

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

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

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

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

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

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

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

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

pub fn outpost_mode(&self) -> Option<&OutpostMode>

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

pub fn preferred_outpost_arns(&self) -> Option<&[String]>

pub fn log_delivery_configurations( &self) -> Option<&[LogDeliveryConfigurationRequest]>

Trait Implementations

impl Clone for CreateCacheClusterInput

fn clone(&self) -> CreateCacheClusterInput

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

impl Debug for CreateCacheClusterInput

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

impl PartialEq<CreateCacheClusterInput> for CreateCacheClusterInput

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

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

impl StructuralPartialEq for CreateCacheClusterInput

Auto Trait Implementations

impl RefUnwindSafe for CreateCacheClusterInput

impl Send for CreateCacheClusterInput

impl Sync for CreateCacheClusterInput

impl Unpin for CreateCacheClusterInput

impl UnwindSafe for CreateCacheClusterInput

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateCacheCluster, AwsErrorRetryPolicy>, BuildError>

pub fn preferred_availability_zones(&self) -> Option<&[String ]>

pub fn cache_security_group_names(&self) -> Option<&[String ]>

pub fn security_group_ids(&self) -> Option<&[String ]>

pub fn tags(&self) -> Option<&[Tag ]>

pub fn snapshot_arns(&self) -> Option<&[String ]>

pub fn preferred_outpost_arns(&self) -> Option<&[String ]>

pub fn log_delivery_configurations(
&self
) -> Option<&[LogDeliveryConfigurationRequest ]>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,