Struct aws_sdk_elasticache::input::ModifyReplicationGroupInput

source · [−]

#[non_exhaustive]
pub struct ModifyReplicationGroupInput {Show 25 fields
    pub replication_group_id: Option<String>,
    pub replication_group_description: Option<String>,
    pub primary_cluster_id: Option<String>,
    pub snapshotting_cluster_id: Option<String>,
    pub automatic_failover_enabled: Option<bool>,
    pub multi_az_enabled: Option<bool>,
    pub node_group_id: Option<String>,
    pub cache_security_group_names: Option<Vec<String>>,
    pub security_group_ids: Option<Vec<String>>,
    pub preferred_maintenance_window: Option<String>,
    pub notification_topic_arn: Option<String>,
    pub cache_parameter_group_name: Option<String>,
    pub notification_topic_status: Option<String>,
    pub apply_immediately: bool,
    pub engine_version: Option<String>,
    pub auto_minor_version_upgrade: Option<bool>,
    pub snapshot_retention_limit: Option<i32>,
    pub snapshot_window: Option<String>,
    pub cache_node_type: Option<String>,
    pub auth_token: Option<String>,
    pub auth_token_update_strategy: Option<AuthTokenUpdateStrategyType>,
    pub user_group_ids_to_add: Option<Vec<String>>,
    pub user_group_ids_to_remove: Option<Vec<String>>,
    pub remove_user_groups: Option<bool>,
    pub log_delivery_configurations: Option<Vec<LogDeliveryConfigurationRequest>>,
}

Expand description

Represents the input of a ModifyReplicationGroups 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.

replication_group_id: Option<String>

The identifier of the replication group to modify.

replication_group_description: Option<String>

A description for the replication group. Maximum length is 255 characters.

primary_cluster_id: Option<String>

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

snapshotting_cluster_id: Option<String>

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

automatic_failover_enabled: Option<bool>

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

multi_az_enabled: Option<bool>

A flag to indicate MultiAZ is enabled.

node_group_id: Option<String>

Deprecated. This parameter is not used.

cache_security_group_names: Option<Vec<String>>

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

security_group_ids: Option<Vec<String>>

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

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

notification_topic_arn: Option<String>

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

The Amazon SNS topic owner must be same as the replication group owner.

cache_parameter_group_name: Option<String>

The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

notification_topic_status: Option<String>

The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

Valid values: active | inactive

apply_immediately: bool

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

engine_version: Option<String>

The upgraded version of the cache engine to be run on the clusters in the replication group.

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 replication group and create it anew with the earlier engine version.

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 node group (shard) 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.

Important 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 the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

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

cache_node_type: Option<String>

A valid cache node type that you want to scale this replication group to.

auth_token: Option<String>

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:

Must be only printable ASCII characters
Must be at least 16 characters and no more than 128 characters in length
Cannot contain any of the following characters: '/', '"', or '@', '%'

For more information, see AUTH password at AUTH.

auth_token_update_strategy: Option<AuthTokenUpdateStrategyType>

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

Rotate
Set

For more information, see Authenticating Users with Redis AUTH

user_group_ids_to_add: Option<Vec<String>>

The ID of the user group you are associating with the replication group.

user_group_ids_to_remove: Option<Vec<String>>

The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.

remove_user_groups: Option<bool>

Removes the user group associated with this replication group.

log_delivery_configurations: Option<Vec<LogDeliveryConfigurationRequest>>

Specifies the destination, format and type of the logs.

Struct aws_sdk_elasticache::input::ModifyReplicationGroupInput

Fields (Non-exhaustive)

Implementations

impl ModifyReplicationGroupInput

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

pub fn builder() -> Builder

impl ModifyReplicationGroupInput

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn apply_immediately(&self) -> bool

pub fn engine_version(&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 cache_node_type(&self) -> Option<&str>

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

pub fn auth_token_update_strategy(&self) -> Option<&AuthTokenUpdateStrategyType>

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

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

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

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

Trait Implementations

impl Clone for ModifyReplicationGroupInput

fn clone(&self) -> ModifyReplicationGroupInput

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

impl Debug for ModifyReplicationGroupInput

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

impl PartialEq<ModifyReplicationGroupInput> for ModifyReplicationGroupInput

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

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

impl StructuralPartialEq for ModifyReplicationGroupInput

Auto Trait Implementations

impl RefUnwindSafe for ModifyReplicationGroupInput

impl Send for ModifyReplicationGroupInput

impl Sync for ModifyReplicationGroupInput

impl Unpin for ModifyReplicationGroupInput

impl UnwindSafe for ModifyReplicationGroupInput

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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<ModifyReplicationGroup, AwsErrorRetryPolicy>, BuildError>

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

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

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

pub fn user_group_ids_to_remove(&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>,