Struct aws_sdk_elasticache::model::snapshot::Builder

pub struct Builder { /* private fields */ }

A builder for Snapshot.

Implementations

impl Builder

pub fn snapshot_name(self, input: impl Into<String>) -> Self

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

pub fn set_snapshot_name(self, input: Option<String>) -> Self

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

pub fn replication_group_id(self, input: impl Into<String>) -> Self

The unique identifier of the source replication group.

pub fn set_replication_group_id(self, input: Option<String>) -> Self

The unique identifier of the source replication group.

pub fn replication_group_description(self, input: impl Into<String>) -> Self

A description of the source replication group.

pub fn set_replication_group_description(self, input: Option<String>) -> Self

A description of the source replication group.

pub fn cache_cluster_id(self, input: impl Into<String>) -> Self

The user-supplied identifier of the source cluster.

pub fn set_cache_cluster_id(self, input: Option<String>) -> Self

The user-supplied identifier of the source cluster.

pub fn snapshot_status(self, input: impl Into<String>) -> Self

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

pub fn set_snapshot_status(self, input: Option<String>) -> Self

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

pub fn snapshot_source(self, input: impl Into<String>) -> Self

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

pub fn set_snapshot_source(self, input: Option<String>) -> Self

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

pub fn cache_node_type(self, input: impl Into<String>) -> Self

The name of the compute and memory capacity node type for the source cluster.

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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    C1 node types: cache.c1.xlarge

• 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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    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.

pub fn set_cache_node_type(self, input: Option<String>) -> Self

The name of the compute and memory capacity node type for the source cluster.

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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    C1 node types: cache.c1.xlarge

• 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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

    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.

pub fn engine(self, input: impl Into<String>) -> Self

The name of the cache engine (memcached or redis) used by the source cluster.

pub fn set_engine(self, input: Option<String>) -> Self

The name of the cache engine (memcached or redis) used by the source cluster.

pub fn engine_version(self, input: impl Into<String>) -> Self

The version of the cache engine version that is used by the source cluster.

pub fn set_engine_version(self, input: Option<String>) -> Self

The version of the cache engine version that is used by the source cluster.

pub fn num_cache_nodes(self, input: i32) -> Self

The number of cache nodes in the source cluster.

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

pub fn set_num_cache_nodes(self, input: Option<i32>) -> Self

The number of cache nodes in the source cluster.

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

pub fn preferred_availability_zone(self, input: impl Into<String>) -> Self

The name of the Availability Zone in which the source cluster is located.

pub fn set_preferred_availability_zone(self, input: Option<String>) -> Self

The name of the Availability Zone in which the source cluster is located.

pub fn preferred_outpost_arn(self, input: impl Into<String>) -> Self

The ARN (Amazon Resource Name) of the preferred outpost.

pub fn set_preferred_outpost_arn(self, input: Option<String>) -> Self

The ARN (Amazon Resource Name) of the preferred outpost.

pub fn cache_cluster_create_time(self, input: DateTime) -> Self

The date and time when the source cluster was created.

pub fn set_cache_cluster_create_time(self, input: Option<DateTime>) -> Self

The date and time when the source cluster was created.

pub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self

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 set_preferred_maintenance_window(self, input: Option<String>) -> Self

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 topic_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

pub fn set_topic_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

pub fn port(self, input: i32) -> Self

The port number used by each cache nodes in the source cluster.

pub fn set_port(self, input: Option<i32>) -> Self

The port number used by each cache nodes in the source cluster.

pub fn cache_parameter_group_name(self, input: impl Into<String>) -> Self

The cache parameter group that is associated with the source cluster.

pub fn set_cache_parameter_group_name(self, input: Option<String>) -> Self

The cache parameter group that is associated with the source cluster.

pub fn cache_subnet_group_name(self, input: impl Into<String>) -> Self

The name of the cache subnet group associated with the source cluster.

pub fn set_cache_subnet_group_name(self, input: Option<String>) -> Self

The name of the cache subnet group associated with the source cluster.

pub fn vpc_id(self, input: impl Into<String>) -> Self

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

pub fn set_vpc_id(self, input: Option<String>) -> Self

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

pub fn auto_minor_version_upgrade(self, input: bool) -> Self

 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. 

pub fn set_auto_minor_version_upgrade(self, input: Option<bool>) -> Self

 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. 

pub fn snapshot_retention_limit(self, input: i32) -> Self

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

pub fn set_snapshot_retention_limit(self, input: Option<i32>) -> Self

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

pub fn snapshot_window(self, input: impl Into<String>) -> Self

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

pub fn set_snapshot_window(self, input: Option<String>) -> Self

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

pub fn num_node_groups(self, input: i32) -> Self

The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

pub fn set_num_node_groups(self, input: Option<i32>) -> Self

The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

pub fn automatic_failover(self, input: AutomaticFailoverStatus) -> Self

Indicates the status of automatic failover for the source Redis replication group.

pub fn set_automatic_failover(
    self,
    input: Option<AutomaticFailoverStatus>
) -> Self

Indicates the status of automatic failover for the source Redis replication group.

pub fn node_snapshots(self, input: NodeSnapshot) -> Self

Appends an item to node_snapshots.

To override the contents of this collection use set_node_snapshots.

A list of the cache nodes in the source cluster.

pub fn set_node_snapshots(self, input: Option<Vec<NodeSnapshot>>) -> Self

A list of the cache nodes in the source cluster.

pub fn kms_key_id(self, input: impl Into<String>) -> Self

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

pub fn set_kms_key_id(self, input: Option<String>) -> Self

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

pub fn arn(self, input: impl Into<String>) -> Self

The ARN (Amazon Resource Name) of the snapshot.

pub fn set_arn(self, input: Option<String>) -> Self

The ARN (Amazon Resource Name) of the snapshot.

pub fn data_tiering(self, input: DataTieringStatus) -> Self

Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

pub fn set_data_tiering(self, input: Option<DataTieringStatus>) -> Self

Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

pub fn build(self) -> Snapshot

Consumes the builder and constructs a Snapshot.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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