aws_elasticache

account_id

Type: STRING

arn

Type: STRING
Provider name: ARN
Description: The ARN (Amazon Resource Name) of the cache cluster.

at_rest_encryption_enabled

Type: BOOLEAN
Provider name: AtRestEncryptionEnabled
Description: A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false

auth_token_enabled

Type: BOOLEAN
Provider name: AuthTokenEnabled
Description: A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false

auth_token_last_modified_date

Type: TIMESTAMP
Provider name: AuthTokenLastModifiedDate
Description: The date the auth token was last modified

auto_minor_version_upgrade

Type: BOOLEAN
Provider name: AutoMinorVersionUpgrade
Description: 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.

cache_cluster_create_time

Type: TIMESTAMP
Provider name: CacheClusterCreateTime
Description: The date and time when the cluster was created.

cache_cluster_id

Type: STRING
Provider name: CacheClusterId
Description: The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

cache_cluster_status

Type: STRING
Provider name: CacheClusterStatus
Description: The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

cache_node_type

Type: STRING
Provider name: CacheNodeType
Description: The name of the compute and memory capacity node type for the 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

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

cache_nodes

Type: UNORDERED_LIST_STRUCT
Provider name: CacheNodes
Description: A list of cache nodes that are members of the cluster.

• cache_node_create_time
  Type: TIMESTAMP
  Provider name: CacheNodeCreateTime
  Description: The date and time when the cache node was created.
  
• cache_node_id
  Type: STRING
  Provider name: CacheNodeId
  Description: The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer’s Amazon account.
  
• cache_node_status
  Type: STRING
  Provider name: CacheNodeStatus
  Description: The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.
  
• customer_availability_zone
  Type: STRING
  Provider name: CustomerAvailabilityZone
  Description: The Availability Zone where this node was created and now resides.
  
• customer_outpost_arn
  Type: STRING
  Provider name: CustomerOutpostArn
  Description: The customer outpost ARN of the cache node.
  
• endpoint
  Type: STRUCT
  Provider name: Endpoint
  Description: The hostname for connecting to this cache node.
  
  • address
    Type: STRING
    Provider name: Address
    Description: The DNS hostname of the cache node.
    
  • port
    Type: INT32
    Provider name: Port
    Description: The port number that the cache engine is listening on.
    
• parameter_group_status
  Type: STRING
  Provider name: ParameterGroupStatus
  Description: The status of the parameter group applied to this cache node.
  
• source_cache_node_id
  Type: STRING
  Provider name: SourceCacheNodeId
  Description: The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.
  

cache_parameter_group

Type: STRUCT
Provider name: CacheParameterGroup
Description: Status of the cache parameter group.

• cache_node_ids_to_reboot
  Type: UNORDERED_LIST_STRING
  Provider name: CacheNodeIdsToReboot
  Description: A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
  
• cache_parameter_group_name
  Type: STRING
  Provider name: CacheParameterGroupName
  Description: The name of the cache parameter group.
  
• parameter_apply_status
  Type: STRING
  Provider name: ParameterApplyStatus
  Description: The status of parameter updates.
  

cache_security_groups

Type: UNORDERED_LIST_STRUCT
Provider name: CacheSecurityGroups
Description: A list of cache security group elements, composed of name and status sub-elements.

• cache_security_group_name
  Type: STRING
  Provider name: CacheSecurityGroupName
  Description: The name of the cache security group.
  
• status
  Type: STRING
  Provider name: Status
  Description: The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
  

cache_subnet_group_name

Type: STRING
Provider name: CacheSubnetGroupName
Description: The name of the cache subnet group associated with the cluster.

client_download_landing_page

Type: STRING
Provider name: ClientDownloadLandingPage
Description: The URL of the web page where you can download the latest ElastiCache client library.

configuration_endpoint

Type: STRUCT
Provider name: ConfigurationEndpoint
Description: Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it. Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

• address
  Type: STRING
  Provider name: Address
  Description: The DNS hostname of the cache node.
  
• port
  Type: INT32
  Provider name: Port
  Description: The port number that the cache engine is listening on.
  

engine

Type: STRING
Provider name: Engine
Description: The name of the cache engine (memcached or redis) to be used for this cluster.

engine_version

Type: STRING
Provider name: EngineVersion
Description: The version of the cache engine that is used in this cluster.

ip_discovery

Type: STRING
Provider name: IpDiscovery
Description: The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

log_delivery_configurations

Type: UNORDERED_LIST_STRUCT
Provider name: LogDeliveryConfigurations
Description: Returns the destination, format and type of the logs.

• destination_details
  Type: STRUCT
  Provider name: DestinationDetails
  Description: Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
  
  • cloud_watch_logs_details
    Type: STRUCT
    Provider name: CloudWatchLogsDetails
    Description: The configuration details of the CloudWatch Logs destination.
    
    • log_group
      Type: STRING
      Provider name: LogGroup
      Description: The name of the CloudWatch Logs log group.
      
  • kinesis_firehose_details
    Type: STRUCT
    Provider name: KinesisFirehoseDetails
    Description: The configuration details of the Kinesis Data Firehose destination.
    
    • delivery_stream
      Type: STRING
      Provider name: DeliveryStream
      Description: The name of the Kinesis Data Firehose delivery stream.
      
• destination_type
  Type: STRING
  Provider name: DestinationType
  Description: Returns the destination type, either cloudwatch-logs or kinesis-firehose.
  
• log_format
  Type: STRING
  Provider name: LogFormat
  Description: Returns the log format, either JSON or TEXT.
  
• log_type
  Type: STRING
  Provider name: LogType
  Description: Refers to slow-log or engine-log.
  
• message
  Type: STRING
  Provider name: Message
  Description: Returns an error message for the log delivery configuration.
  
• status
  Type: STRING
  Provider name: Status
  Description: Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
  

network_type

Type: STRING
Provider name: NetworkType
Description: Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

notification_configuration

Type: STRUCT
Provider name: NotificationConfiguration
Description: Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

• topic_arn
  Type: STRING
  Provider name: TopicArn
  Description: The Amazon Resource Name (ARN) that identifies the topic.
  
• topic_status
  Type: STRING
  Provider name: TopicStatus
  Description: The current state of the topic.
  

num_cache_nodes

Type: INT32
Provider name: NumCacheNodes
Description: The number of cache nodes in the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

pending_modified_values

Type: STRUCT
Provider name: PendingModifiedValues

• auth_token_status
  Type: STRING
  Provider name: AuthTokenStatus
  Description: The auth token status
  
• cache_node_ids_to_remove
  Type: UNORDERED_LIST_STRING
  Provider name: CacheNodeIdsToRemove
  Description: A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
  
• cache_node_type
  Type: STRING
  Provider name: CacheNodeType
  Description: The cache node type that this cluster or replication group is scaled to.
  
• engine_version
  Type: STRING
  Provider name: EngineVersion
  Description: The new cache engine version that the cluster runs.
  
• log_delivery_configurations
  Type: UNORDERED_LIST_STRUCT
  Provider name: LogDeliveryConfigurations
  Description: The log delivery configurations being modified
  
  • destination_details
    Type: STRUCT
    Provider name: DestinationDetails
    Description: Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    
    • cloud_watch_logs_details
      Type: STRUCT
      Provider name: CloudWatchLogsDetails
      Description: The configuration details of the CloudWatch Logs destination.
      
      • log_group
        Type: STRING
        Provider name: LogGroup
        Description: The name of the CloudWatch Logs log group.
        
    • kinesis_firehose_details
      Type: STRUCT
      Provider name: KinesisFirehoseDetails
      Description: The configuration details of the Kinesis Data Firehose destination.
      
      • delivery_stream
        Type: STRING
        Provider name: DeliveryStream
        Description: The name of the Kinesis Data Firehose delivery stream.
        
  • destination_type
    Type: STRING
    Provider name: DestinationType
    Description: Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
    
  • log_format
    Type: STRING
    Provider name: LogFormat
    Description: Returns the log format, either JSON or TEXT
    
  • log_type
    Type: STRING
    Provider name: LogType
    Description: Refers to slow-log or engine-log..
    
• num_cache_nodes
  Type: INT32
  Provider name: NumCacheNodes
  Description: The new number of cache nodes for the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
  
• transit_encryption_enabled
  Type: BOOLEAN
  Provider name: TransitEncryptionEnabled
  Description: A flag that enables in-transit encryption when set to true.
  
• transit_encryption_mode
  Type: STRING
  Provider name: TransitEncryptionMode
  Description: A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
  

preferred_availability_zone

Type: STRING
Provider name: PreferredAvailabilityZone
Description: The name of the Availability Zone in which the cluster is located or “Multiple” if the cache nodes are located in different Availability Zones.

preferred_maintenance_window

Type: STRING
Provider name: PreferredMaintenanceWindow
Description: 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

preferred_outpost_arn

Type: STRING
Provider name: PreferredOutpostArn
Description: The outpost ARN in which the cache cluster is created.

replication_group_id

Type: STRING
Provider name: ReplicationGroupId
Description: The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

replication_group_log_delivery_enabled

Type: BOOLEAN
Provider name: ReplicationGroupLogDeliveryEnabled
Description: A boolean value indicating whether log delivery is enabled for the replication group.

security_groups

Type: UNORDERED_LIST_STRUCT
Provider name: SecurityGroups
Description: A list of VPC Security Groups associated with the cluster.

• security_group_id
  Type: STRING
  Provider name: SecurityGroupId
  Description: The identifier of the cache security group.
  
• status
  Type: STRING
  Provider name: Status
  Description: The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
  

snapshot_retention_limit

Type: INT32
Provider name: SnapshotRetentionLimit
Description: The number of days for which ElastiCache retains automatic cluster 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. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

snapshot_window

Type: STRING
Provider name: SnapshotWindow
Description: The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: 05:00-09:00

tags

Type: UNORDERED_LIST_STRING

transit_encryption_enabled

Type: BOOLEAN
Provider name: TransitEncryptionEnabled
Description: A flag that enables in-transit encryption when set to true. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false

transit_encryption_mode

Type: STRING
Provider name: TransitEncryptionMode
Description: A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.