Struct Redis 

pub struct Redis {
    pub id: String,
    pub memory: Option<String>,
    pub eviction_policy: RedisEvictionPolicy,
    pub persistence: bool,
    pub high_availability: bool,
    pub encryption_key: Option<ResourceRef>,
}

A managed, Redis-compatible in-memory store on a private network. The target platform decides the backend (AWS ElastiCache for Valkey, GCP Memorystore for Valkey, Azure Managed Redis, or the official Valkey image in Docker on Local). It is never publicly reachable, and it is a single endpoint (not cluster mode), so plain clients and multi-key scripts work.

Fields

id: String

memory: Option<String>

Memory available for data (e.g. “512Mi”, “4Gi”). None = the smallest production tier. The smallest tier that fits is used; a request larger than the biggest single-shard tier on the platform is rejected.

eviction_policy: RedisEvictionPolicy

What happens at the memory limit. Default volatile-lru: keys without a TTL are never evicted.

persistence: bool

Keep data across a server restart or maintenance. Default false (a cache). On AWS, GCP and Azure this needs high_availability, because the clouds only persist data from a replicated deployment. Local always persists with an append-only file when this is on.

high_availability: bool

One replica in another zone with automatic failover. Default false.

encryption_key: Option<ResourceRef>

Customer-managed key for encryption at rest. Cannot be changed after creation.

Implementations

impl Redis

pub fn new(id: String) -> RedisBuilder

Create an instance of Redis using the builder syntax

impl Redis

pub const RESOURCE_TYPE: ResourceType

The resource type identifier for Redis.

pub fn requested_memory_bytes(&self) -> Result<Option<u64>>

Requested memory in bytes, or None for the default tier. Uses the same parser as every other sized resource, so all controllers and emitters read a quantity the same way. A bare number is GiB (as for Postgres).

pub fn elasticache_node_type(&self) -> Result<(&'static str, u64)>

The smallest ElastiCache node type whose usable data memory fits the request, and that usable memory in bytes. Usable memory is 75% of the node’s memory because ElastiCache reserves 25% by default (reserved-memory-percent). With no request the default is 1 GiB. Requests above the largest single-shard node are rejected, never capped.

pub fn memorystore_node_type(&self) -> Result<(&'static str, u64)>

The smallest Memorystore node type whose default usable memory fits the request, and that usable memory in bytes. With no request the default is 1 GiB. Requests above the largest node are rejected, never capped.

pub fn azure_managed_redis_sku(&self) -> Result<(&'static str, u64)>

The smallest Azure Managed Redis SKU whose memory fits the request, and that memory in bytes. With no request the default is 1 GiB. Requests above the largest NoCluster SKU are rejected, never capped.

pub fn id(&self) -> &str

Returns the Redis resource’s unique identifier.

Trait Implementations

impl Clone for Redis

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Redis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Redis

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Redis

impl PartialEq for Redis

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

Equality operator ==.

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

Inequality operator !=.

impl ResourceDefinition for Redis

fn get_resource_type(&self) -> ResourceType

Returns the resource type for this instance

fn id(&self) -> &str

Returns the unique identifier for this specific resource instance

fn replace_after_failed_create_is_safe(&self) -> bool

Whether the executor may delete this resource and create it again when its create failed and its config changed since.

fn get_dependencies(&self) -> Vec<ResourceRef>

Returns the list of other resources this resource depends on

fn validate_update(&self, new_config: &dyn ResourceDefinition) -> Result<()>

Validates if an update from the current configuration to a new configuration is allowed

fn as_any(&self) -> &dyn Any

Provides access to the underlying concrete type for downcasting

fn as_any_mut(&mut self) -> &mut dyn Any

Provides mutable access to the underlying concrete type for downcasting

fn box_clone(&self) -> Box<dyn ResourceDefinition>

Creates a boxed clone of this resource definition

fn resource_eq(&self, other: &dyn ResourceDefinition) -> bool

For equality comparison between resource definitions

fn to_json_value(&self) -> Result<Value>

Serialize this resource to a JSON value (without the “type” tag - that’s added by Resource)

fn get_permissions(&self) -> Option<&str>

Returns the permission profile name for this resource, if it has one.

impl Serialize for Redis

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Redis