Amazonka.ElastiCache.Lens

Operations

AddTagsToResource

addTagsToResource_resourceName :: Lens' AddTagsToResource Text

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

addTagsToResource_tags :: Lens' AddTagsToResource [Tag]

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

tagListMessage_tagList :: Lens' TagListMessage (Maybe [Tag])

A list of tags as key-value pairs.

AuthorizeCacheSecurityGroupIngress

authorizeCacheSecurityGroupIngress_cacheSecurityGroupName :: Lens' AuthorizeCacheSecurityGroupIngress Text

The cache security group that allows network ingress.

authorizeCacheSecurityGroupIngress_eC2SecurityGroupName :: Lens' AuthorizeCacheSecurityGroupIngress Text

The Amazon EC2 security group to be authorized for ingress to the cache security group.

authorizeCacheSecurityGroupIngress_eC2SecurityGroupOwnerId :: Lens' AuthorizeCacheSecurityGroupIngress Text

The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.

authorizeCacheSecurityGroupIngressResponse_cacheSecurityGroup :: Lens' AuthorizeCacheSecurityGroupIngressResponse (Maybe CacheSecurityGroup)

Undocumented member.

authorizeCacheSecurityGroupIngressResponse_httpStatus :: Lens' AuthorizeCacheSecurityGroupIngressResponse Int

The response's http status code.

BatchApplyUpdateAction

batchApplyUpdateAction_cacheClusterIds :: Lens' BatchApplyUpdateAction (Maybe [Text])

The cache cluster IDs

batchApplyUpdateAction_replicationGroupIds :: Lens' BatchApplyUpdateAction (Maybe [Text])

The replication group IDs

batchApplyUpdateAction_serviceUpdateName :: Lens' BatchApplyUpdateAction Text

The unique ID of the service update

updateActionResultsMessage_processedUpdateActions :: Lens' UpdateActionResultsMessage (Maybe [ProcessedUpdateAction])

Update actions that have been processed successfully

updateActionResultsMessage_unprocessedUpdateActions :: Lens' UpdateActionResultsMessage (Maybe [UnprocessedUpdateAction])

Update actions that haven't been processed successfully

BatchStopUpdateAction

batchStopUpdateAction_cacheClusterIds :: Lens' BatchStopUpdateAction (Maybe [Text])

The cache cluster IDs

batchStopUpdateAction_replicationGroupIds :: Lens' BatchStopUpdateAction (Maybe [Text])

The replication group IDs

batchStopUpdateAction_serviceUpdateName :: Lens' BatchStopUpdateAction Text

The unique ID of the service update

updateActionResultsMessage_processedUpdateActions :: Lens' UpdateActionResultsMessage (Maybe [ProcessedUpdateAction])

Update actions that have been processed successfully

updateActionResultsMessage_unprocessedUpdateActions :: Lens' UpdateActionResultsMessage (Maybe [UnprocessedUpdateAction])

Update actions that haven't been processed successfully

CompleteMigration

completeMigration_force :: Lens' CompleteMigration (Maybe Bool)

Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.

completeMigration_replicationGroupId :: Lens' CompleteMigration Text

The ID of the replication group to which data is being migrated.

completeMigrationResponse_replicationGroup :: Lens' CompleteMigrationResponse (Maybe ReplicationGroup)

Undocumented member.

completeMigrationResponse_httpStatus :: Lens' CompleteMigrationResponse Int

The response's http status code.

CopySnapshot

copySnapshot_kmsKeyId :: Lens' CopySnapshot (Maybe Text)

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

copySnapshot_tags :: Lens' CopySnapshot (Maybe [Tag])

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

copySnapshot_targetBucket :: Lens' CopySnapshot (Maybe Text)

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

copySnapshot_sourceSnapshotName :: Lens' CopySnapshot Text

The name of an existing snapshot from which to make a copy.

copySnapshot_targetSnapshotName :: Lens' CopySnapshot Text

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

copySnapshotResponse_snapshot :: Lens' CopySnapshotResponse (Maybe Snapshot)

Undocumented member.

copySnapshotResponse_httpStatus :: Lens' CopySnapshotResponse Int

The response's http status code.

CreateCacheCluster

createCacheCluster_aZMode :: Lens' CreateCacheCluster (Maybe 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.

createCacheCluster_authToken :: Lens' CreateCacheCluster (Maybe Text)

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.

createCacheCluster_autoMinorVersionUpgrade :: Lens' CreateCacheCluster (Maybe 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.

createCacheCluster_cacheNodeType :: Lens' CreateCacheCluster (Maybe Text)

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

createCacheCluster_cacheParameterGroupName :: Lens' CreateCacheCluster (Maybe Text)

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.

createCacheCluster_cacheSecurityGroupNames :: Lens' CreateCacheCluster (Maybe [Text])

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

createCacheCluster_cacheSubnetGroupName :: Lens' CreateCacheCluster (Maybe Text)

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.

createCacheCluster_engine :: Lens' CreateCacheCluster (Maybe Text)

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

Valid values for this parameter are: memcached | redis

createCacheCluster_engineVersion :: Lens' CreateCacheCluster (Maybe Text)

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.

createCacheCluster_ipDiscovery :: Lens' CreateCacheCluster (Maybe IpDiscovery)

The network type you choose when modifying a 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.

createCacheCluster_logDeliveryConfigurations :: Lens' CreateCacheCluster (Maybe [LogDeliveryConfigurationRequest])

Specifies the destination, format and type of the logs.

createCacheCluster_networkType :: Lens' CreateCacheCluster (Maybe NetworkType)

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.

createCacheCluster_notificationTopicArn :: Lens' CreateCacheCluster (Maybe Text)

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.

createCacheCluster_numCacheNodes :: Lens' CreateCacheCluster (Maybe Int)

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

createCacheCluster_outpostMode :: Lens' CreateCacheCluster (Maybe OutpostMode)

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

createCacheCluster_port :: Lens' CreateCacheCluster (Maybe Int)

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

createCacheCluster_preferredAvailabilityZone :: Lens' CreateCacheCluster (Maybe Text)

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.

createCacheCluster_preferredAvailabilityZones :: Lens' CreateCacheCluster (Maybe [Text])

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.

createCacheCluster_preferredMaintenanceWindow :: Lens' CreateCacheCluster (Maybe Text)

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.

createCacheCluster_preferredOutpostArn :: Lens' CreateCacheCluster (Maybe Text)

The outpost ARN in which the cache cluster is created.

createCacheCluster_preferredOutpostArns :: Lens' CreateCacheCluster (Maybe [Text])

The outpost ARNs in which the cache cluster is created.

createCacheCluster_replicationGroupId :: Lens' CreateCacheCluster (Maybe Text)

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.

createCacheCluster_securityGroupIds :: Lens' CreateCacheCluster (Maybe [Text])

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

createCacheCluster_snapshotArns :: Lens' CreateCacheCluster (Maybe [Text])

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

createCacheCluster_snapshotName :: Lens' CreateCacheCluster (Maybe Text)

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.

createCacheCluster_snapshotRetentionLimit :: Lens' CreateCacheCluster (Maybe Int)

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

createCacheCluster_snapshotWindow :: Lens' CreateCacheCluster (Maybe Text)

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.

createCacheCluster_tags :: Lens' CreateCacheCluster (Maybe [Tag])

A list of tags to be added to this resource.

createCacheCluster_transitEncryptionEnabled :: Lens' CreateCacheCluster (Maybe Bool)

A flag that enables in-transit encryption when set to true.

Only available when creating a cache cluster in an Amazon VPC using Memcached version 1.6.12 or later.

createCacheCluster_cacheClusterId :: Lens' CreateCacheCluster Text

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.

createCacheClusterResponse_cacheCluster :: Lens' CreateCacheClusterResponse (Maybe CacheCluster)

Undocumented member.

createCacheClusterResponse_httpStatus :: Lens' CreateCacheClusterResponse Int

The response's http status code.

CreateCacheParameterGroup

createCacheParameterGroup_tags :: Lens' CreateCacheParameterGroup (Maybe [Tag])

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createCacheParameterGroup_cacheParameterGroupName :: Lens' CreateCacheParameterGroup Text

A user-specified name for the cache parameter group.

createCacheParameterGroup_cacheParameterGroupFamily :: Lens' CreateCacheParameterGroup Text

The name of the cache parameter group family that the cache parameter group can be used with.

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x

createCacheParameterGroup_description :: Lens' CreateCacheParameterGroup Text

A user-specified description for the cache parameter group.

createCacheParameterGroupResponse_cacheParameterGroup :: Lens' CreateCacheParameterGroupResponse (Maybe CacheParameterGroup)

Undocumented member.

createCacheParameterGroupResponse_httpStatus :: Lens' CreateCacheParameterGroupResponse Int

The response's http status code.

CreateCacheSecurityGroup

createCacheSecurityGroup_tags :: Lens' CreateCacheSecurityGroup (Maybe [Tag])

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createCacheSecurityGroup_cacheSecurityGroupName :: Lens' CreateCacheSecurityGroup Text

A name for the cache security group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".

Example: mysecuritygroup

createCacheSecurityGroup_description :: Lens' CreateCacheSecurityGroup Text

A description for the cache security group.

createCacheSecurityGroupResponse_cacheSecurityGroup :: Lens' CreateCacheSecurityGroupResponse (Maybe CacheSecurityGroup)

Undocumented member.

createCacheSecurityGroupResponse_httpStatus :: Lens' CreateCacheSecurityGroupResponse Int

The response's http status code.

CreateCacheSubnetGroup

createCacheSubnetGroup_tags :: Lens' CreateCacheSubnetGroup (Maybe [Tag])

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createCacheSubnetGroup_cacheSubnetGroupName :: Lens' CreateCacheSubnetGroup Text

A name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

createCacheSubnetGroup_cacheSubnetGroupDescription :: Lens' CreateCacheSubnetGroup Text

A description for the cache subnet group.

createCacheSubnetGroup_subnetIds :: Lens' CreateCacheSubnetGroup [Text]

A list of VPC subnet IDs for the cache subnet group.

createCacheSubnetGroupResponse_cacheSubnetGroup :: Lens' CreateCacheSubnetGroupResponse (Maybe CacheSubnetGroup)

Undocumented member.

createCacheSubnetGroupResponse_httpStatus :: Lens' CreateCacheSubnetGroupResponse Int

The response's http status code.

CreateGlobalReplicationGroup

createGlobalReplicationGroup_globalReplicationGroupDescription :: Lens' CreateGlobalReplicationGroup (Maybe Text)

Provides details of the Global datastore

createGlobalReplicationGroup_globalReplicationGroupIdSuffix :: Lens' CreateGlobalReplicationGroup Text

The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.

For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .

createGlobalReplicationGroup_primaryReplicationGroupId :: Lens' CreateGlobalReplicationGroup Text

The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

createGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' CreateGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)

Undocumented member.

createGlobalReplicationGroupResponse_httpStatus :: Lens' CreateGlobalReplicationGroupResponse Int

The response's http status code.

CreateReplicationGroup

createReplicationGroup_atRestEncryptionEnabled :: Lens' CreateReplicationGroup (Maybe Bool)

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

createReplicationGroup_authToken :: Lens' CreateReplicationGroup (Maybe Text)

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

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

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.

createReplicationGroup_autoMinorVersionUpgrade :: Lens' CreateReplicationGroup (Maybe 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.

createReplicationGroup_automaticFailoverEnabled :: Lens' CreateReplicationGroup (Maybe Bool)

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

createReplicationGroup_cacheNodeType :: Lens' CreateReplicationGroup (Maybe Text)

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

createReplicationGroup_cacheParameterGroupName :: Lens' CreateReplicationGroup (Maybe Text)

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

• To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
• To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

createReplicationGroup_cacheSecurityGroupNames :: Lens' CreateReplicationGroup (Maybe [Text])

A list of cache security group names to associate with this replication group.

createReplicationGroup_cacheSubnetGroupName :: Lens' CreateReplicationGroup (Maybe Text)

The name of the cache subnet group to be used for the replication group.

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.

createReplicationGroup_dataTieringEnabled :: Lens' CreateReplicationGroup (Maybe Bool)

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.

createReplicationGroup_engine :: Lens' CreateReplicationGroup (Maybe Text)

The name of the cache engine to be used for the clusters in this replication group. The value must be set to Redis.

createReplicationGroup_engineVersion :: Lens' CreateReplicationGroup (Maybe Text)

The version number of the cache engine to be used for the clusters in this replication group. 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) in the ElastiCache User Guide, 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.

createReplicationGroup_globalReplicationGroupId :: Lens' CreateReplicationGroup (Maybe Text)

The name of the Global datastore

createReplicationGroup_ipDiscovery :: Lens' CreateReplicationGroup (Maybe IpDiscovery)

The network type you choose when creating a replication group, 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.

createReplicationGroup_kmsKeyId :: Lens' CreateReplicationGroup (Maybe Text)

The ID of the KMS key used to encrypt the disk in the cluster.

createReplicationGroup_logDeliveryConfigurations :: Lens' CreateReplicationGroup (Maybe [LogDeliveryConfigurationRequest])

Specifies the destination, format and type of the logs.

createReplicationGroup_multiAZEnabled :: Lens' CreateReplicationGroup (Maybe Bool)

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

createReplicationGroup_networkType :: Lens' CreateReplicationGroup (Maybe NetworkType)

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.

createReplicationGroup_nodeGroupConfiguration :: Lens' CreateReplicationGroup (Maybe [NodeGroupConfiguration])

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

createReplicationGroup_notificationTopicArn :: Lens' CreateReplicationGroup (Maybe Text)

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.

createReplicationGroup_numCacheClusters :: Lens' CreateReplicationGroup (Maybe Int)

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

createReplicationGroup_numNodeGroups :: Lens' CreateReplicationGroup (Maybe Int)

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

createReplicationGroup_port :: Lens' CreateReplicationGroup (Maybe Int)

The port number on which each member of the replication group accepts connections.

createReplicationGroup_preferredCacheClusterAZs :: Lens' CreateReplicationGroup (Maybe [Text])

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

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

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

Default: system chosen Availability Zones.

createReplicationGroup_preferredMaintenanceWindow :: Lens' CreateReplicationGroup (Maybe Text)

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:

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

createReplicationGroup_primaryClusterId :: Lens' CreateReplicationGroup (Maybe Text)

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

createReplicationGroup_replicasPerNodeGroup :: Lens' CreateReplicationGroup (Maybe Int)

An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

createReplicationGroup_securityGroupIds :: Lens' CreateReplicationGroup (Maybe [Text])

One or more Amazon VPC security groups associated with this replication group.

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

createReplicationGroup_snapshotArns :: Lens' CreateReplicationGroup (Maybe [Text])

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

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

createReplicationGroup_snapshotName :: Lens' CreateReplicationGroup (Maybe Text)

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

createReplicationGroup_snapshotRetentionLimit :: Lens' CreateReplicationGroup (Maybe Int)

The number of days for which ElastiCache retains automatic 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.

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

createReplicationGroup_snapshotWindow :: Lens' CreateReplicationGroup (Maybe Text)

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.

createReplicationGroup_tags :: Lens' CreateReplicationGroup (Maybe [Tag])

A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.

createReplicationGroup_transitEncryptionEnabled :: Lens' CreateReplicationGroup (Maybe Bool)

A flag that enables in-transit encryption when set to true.

This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

createReplicationGroup_transitEncryptionMode :: Lens' CreateReplicationGroup (Maybe TransitEncryptionMode)

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can modify the value to required to allow encrypted connections only.

Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred first, after that you can set TransitEncryptionMode to required.

createReplicationGroup_userGroupIds :: Lens' CreateReplicationGroup (Maybe (NonEmpty Text))

The user group to associate with the replication group.

createReplicationGroup_replicationGroupId :: Lens' CreateReplicationGroup Text

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

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

createReplicationGroup_replicationGroupDescription :: Lens' CreateReplicationGroup Text

A user-created description for the replication group.

createReplicationGroupResponse_replicationGroup :: Lens' CreateReplicationGroupResponse (Maybe ReplicationGroup)

Undocumented member.

createReplicationGroupResponse_httpStatus :: Lens' CreateReplicationGroupResponse Int

The response's http status code.

CreateSnapshot

createSnapshot_cacheClusterId :: Lens' CreateSnapshot (Maybe Text)

The identifier of an existing cluster. The snapshot is created from this cluster.

createSnapshot_kmsKeyId :: Lens' CreateSnapshot (Maybe Text)

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

createSnapshot_replicationGroupId :: Lens' CreateSnapshot (Maybe Text)

The identifier of an existing replication group. The snapshot is created from this replication group.

createSnapshot_tags :: Lens' CreateSnapshot (Maybe [Tag])

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createSnapshot_snapshotName :: Lens' CreateSnapshot Text

A name for the snapshot being created.

createSnapshotResponse_snapshot :: Lens' CreateSnapshotResponse (Maybe Snapshot)

Undocumented member.

createSnapshotResponse_httpStatus :: Lens' CreateSnapshotResponse Int

The response's http status code.

CreateUser

createUser_authenticationMode :: Lens' CreateUser (Maybe AuthenticationMode)

Specifies how to authenticate the user.

createUser_noPasswordRequired :: Lens' CreateUser (Maybe Bool)

Indicates a password is not required for this user.

createUser_passwords :: Lens' CreateUser (Maybe (NonEmpty Text))

Passwords used for this user. You can create up to two passwords for each user.

createUser_tags :: Lens' CreateUser (Maybe [Tag])

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createUser_userId :: Lens' CreateUser Text

The ID of the user.

createUser_userName :: Lens' CreateUser Text

The username of the user.

createUser_engine :: Lens' CreateUser Text

The current supported value is Redis.

createUser_accessString :: Lens' CreateUser Text

Access permissions string used for this user.

user_arn :: Lens' User (Maybe Text)

The Amazon Resource Name (ARN) of the user.

user_accessString :: Lens' User (Maybe Text)

Access permissions string used for this user.

user_authentication :: Lens' User (Maybe Authentication)

Denotes whether the user requires a password to authenticate.

user_engine :: Lens' User (Maybe Text)

The current supported value is Redis.

user_minimumEngineVersion :: Lens' User (Maybe Text)

The minimum engine version required, which is Redis 6.0

user_status :: Lens' User (Maybe Text)

Indicates the user status. Can be "active", "modifying" or "deleting".

user_userGroupIds :: Lens' User (Maybe [Text])

Returns a list of the user group IDs the user belongs to.

user_userId :: Lens' User (Maybe Text)

The ID of the user.

user_userName :: Lens' User (Maybe Text)

The username of the user.

CreateUserGroup

createUserGroup_tags :: Lens' CreateUserGroup (Maybe [Tag])

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createUserGroup_userIds :: Lens' CreateUserGroup (Maybe (NonEmpty Text))

The list of user IDs that belong to the user group.

createUserGroup_userGroupId :: Lens' CreateUserGroup Text

The ID of the user group.

createUserGroup_engine :: Lens' CreateUserGroup Text

The current supported value is Redis.

userGroup_arn :: Lens' UserGroup (Maybe Text)

The Amazon Resource Name (ARN) of the user group.

userGroup_engine :: Lens' UserGroup (Maybe Text)

The current supported value is Redis.

userGroup_minimumEngineVersion :: Lens' UserGroup (Maybe Text)

The minimum engine version required, which is Redis 6.0

userGroup_pendingChanges :: Lens' UserGroup (Maybe UserGroupPendingChanges)

A list of updates being applied to the user group.

userGroup_replicationGroups :: Lens' UserGroup (Maybe [Text])

A list of replication groups that the user group can access.

userGroup_status :: Lens' UserGroup (Maybe Text)

Indicates user group status. Can be "creating", "active", "modifying", "deleting".

userGroup_userGroupId :: Lens' UserGroup (Maybe Text)

The ID of the user group.

userGroup_userIds :: Lens' UserGroup (Maybe [Text])

The list of user IDs that belong to the user group.

DecreaseNodeGroupsInGlobalReplicationGroup

decreaseNodeGroupsInGlobalReplicationGroup_globalNodeGroupsToRemove :: Lens' DecreaseNodeGroupsInGlobalReplicationGroup (Maybe [Text])

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.

decreaseNodeGroupsInGlobalReplicationGroup_globalNodeGroupsToRetain :: Lens' DecreaseNodeGroupsInGlobalReplicationGroup (Maybe [Text])

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.

decreaseNodeGroupsInGlobalReplicationGroup_globalReplicationGroupId :: Lens' DecreaseNodeGroupsInGlobalReplicationGroup Text

The name of the Global datastore

decreaseNodeGroupsInGlobalReplicationGroup_nodeGroupCount :: Lens' DecreaseNodeGroupsInGlobalReplicationGroup Int

The number of node groups (shards) that results from the modification of the shard configuration

decreaseNodeGroupsInGlobalReplicationGroup_applyImmediately :: Lens' DecreaseNodeGroupsInGlobalReplicationGroup Bool

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

decreaseNodeGroupsInGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' DecreaseNodeGroupsInGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)

Undocumented member.

decreaseNodeGroupsInGlobalReplicationGroupResponse_httpStatus :: Lens' DecreaseNodeGroupsInGlobalReplicationGroupResponse Int

The response's http status code.

DecreaseReplicaCount

decreaseReplicaCount_newReplicaCount :: Lens' DecreaseReplicaCount (Maybe Int)

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

The minimum number of replicas in a shard or replication group is:

• Redis (cluster mode disabled)

  • If Multi-AZ is enabled: 1
  • If Multi-AZ is not enabled: 0
• Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

decreaseReplicaCount_replicaConfiguration :: Lens' DecreaseReplicaCount (Maybe [ConfigureShard])

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

decreaseReplicaCount_replicasToRemove :: Lens' DecreaseReplicaCount (Maybe [Text])

A list of the node ids to remove from the replication group or node group (shard).

decreaseReplicaCount_replicationGroupId :: Lens' DecreaseReplicaCount Text

The id of the replication group from which you want to remove replica nodes.

decreaseReplicaCount_applyImmediately :: Lens' DecreaseReplicaCount Bool

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

decreaseReplicaCountResponse_replicationGroup :: Lens' DecreaseReplicaCountResponse (Maybe ReplicationGroup)

Undocumented member.

decreaseReplicaCountResponse_httpStatus :: Lens' DecreaseReplicaCountResponse Int

The response's http status code.

DeleteCacheCluster

deleteCacheCluster_finalSnapshotIdentifier :: Lens' DeleteCacheCluster (Maybe Text)

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

deleteCacheCluster_cacheClusterId :: Lens' DeleteCacheCluster Text

The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

deleteCacheClusterResponse_cacheCluster :: Lens' DeleteCacheClusterResponse (Maybe CacheCluster)

Undocumented member.

deleteCacheClusterResponse_httpStatus :: Lens' DeleteCacheClusterResponse Int

The response's http status code.

DeleteCacheParameterGroup

deleteCacheParameterGroup_cacheParameterGroupName :: Lens' DeleteCacheParameterGroup Text

The name of the cache parameter group to delete.

The specified cache security group must not be associated with any clusters.

DeleteCacheSecurityGroup

deleteCacheSecurityGroup_cacheSecurityGroupName :: Lens' DeleteCacheSecurityGroup Text

The name of the cache security group to delete.

You cannot delete the default security group.

DeleteCacheSubnetGroup

deleteCacheSubnetGroup_cacheSubnetGroupName :: Lens' DeleteCacheSubnetGroup Text

The name of the cache subnet group to delete.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

DeleteGlobalReplicationGroup

deleteGlobalReplicationGroup_globalReplicationGroupId :: Lens' DeleteGlobalReplicationGroup Text

The name of the Global datastore

deleteGlobalReplicationGroup_retainPrimaryReplicationGroup :: Lens' DeleteGlobalReplicationGroup Bool

The primary replication group is retained as a standalone replication group.

deleteGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' DeleteGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)

Undocumented member.

deleteGlobalReplicationGroupResponse_httpStatus :: Lens' DeleteGlobalReplicationGroupResponse Int

The response's http status code.

DeleteReplicationGroup

deleteReplicationGroup_finalSnapshotIdentifier :: Lens' DeleteReplicationGroup (Maybe Text)

The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

deleteReplicationGroup_retainPrimaryCluster :: Lens' DeleteReplicationGroup (Maybe Bool)

If set to true, all of the read replicas are deleted, but the primary node is retained.

deleteReplicationGroup_replicationGroupId :: Lens' DeleteReplicationGroup Text

The identifier for the cluster to be deleted. This parameter is not case sensitive.

deleteReplicationGroupResponse_replicationGroup :: Lens' DeleteReplicationGroupResponse (Maybe ReplicationGroup)

Undocumented member.

deleteReplicationGroupResponse_httpStatus :: Lens' DeleteReplicationGroupResponse Int

The response's http status code.

DeleteSnapshot

deleteSnapshot_snapshotName :: Lens' DeleteSnapshot Text

The name of the snapshot to be deleted.

deleteSnapshotResponse_snapshot :: Lens' DeleteSnapshotResponse (Maybe Snapshot)

Undocumented member.

deleteSnapshotResponse_httpStatus :: Lens' DeleteSnapshotResponse Int

The response's http status code.

DeleteUser

deleteUser_userId :: Lens' DeleteUser Text

The ID of the user.

user_arn :: Lens' User (Maybe Text)

The Amazon Resource Name (ARN) of the user.

user_accessString :: Lens' User (Maybe Text)

Access permissions string used for this user.

user_authentication :: Lens' User (Maybe Authentication)

Denotes whether the user requires a password to authenticate.

user_engine :: Lens' User (Maybe Text)

The current supported value is Redis.

user_minimumEngineVersion :: Lens' User (Maybe Text)

The minimum engine version required, which is Redis 6.0

user_status :: Lens' User (Maybe Text)

Indicates the user status. Can be "active", "modifying" or "deleting".

user_userGroupIds :: Lens' User (Maybe [Text])

Returns a list of the user group IDs the user belongs to.

user_userId :: Lens' User (Maybe Text)

The ID of the user.

user_userName :: Lens' User (Maybe Text)

The username of the user.

DeleteUserGroup

deleteUserGroup_userGroupId :: Lens' DeleteUserGroup Text

The ID of the user group.

userGroup_arn :: Lens' UserGroup (Maybe Text)

The Amazon Resource Name (ARN) of the user group.

userGroup_engine :: Lens' UserGroup (Maybe Text)

The current supported value is Redis.

userGroup_minimumEngineVersion :: Lens' UserGroup (Maybe Text)

The minimum engine version required, which is Redis 6.0

userGroup_pendingChanges :: Lens' UserGroup (Maybe UserGroupPendingChanges)

A list of updates being applied to the user group.

userGroup_replicationGroups :: Lens' UserGroup (Maybe [Text])

A list of replication groups that the user group can access.

userGroup_status :: Lens' UserGroup (Maybe Text)

Indicates user group status. Can be "creating", "active", "modifying", "deleting".

userGroup_userGroupId :: Lens' UserGroup (Maybe Text)

The ID of the user group.

userGroup_userIds :: Lens' UserGroup (Maybe [Text])

The list of user IDs that belong to the user group.

DescribeCacheClusters

describeCacheClusters_cacheClusterId :: Lens' DescribeCacheClusters (Maybe Text)

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

describeCacheClusters_marker :: Lens' DescribeCacheClusters (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeCacheClusters_maxRecords :: Lens' DescribeCacheClusters (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeCacheClusters_showCacheClustersNotInReplicationGroups :: Lens' DescribeCacheClusters (Maybe Bool)

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

describeCacheClusters_showCacheNodeInfo :: Lens' DescribeCacheClusters (Maybe Bool)

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

describeCacheClustersResponse_cacheClusters :: Lens' DescribeCacheClustersResponse (Maybe [CacheCluster])

A list of clusters. Each item in the list contains detailed information about one cluster.

describeCacheClustersResponse_marker :: Lens' DescribeCacheClustersResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeCacheClustersResponse_httpStatus :: Lens' DescribeCacheClustersResponse Int

The response's http status code.

DescribeCacheEngineVersions

describeCacheEngineVersions_cacheParameterGroupFamily :: Lens' DescribeCacheEngineVersions (Maybe Text)

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

describeCacheEngineVersions_defaultOnly :: Lens' DescribeCacheEngineVersions (Maybe Bool)

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

describeCacheEngineVersions_engine :: Lens' DescribeCacheEngineVersions (Maybe Text)

The cache engine to return. Valid values: memcached | redis

describeCacheEngineVersions_engineVersion :: Lens' DescribeCacheEngineVersions (Maybe Text)

The cache engine version to return.

Example: 1.4.14

describeCacheEngineVersions_marker :: Lens' DescribeCacheEngineVersions (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeCacheEngineVersions_maxRecords :: Lens' DescribeCacheEngineVersions (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeCacheEngineVersionsResponse_cacheEngineVersions :: Lens' DescribeCacheEngineVersionsResponse (Maybe [CacheEngineVersion])

A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

describeCacheEngineVersionsResponse_marker :: Lens' DescribeCacheEngineVersionsResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeCacheEngineVersionsResponse_httpStatus :: Lens' DescribeCacheEngineVersionsResponse Int

The response's http status code.

DescribeCacheParameterGroups

describeCacheParameterGroups_cacheParameterGroupName :: Lens' DescribeCacheParameterGroups (Maybe Text)

The name of a specific cache parameter group to return details for.

describeCacheParameterGroups_marker :: Lens' DescribeCacheParameterGroups (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeCacheParameterGroups_maxRecords :: Lens' DescribeCacheParameterGroups (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeCacheParameterGroupsResponse_cacheParameterGroups :: Lens' DescribeCacheParameterGroupsResponse (Maybe [CacheParameterGroup])

A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

describeCacheParameterGroupsResponse_marker :: Lens' DescribeCacheParameterGroupsResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeCacheParameterGroupsResponse_httpStatus :: Lens' DescribeCacheParameterGroupsResponse Int

The response's http status code.

DescribeCacheParameters

describeCacheParameters_marker :: Lens' DescribeCacheParameters (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeCacheParameters_maxRecords :: Lens' DescribeCacheParameters (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeCacheParameters_source :: Lens' DescribeCacheParameters (Maybe Text)

The parameter types to return.

Valid values: user | system | engine-default

describeCacheParameters_cacheParameterGroupName :: Lens' DescribeCacheParameters Text

The name of a specific cache parameter group to return details for.

describeCacheParametersResponse_cacheNodeTypeSpecificParameters :: Lens' DescribeCacheParametersResponse (Maybe [CacheNodeTypeSpecificParameter])

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

describeCacheParametersResponse_marker :: Lens' DescribeCacheParametersResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeCacheParametersResponse_parameters :: Lens' DescribeCacheParametersResponse (Maybe [Parameter])

A list of Parameter instances.

describeCacheParametersResponse_httpStatus :: Lens' DescribeCacheParametersResponse Int

The response's http status code.

DescribeCacheSecurityGroups

describeCacheSecurityGroups_cacheSecurityGroupName :: Lens' DescribeCacheSecurityGroups (Maybe Text)

The name of the cache security group to return details for.

describeCacheSecurityGroups_marker :: Lens' DescribeCacheSecurityGroups (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeCacheSecurityGroups_maxRecords :: Lens' DescribeCacheSecurityGroups (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeCacheSecurityGroupsResponse_cacheSecurityGroups :: Lens' DescribeCacheSecurityGroupsResponse (Maybe [CacheSecurityGroup])

A list of cache security groups. Each element in the list contains detailed information about one group.

describeCacheSecurityGroupsResponse_marker :: Lens' DescribeCacheSecurityGroupsResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeCacheSecurityGroupsResponse_httpStatus :: Lens' DescribeCacheSecurityGroupsResponse Int

The response's http status code.

DescribeCacheSubnetGroups

describeCacheSubnetGroups_cacheSubnetGroupName :: Lens' DescribeCacheSubnetGroups (Maybe Text)

The name of the cache subnet group to return details for.

describeCacheSubnetGroups_marker :: Lens' DescribeCacheSubnetGroups (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeCacheSubnetGroups_maxRecords :: Lens' DescribeCacheSubnetGroups (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeCacheSubnetGroupsResponse_cacheSubnetGroups :: Lens' DescribeCacheSubnetGroupsResponse (Maybe [CacheSubnetGroup])

A list of cache subnet groups. Each element in the list contains detailed information about one group.

describeCacheSubnetGroupsResponse_marker :: Lens' DescribeCacheSubnetGroupsResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeCacheSubnetGroupsResponse_httpStatus :: Lens' DescribeCacheSubnetGroupsResponse Int

The response's http status code.

DescribeEngineDefaultParameters

describeEngineDefaultParameters_marker :: Lens' DescribeEngineDefaultParameters (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEngineDefaultParameters_maxRecords :: Lens' DescribeEngineDefaultParameters (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeEngineDefaultParameters_cacheParameterGroupFamily :: Lens' DescribeEngineDefaultParameters Text

The name of the cache parameter group family.

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7

describeEngineDefaultParametersResponse_httpStatus :: Lens' DescribeEngineDefaultParametersResponse Int

The response's http status code.

describeEngineDefaultParametersResponse_engineDefaults :: Lens' DescribeEngineDefaultParametersResponse EngineDefaults

Undocumented member.

DescribeEvents

describeEvents_duration :: Lens' DescribeEvents (Maybe Int)

The number of minutes worth of events to retrieve.

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

describeEvents_marker :: Lens' DescribeEvents (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text)

The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType)

The event source to retrieve events for. If no value is specified, all events are returned.

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event])

A list of events. Each element in the list contains detailed information about one event.

describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int

The response's http status code.

DescribeGlobalReplicationGroups

describeGlobalReplicationGroups_globalReplicationGroupId :: Lens' DescribeGlobalReplicationGroups (Maybe Text)

The name of the Global datastore

describeGlobalReplicationGroups_marker :: Lens' DescribeGlobalReplicationGroups (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeGlobalReplicationGroups_maxRecords :: Lens' DescribeGlobalReplicationGroups (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

describeGlobalReplicationGroups_showMemberInfo :: Lens' DescribeGlobalReplicationGroups (Maybe Bool)

Returns the list of members that comprise the Global datastore.

describeGlobalReplicationGroupsResponse_globalReplicationGroups :: Lens' DescribeGlobalReplicationGroupsResponse (Maybe [GlobalReplicationGroup])

Indicates the slot configuration and global identifier for each slice group.

describeGlobalReplicationGroupsResponse_marker :: Lens' DescribeGlobalReplicationGroupsResponse (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

describeGlobalReplicationGroupsResponse_httpStatus :: Lens' DescribeGlobalReplicationGroupsResponse Int

The response's http status code.

DescribeReplicationGroups

describeReplicationGroups_marker :: Lens' DescribeReplicationGroups (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReplicationGroups_maxRecords :: Lens' DescribeReplicationGroups (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeReplicationGroups_replicationGroupId :: Lens' DescribeReplicationGroups (Maybe Text)

The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

describeReplicationGroupsResponse_marker :: Lens' DescribeReplicationGroupsResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeReplicationGroupsResponse_replicationGroups :: Lens' DescribeReplicationGroupsResponse (Maybe [ReplicationGroup])

A list of replication groups. Each item in the list contains detailed information about one replication group.

describeReplicationGroupsResponse_httpStatus :: Lens' DescribeReplicationGroupsResponse Int

The response's http status code.

DescribeReservedCacheNodes

describeReservedCacheNodes_cacheNodeType :: Lens' DescribeReservedCacheNodes (Maybe Text)

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

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.

describeReservedCacheNodes_duration :: Lens' DescribeReservedCacheNodes (Maybe Text)

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

describeReservedCacheNodes_marker :: Lens' DescribeReservedCacheNodes (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedCacheNodes_maxRecords :: Lens' DescribeReservedCacheNodes (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeReservedCacheNodes_offeringType :: Lens' DescribeReservedCacheNodes (Maybe Text)

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"

describeReservedCacheNodes_productDescription :: Lens' DescribeReservedCacheNodes (Maybe Text)

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

describeReservedCacheNodes_reservedCacheNodeId :: Lens' DescribeReservedCacheNodes (Maybe Text)

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

describeReservedCacheNodes_reservedCacheNodesOfferingId :: Lens' DescribeReservedCacheNodes (Maybe Text)

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

describeReservedCacheNodesResponse_marker :: Lens' DescribeReservedCacheNodesResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeReservedCacheNodesResponse_reservedCacheNodes :: Lens' DescribeReservedCacheNodesResponse (Maybe [ReservedCacheNode])

A list of reserved cache nodes. Each element in the list contains detailed information about one node.

describeReservedCacheNodesResponse_httpStatus :: Lens' DescribeReservedCacheNodesResponse Int

The response's http status code.

DescribeReservedCacheNodesOfferings

describeReservedCacheNodesOfferings_cacheNodeType :: Lens' DescribeReservedCacheNodesOfferings (Maybe Text)

The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

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.

describeReservedCacheNodesOfferings_duration :: Lens' DescribeReservedCacheNodesOfferings (Maybe Text)

Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

Valid Values: 1 | 3 | 31536000 | 94608000

describeReservedCacheNodesOfferings_marker :: Lens' DescribeReservedCacheNodesOfferings (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedCacheNodesOfferings_maxRecords :: Lens' DescribeReservedCacheNodesOfferings (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeReservedCacheNodesOfferings_offeringType :: Lens' DescribeReservedCacheNodesOfferings (Maybe Text)

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"

describeReservedCacheNodesOfferings_productDescription :: Lens' DescribeReservedCacheNodesOfferings (Maybe Text)

The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

describeReservedCacheNodesOfferings_reservedCacheNodesOfferingId :: Lens' DescribeReservedCacheNodesOfferings (Maybe Text)

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

describeReservedCacheNodesOfferingsResponse_marker :: Lens' DescribeReservedCacheNodesOfferingsResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeReservedCacheNodesOfferingsResponse_reservedCacheNodesOfferings :: Lens' DescribeReservedCacheNodesOfferingsResponse (Maybe [ReservedCacheNodesOffering])

A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

describeReservedCacheNodesOfferingsResponse_httpStatus :: Lens' DescribeReservedCacheNodesOfferingsResponse Int

The response's http status code.

DescribeServiceUpdates

describeServiceUpdates_marker :: Lens' DescribeServiceUpdates (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeServiceUpdates_maxRecords :: Lens' DescribeServiceUpdates (Maybe Int)

The maximum number of records to include in the response

describeServiceUpdates_serviceUpdateName :: Lens' DescribeServiceUpdates (Maybe Text)

The unique ID of the service update

describeServiceUpdates_serviceUpdateStatus :: Lens' DescribeServiceUpdates (Maybe [ServiceUpdateStatus])

The status of the service update

describeServiceUpdatesResponse_marker :: Lens' DescribeServiceUpdatesResponse (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeServiceUpdatesResponse_serviceUpdates :: Lens' DescribeServiceUpdatesResponse (Maybe [ServiceUpdate])

A list of service updates

describeServiceUpdatesResponse_httpStatus :: Lens' DescribeServiceUpdatesResponse Int

The response's http status code.

DescribeSnapshots

describeSnapshots_cacheClusterId :: Lens' DescribeSnapshots (Maybe Text)

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

describeSnapshots_marker :: Lens' DescribeSnapshots (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeSnapshots_maxRecords :: Lens' DescribeSnapshots (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

describeSnapshots_replicationGroupId :: Lens' DescribeSnapshots (Maybe Text)

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

describeSnapshots_showNodeGroupConfig :: Lens' DescribeSnapshots (Maybe Bool)

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

describeSnapshots_snapshotName :: Lens' DescribeSnapshots (Maybe Text)

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

describeSnapshots_snapshotSource :: Lens' DescribeSnapshots (Maybe Text)

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

describeSnapshotsResponse_marker :: Lens' DescribeSnapshotsResponse (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot])

A list of snapshots. Each item in the list contains detailed information about one snapshot.

describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int

The response's http status code.

DescribeUpdateActions

describeUpdateActions_cacheClusterIds :: Lens' DescribeUpdateActions (Maybe [Text])

The cache cluster IDs

describeUpdateActions_engine :: Lens' DescribeUpdateActions (Maybe Text)

The Elasticache engine to which the update applies. Either Redis or Memcached

describeUpdateActions_marker :: Lens' DescribeUpdateActions (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeUpdateActions_maxRecords :: Lens' DescribeUpdateActions (Maybe Int)

The maximum number of records to include in the response

describeUpdateActions_replicationGroupIds :: Lens' DescribeUpdateActions (Maybe [Text])

The replication group IDs

describeUpdateActions_serviceUpdateName :: Lens' DescribeUpdateActions (Maybe Text)

The unique ID of the service update

describeUpdateActions_serviceUpdateStatus :: Lens' DescribeUpdateActions (Maybe [ServiceUpdateStatus])

The status of the service update

describeUpdateActions_serviceUpdateTimeRange :: Lens' DescribeUpdateActions (Maybe TimeRangeFilter)

The range of time specified to search for service updates that are in available status

describeUpdateActions_showNodeLevelUpdateStatus :: Lens' DescribeUpdateActions (Maybe Bool)

Dictates whether to include node level update status in the response

describeUpdateActions_updateActionStatus :: Lens' DescribeUpdateActions (Maybe [UpdateActionStatus])

The status of the update action.

describeUpdateActionsResponse_marker :: Lens' DescribeUpdateActionsResponse (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeUpdateActionsResponse_updateActions :: Lens' DescribeUpdateActionsResponse (Maybe [UpdateAction])

Returns a list of update actions

describeUpdateActionsResponse_httpStatus :: Lens' DescribeUpdateActionsResponse Int

The response's http status code.

DescribeUserGroups

describeUserGroups_marker :: Lens' DescribeUserGroups (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

describeUserGroups_maxRecords :: Lens' DescribeUserGroups (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

describeUserGroups_userGroupId :: Lens' DescribeUserGroups (Maybe Text)

The ID of the user group.

describeUserGroupsResponse_marker :: Lens' DescribeUserGroupsResponse (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

describeUserGroupsResponse_userGroups :: Lens' DescribeUserGroupsResponse (Maybe [UserGroup])

Returns a list of user groups.

describeUserGroupsResponse_httpStatus :: Lens' DescribeUserGroupsResponse Int

The response's http status code.

DescribeUsers

describeUsers_engine :: Lens' DescribeUsers (Maybe Text)

The Redis engine.

describeUsers_filters :: Lens' DescribeUsers (Maybe [Filter])

Filter to determine the list of User IDs to return.

describeUsers_marker :: Lens' DescribeUsers (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

describeUsers_maxRecords :: Lens' DescribeUsers (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

describeUsers_userId :: Lens' DescribeUsers (Maybe Text)

The ID of the user.

describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])

A list of users.

describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int

The response's http status code.

DisassociateGlobalReplicationGroup

disassociateGlobalReplicationGroup_globalReplicationGroupId :: Lens' DisassociateGlobalReplicationGroup Text

The name of the Global datastore

disassociateGlobalReplicationGroup_replicationGroupId :: Lens' DisassociateGlobalReplicationGroup Text

The name of the secondary cluster you wish to remove from the Global datastore

disassociateGlobalReplicationGroup_replicationGroupRegion :: Lens' DisassociateGlobalReplicationGroup Text

The Amazon region of secondary cluster you wish to remove from the Global datastore

disassociateGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' DisassociateGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)

Undocumented member.

disassociateGlobalReplicationGroupResponse_httpStatus :: Lens' DisassociateGlobalReplicationGroupResponse Int

The response's http status code.

FailoverGlobalReplicationGroup

failoverGlobalReplicationGroup_globalReplicationGroupId :: Lens' FailoverGlobalReplicationGroup Text

The name of the Global datastore

failoverGlobalReplicationGroup_primaryRegion :: Lens' FailoverGlobalReplicationGroup Text

The Amazon region of the primary cluster of the Global datastore

failoverGlobalReplicationGroup_primaryReplicationGroupId :: Lens' FailoverGlobalReplicationGroup Text

The name of the primary replication group

failoverGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' FailoverGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)

Undocumented member.

failoverGlobalReplicationGroupResponse_httpStatus :: Lens' FailoverGlobalReplicationGroupResponse Int

The response's http status code.

IncreaseNodeGroupsInGlobalReplicationGroup

increaseNodeGroupsInGlobalReplicationGroup_regionalConfigurations :: Lens' IncreaseNodeGroupsInGlobalReplicationGroup (Maybe [RegionalConfiguration])

Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore

increaseNodeGroupsInGlobalReplicationGroup_globalReplicationGroupId :: Lens' IncreaseNodeGroupsInGlobalReplicationGroup Text

The name of the Global datastore

increaseNodeGroupsInGlobalReplicationGroup_nodeGroupCount :: Lens' IncreaseNodeGroupsInGlobalReplicationGroup Int

The number of node groups you wish to add

increaseNodeGroupsInGlobalReplicationGroup_applyImmediately :: Lens' IncreaseNodeGroupsInGlobalReplicationGroup Bool

Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.

increaseNodeGroupsInGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' IncreaseNodeGroupsInGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)

Undocumented member.

increaseNodeGroupsInGlobalReplicationGroupResponse_httpStatus :: Lens' IncreaseNodeGroupsInGlobalReplicationGroupResponse Int

The response's http status code.

IncreaseReplicaCount

increaseReplicaCount_newReplicaCount :: Lens' IncreaseReplicaCount (Maybe Int)

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

increaseReplicaCount_replicaConfiguration :: Lens' IncreaseReplicaCount (Maybe [ConfigureShard])

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

increaseReplicaCount_replicationGroupId :: Lens' IncreaseReplicaCount Text

The id of the replication group to which you want to add replica nodes.

increaseReplicaCount_applyImmediately :: Lens' IncreaseReplicaCount Bool

If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

increaseReplicaCountResponse_replicationGroup :: Lens' IncreaseReplicaCountResponse (Maybe ReplicationGroup)

Undocumented member.

increaseReplicaCountResponse_httpStatus :: Lens' IncreaseReplicaCountResponse Int

The response's http status code.

ListAllowedNodeTypeModifications

listAllowedNodeTypeModifications_cacheClusterId :: Lens' ListAllowedNodeTypeModifications (Maybe Text)

The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.

You must provide a value for either the CacheClusterId or the ReplicationGroupId.

listAllowedNodeTypeModifications_replicationGroupId :: Lens' ListAllowedNodeTypeModifications (Maybe Text)

The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.

You must provide a value for either the CacheClusterId or the ReplicationGroupId.

listAllowedNodeTypeModificationsResponse_scaleDownModifications :: Lens' ListAllowedNodeTypeModificationsResponse (Maybe [Text])

A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

listAllowedNodeTypeModificationsResponse_scaleUpModifications :: Lens' ListAllowedNodeTypeModificationsResponse (Maybe [Text])

A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.

When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

listAllowedNodeTypeModificationsResponse_httpStatus :: Lens' ListAllowedNodeTypeModificationsResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_resourceName :: Lens' ListTagsForResource Text

The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

tagListMessage_tagList :: Lens' TagListMessage (Maybe [Tag])

A list of tags as key-value pairs.

ModifyCacheCluster

modifyCacheCluster_aZMode :: Lens' ModifyCacheCluster (Maybe AZMode)

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached clusters.

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones.

modifyCacheCluster_applyImmediately :: Lens' ModifyCacheCluster (Maybe 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 cluster.

If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: true | false

Default: false

modifyCacheCluster_authToken :: Lens' ModifyCacheCluster (Maybe Text)

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update 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.

modifyCacheCluster_authTokenUpdateStrategy :: Lens' ModifyCacheCluster (Maybe 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

modifyCacheCluster_autoMinorVersionUpgrade :: Lens' ModifyCacheCluster (Maybe 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.

modifyCacheCluster_cacheNodeIdsToRemove :: Lens' ModifyCacheCluster (Maybe [Text])

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

modifyCacheCluster_cacheNodeType :: Lens' ModifyCacheCluster (Maybe Text)

A valid cache node type that you want to scale this cluster up to.

modifyCacheCluster_cacheParameterGroupName :: Lens' ModifyCacheCluster (Maybe Text)

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

modifyCacheCluster_cacheSecurityGroupNames :: Lens' ModifyCacheCluster (Maybe [Text])

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

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

modifyCacheCluster_engineVersion :: Lens' ModifyCacheCluster (Maybe Text)

The upgraded version of the cache engine to be run on the cache nodes.

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

modifyCacheCluster_ipDiscovery :: Lens' ModifyCacheCluster (Maybe IpDiscovery)

The network type you choose when modifying a 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.

modifyCacheCluster_logDeliveryConfigurations :: Lens' ModifyCacheCluster (Maybe [LogDeliveryConfigurationRequest])

Specifies the destination, format and type of the logs.

modifyCacheCluster_newAvailabilityZones :: Lens' ModifyCacheCluster (Maybe [Text])

This option is only supported on Memcached clusters.

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

Scenarios:

• Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
• Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.
• Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the __Availability Zone Considerations__ section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

• Scenario-1

  • Pending Action: Delete
  • New Request: Delete
  • Result: The new delete, pending or immediate, replaces the pending delete.

• Scenario-2

  • Pending Action: Delete
  • New Request: Create
  • Result: The new create, pending or immediate, replaces the pending delete.

• Scenario-3

  • Pending Action: Create
  • New Request: Delete
  • Result: The new delete, pending or immediate, replaces the pending create.

• Scenario-4

  • Pending Action: Create
  • New Request: Create

  • Result: The new create is added to the pending create.

    Important: If the new create request is __Apply Immediately - Yes__, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

modifyCacheCluster_notificationTopicArn :: Lens' ModifyCacheCluster (Maybe Text)

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 cluster owner.

modifyCacheCluster_notificationTopicStatus :: Lens' ModifyCacheCluster (Maybe Text)

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

Valid values: active | inactive

modifyCacheCluster_numCacheNodes :: Lens' ModifyCacheCluster (Maybe Int)

The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

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

Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.

modifyCacheCluster_preferredMaintenanceWindow :: Lens' ModifyCacheCluster (Maybe Text)

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

modifyCacheCluster_securityGroupIds :: Lens' ModifyCacheCluster (Maybe [Text])

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

modifyCacheCluster_snapshotRetentionLimit :: Lens' ModifyCacheCluster (Maybe Int)

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.

modifyCacheCluster_snapshotWindow :: Lens' ModifyCacheCluster (Maybe Text)

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

modifyCacheCluster_cacheClusterId :: Lens' ModifyCacheCluster Text

The cluster identifier. This value is stored as a lowercase string.

modifyCacheClusterResponse_cacheCluster :: Lens' ModifyCacheClusterResponse (Maybe CacheCluster)

Undocumented member.

modifyCacheClusterResponse_httpStatus :: Lens' ModifyCacheClusterResponse Int

The response's http status code.

ModifyCacheParameterGroup

modifyCacheParameterGroup_cacheParameterGroupName :: Lens' ModifyCacheParameterGroup Text

The name of the cache parameter group to modify.

modifyCacheParameterGroup_parameterNameValues :: Lens' ModifyCacheParameterGroup [ParameterNameValue]

An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

cacheParameterGroupNameMessage_cacheParameterGroupName :: Lens' CacheParameterGroupNameMessage (Maybe Text)

The name of the cache parameter group.

ModifyCacheSubnetGroup

modifyCacheSubnetGroup_cacheSubnetGroupDescription :: Lens' ModifyCacheSubnetGroup (Maybe Text)

A description of the cache subnet group.

modifyCacheSubnetGroup_subnetIds :: Lens' ModifyCacheSubnetGroup (Maybe [Text])

The EC2 subnet IDs for the cache subnet group.

modifyCacheSubnetGroup_cacheSubnetGroupName :: Lens' ModifyCacheSubnetGroup Text

The name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

modifyCacheSubnetGroupResponse_cacheSubnetGroup :: Lens' ModifyCacheSubnetGroupResponse (Maybe CacheSubnetGroup)

Undocumented member.

modifyCacheSubnetGroupResponse_httpStatus :: Lens' ModifyCacheSubnetGroupResponse Int

The response's http status code.

ModifyGlobalReplicationGroup

modifyGlobalReplicationGroup_automaticFailoverEnabled :: Lens' ModifyGlobalReplicationGroup (Maybe Bool)

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

modifyGlobalReplicationGroup_cacheNodeType :: Lens' ModifyGlobalReplicationGroup (Maybe Text)

A valid cache node type that you want to scale this Global datastore to.

modifyGlobalReplicationGroup_cacheParameterGroupName :: Lens' ModifyGlobalReplicationGroup (Maybe Text)

The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

modifyGlobalReplicationGroup_engineVersion :: Lens' ModifyGlobalReplicationGroup (Maybe Text)

The upgraded version of the cache engine to be run on the clusters in the Global datastore.

modifyGlobalReplicationGroup_globalReplicationGroupDescription :: Lens' ModifyGlobalReplicationGroup (Maybe Text)

A description of the Global datastore

modifyGlobalReplicationGroup_globalReplicationGroupId :: Lens' ModifyGlobalReplicationGroup Text

The name of the Global datastore

modifyGlobalReplicationGroup_applyImmediately :: Lens' ModifyGlobalReplicationGroup Bool

This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

modifyGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' ModifyGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)

Undocumented member.

modifyGlobalReplicationGroupResponse_httpStatus :: Lens' ModifyGlobalReplicationGroupResponse Int

The response's http status code.

ModifyReplicationGroup

modifyReplicationGroup_applyImmediately :: Lens' ModifyReplicationGroup (Maybe 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

modifyReplicationGroup_authToken :: Lens' ModifyReplicationGroup (Maybe Text)

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.

modifyReplicationGroup_authTokenUpdateStrategy :: Lens' ModifyReplicationGroup (Maybe 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

modifyReplicationGroup_autoMinorVersionUpgrade :: Lens' ModifyReplicationGroup (Maybe 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.

modifyReplicationGroup_automaticFailoverEnabled :: Lens' ModifyReplicationGroup (Maybe Bool)

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

Valid values: true | false

modifyReplicationGroup_cacheNodeType :: Lens' ModifyReplicationGroup (Maybe Text)

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

modifyReplicationGroup_cacheParameterGroupName :: Lens' ModifyReplicationGroup (Maybe Text)

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.

modifyReplicationGroup_cacheSecurityGroupNames :: Lens' ModifyReplicationGroup (Maybe [Text])

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.

modifyReplicationGroup_engineVersion :: Lens' ModifyReplicationGroup (Maybe Text)

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.

modifyReplicationGroup_ipDiscovery :: Lens' ModifyReplicationGroup (Maybe IpDiscovery)

The network type you choose when modifying a 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.

modifyReplicationGroup_logDeliveryConfigurations :: Lens' ModifyReplicationGroup (Maybe [LogDeliveryConfigurationRequest])

Specifies the destination, format and type of the logs.

modifyReplicationGroup_multiAZEnabled :: Lens' ModifyReplicationGroup (Maybe Bool)

A flag to indicate MultiAZ is enabled.

modifyReplicationGroup_nodeGroupId :: Lens' ModifyReplicationGroup (Maybe Text)

Deprecated. This parameter is not used.

modifyReplicationGroup_notificationTopicArn :: Lens' ModifyReplicationGroup (Maybe Text)

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.

modifyReplicationGroup_notificationTopicStatus :: Lens' ModifyReplicationGroup (Maybe Text)

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

modifyReplicationGroup_preferredMaintenanceWindow :: Lens' ModifyReplicationGroup (Maybe Text)

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

modifyReplicationGroup_primaryClusterId :: Lens' ModifyReplicationGroup (Maybe Text)

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.

modifyReplicationGroup_removeUserGroups :: Lens' ModifyReplicationGroup (Maybe Bool)

Removes the user group associated with this replication group.

modifyReplicationGroup_replicationGroupDescription :: Lens' ModifyReplicationGroup (Maybe Text)

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

modifyReplicationGroup_securityGroupIds :: Lens' ModifyReplicationGroup (Maybe [Text])

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

modifyReplicationGroup_snapshotRetentionLimit :: Lens' ModifyReplicationGroup (Maybe Int)

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.

modifyReplicationGroup_snapshotWindow :: Lens' ModifyReplicationGroup (Maybe Text)

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.

modifyReplicationGroup_snapshottingClusterId :: Lens' ModifyReplicationGroup (Maybe Text)

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.

modifyReplicationGroup_transitEncryptionEnabled :: Lens' ModifyReplicationGroup (Maybe Bool)

A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set TransitEncryptionMode to preferred.

modifyReplicationGroup_transitEncryptionMode :: Lens' ModifyReplicationGroup (Maybe TransitEncryptionMode)

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

You must set TransitEncryptionEnabled to true, for your existing cluster, and set TransitEncryptionMode to preferred in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can set the value to required to allow encrypted connections only.

Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred first, after that you can set TransitEncryptionMode to required.

modifyReplicationGroup_userGroupIdsToAdd :: Lens' ModifyReplicationGroup (Maybe [Text])

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

modifyReplicationGroup_userGroupIdsToRemove :: Lens' ModifyReplicationGroup (Maybe [Text])

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.

modifyReplicationGroup_replicationGroupId :: Lens' ModifyReplicationGroup Text

The identifier of the replication group to modify.

modifyReplicationGroupResponse_replicationGroup :: Lens' ModifyReplicationGroupResponse (Maybe ReplicationGroup)

Undocumented member.

modifyReplicationGroupResponse_httpStatus :: Lens' ModifyReplicationGroupResponse Int

The response's http status code.

ModifyReplicationGroupShardConfiguration

modifyReplicationGroupShardConfiguration_nodeGroupsToRemove :: Lens' ModifyReplicationGroupShardConfiguration (Maybe [Text])

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

modifyReplicationGroupShardConfiguration_nodeGroupsToRetain :: Lens' ModifyReplicationGroupShardConfiguration (Maybe [Text])

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

modifyReplicationGroupShardConfiguration_reshardingConfiguration :: Lens' ModifyReplicationGroupShardConfiguration (Maybe [ReshardingConfiguration])

Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

modifyReplicationGroupShardConfiguration_replicationGroupId :: Lens' ModifyReplicationGroupShardConfiguration Text

The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

modifyReplicationGroupShardConfiguration_nodeGroupCount :: Lens' ModifyReplicationGroupShardConfiguration Int

The number of node groups (shards) that results from the modification of the shard configuration.

modifyReplicationGroupShardConfiguration_applyImmediately :: Lens' ModifyReplicationGroupShardConfiguration Bool

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Value: true

modifyReplicationGroupShardConfigurationResponse_replicationGroup :: Lens' ModifyReplicationGroupShardConfigurationResponse (Maybe ReplicationGroup)

Undocumented member.

modifyReplicationGroupShardConfigurationResponse_httpStatus :: Lens' ModifyReplicationGroupShardConfigurationResponse Int

The response's http status code.

ModifyUser

modifyUser_accessString :: Lens' ModifyUser (Maybe Text)

Access permissions string used for this user.

modifyUser_appendAccessString :: Lens' ModifyUser (Maybe Text)

Adds additional user permissions to the access string.

modifyUser_authenticationMode :: Lens' ModifyUser (Maybe AuthenticationMode)

Specifies how to authenticate the user.

modifyUser_noPasswordRequired :: Lens' ModifyUser (Maybe Bool)

Indicates no password is required for the user.

modifyUser_passwords :: Lens' ModifyUser (Maybe (NonEmpty Text))

The passwords belonging to the user. You are allowed up to two.

modifyUser_userId :: Lens' ModifyUser Text

The ID of the user.

user_arn :: Lens' User (Maybe Text)

The Amazon Resource Name (ARN) of the user.

user_accessString :: Lens' User (Maybe Text)

Access permissions string used for this user.

user_authentication :: Lens' User (Maybe Authentication)

Denotes whether the user requires a password to authenticate.

user_engine :: Lens' User (Maybe Text)

The current supported value is Redis.

user_minimumEngineVersion :: Lens' User (Maybe Text)

The minimum engine version required, which is Redis 6.0

user_status :: Lens' User (Maybe Text)

Indicates the user status. Can be "active", "modifying" or "deleting".

user_userGroupIds :: Lens' User (Maybe [Text])

Returns a list of the user group IDs the user belongs to.

user_userId :: Lens' User (Maybe Text)

The ID of the user.

user_userName :: Lens' User (Maybe Text)

The username of the user.

ModifyUserGroup

modifyUserGroup_userIdsToAdd :: Lens' ModifyUserGroup (Maybe (NonEmpty Text))

The list of user IDs to add to the user group.

modifyUserGroup_userIdsToRemove :: Lens' ModifyUserGroup (Maybe (NonEmpty Text))

The list of user IDs to remove from the user group.

modifyUserGroup_userGroupId :: Lens' ModifyUserGroup Text

The ID of the user group.

userGroup_arn :: Lens' UserGroup (Maybe Text)

The Amazon Resource Name (ARN) of the user group.

userGroup_engine :: Lens' UserGroup (Maybe Text)

The current supported value is Redis.

userGroup_minimumEngineVersion :: Lens' UserGroup (Maybe Text)

The minimum engine version required, which is Redis 6.0

userGroup_pendingChanges :: Lens' UserGroup (Maybe UserGroupPendingChanges)

A list of updates being applied to the user group.

userGroup_replicationGroups :: Lens' UserGroup (Maybe [Text])

A list of replication groups that the user group can access.

userGroup_status :: Lens' UserGroup (Maybe Text)

Indicates user group status. Can be "creating", "active", "modifying", "deleting".

userGroup_userGroupId :: Lens' UserGroup (Maybe Text)

The ID of the user group.

userGroup_userIds :: Lens' UserGroup (Maybe [Text])

The list of user IDs that belong to the user group.

PurchaseReservedCacheNodesOffering

purchaseReservedCacheNodesOffering_cacheNodeCount :: Lens' PurchaseReservedCacheNodesOffering (Maybe Int)

The number of cache node instances to reserve.

Default: 1

purchaseReservedCacheNodesOffering_reservedCacheNodeId :: Lens' PurchaseReservedCacheNodesOffering (Maybe Text)

A customer-specified identifier to track this reservation.

The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.

Example: myreservationID

purchaseReservedCacheNodesOffering_tags :: Lens' PurchaseReservedCacheNodesOffering (Maybe [Tag])

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

purchaseReservedCacheNodesOffering_reservedCacheNodesOfferingId :: Lens' PurchaseReservedCacheNodesOffering Text

The ID of the reserved cache node offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

purchaseReservedCacheNodesOfferingResponse_reservedCacheNode :: Lens' PurchaseReservedCacheNodesOfferingResponse (Maybe ReservedCacheNode)

Undocumented member.

purchaseReservedCacheNodesOfferingResponse_httpStatus :: Lens' PurchaseReservedCacheNodesOfferingResponse Int

The response's http status code.

RebalanceSlotsInGlobalReplicationGroup

rebalanceSlotsInGlobalReplicationGroup_globalReplicationGroupId :: Lens' RebalanceSlotsInGlobalReplicationGroup Text

The name of the Global datastore

rebalanceSlotsInGlobalReplicationGroup_applyImmediately :: Lens' RebalanceSlotsInGlobalReplicationGroup Bool

If True, redistribution is applied immediately.

rebalanceSlotsInGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' RebalanceSlotsInGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)

Undocumented member.

rebalanceSlotsInGlobalReplicationGroupResponse_httpStatus :: Lens' RebalanceSlotsInGlobalReplicationGroupResponse Int

The response's http status code.

RebootCacheCluster

rebootCacheCluster_cacheClusterId :: Lens' RebootCacheCluster Text

The cluster identifier. This parameter is stored as a lowercase string.

rebootCacheCluster_cacheNodeIdsToReboot :: Lens' RebootCacheCluster [Text]

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

rebootCacheClusterResponse_cacheCluster :: Lens' RebootCacheClusterResponse (Maybe CacheCluster)

Undocumented member.

rebootCacheClusterResponse_httpStatus :: Lens' RebootCacheClusterResponse Int

The response's http status code.

RemoveTagsFromResource

removeTagsFromResource_resourceName :: Lens' RemoveTagsFromResource Text

The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

removeTagsFromResource_tagKeys :: Lens' RemoveTagsFromResource [Text]

A list of TagKeys identifying the tags you want removed from the named resource.

tagListMessage_tagList :: Lens' TagListMessage (Maybe [Tag])

A list of tags as key-value pairs.

ResetCacheParameterGroup

resetCacheParameterGroup_parameterNameValues :: Lens' ResetCacheParameterGroup (Maybe [ParameterNameValue])

An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.

resetCacheParameterGroup_resetAllParameters :: Lens' ResetCacheParameterGroup (Maybe Bool)

If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values.

Valid values: true | false

resetCacheParameterGroup_cacheParameterGroupName :: Lens' ResetCacheParameterGroup Text

The name of the cache parameter group to reset.

cacheParameterGroupNameMessage_cacheParameterGroupName :: Lens' CacheParameterGroupNameMessage (Maybe Text)

The name of the cache parameter group.

RevokeCacheSecurityGroupIngress

revokeCacheSecurityGroupIngress_cacheSecurityGroupName :: Lens' RevokeCacheSecurityGroupIngress Text

The name of the cache security group to revoke ingress from.

revokeCacheSecurityGroupIngress_eC2SecurityGroupName :: Lens' RevokeCacheSecurityGroupIngress Text

The name of the Amazon EC2 security group to revoke access from.

revokeCacheSecurityGroupIngress_eC2SecurityGroupOwnerId :: Lens' RevokeCacheSecurityGroupIngress Text

The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.

revokeCacheSecurityGroupIngressResponse_cacheSecurityGroup :: Lens' RevokeCacheSecurityGroupIngressResponse (Maybe CacheSecurityGroup)

Undocumented member.

revokeCacheSecurityGroupIngressResponse_httpStatus :: Lens' RevokeCacheSecurityGroupIngressResponse Int

The response's http status code.

StartMigration

startMigration_replicationGroupId :: Lens' StartMigration Text

The ID of the replication group to which data should be migrated.

startMigration_customerNodeEndpointList :: Lens' StartMigration [CustomerNodeEndpoint]

List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.

startMigrationResponse_replicationGroup :: Lens' StartMigrationResponse (Maybe ReplicationGroup)

Undocumented member.

startMigrationResponse_httpStatus :: Lens' StartMigrationResponse Int

The response's http status code.

TestFailover

testFailover_replicationGroupId :: Lens' TestFailover Text

The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.

testFailover_nodeGroupId :: Lens' TestFailover Text

The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.

testFailoverResponse_replicationGroup :: Lens' TestFailoverResponse (Maybe ReplicationGroup)

Undocumented member.

testFailoverResponse_httpStatus :: Lens' TestFailoverResponse Int

The response's http status code.

Types

Authentication

authentication_passwordCount :: Lens' Authentication (Maybe Int)

The number of passwords belonging to the user. The maximum is two.

authentication_type :: Lens' Authentication (Maybe AuthenticationType)

Indicates whether the user requires a password to authenticate.

AuthenticationMode

authenticationMode_passwords :: Lens' AuthenticationMode (Maybe (NonEmpty Text))

Specifies the passwords to use for authentication if Type is set to password.

authenticationMode_type :: Lens' AuthenticationMode (Maybe InputAuthenticationType)

Specifies the authentication type. Possible options are IAM authentication, password and no password.

AvailabilityZone

availabilityZone_name :: Lens' AvailabilityZone (Maybe Text)

The name of the Availability Zone.

CacheCluster

cacheCluster_arn :: Lens' CacheCluster (Maybe Text)

The ARN (Amazon Resource Name) of the cache cluster.

cacheCluster_atRestEncryptionEnabled :: Lens' CacheCluster (Maybe Bool)

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

cacheCluster_authTokenEnabled :: Lens' CacheCluster (Maybe Bool)

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

cacheCluster_authTokenLastModifiedDate :: Lens' CacheCluster (Maybe UTCTime)

The date the auth token was last modified

cacheCluster_autoMinorVersionUpgrade :: Lens' CacheCluster (Maybe 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.

cacheCluster_cacheClusterCreateTime :: Lens' CacheCluster (Maybe UTCTime)

The date and time when the cluster was created.

cacheCluster_cacheClusterId :: Lens' CacheCluster (Maybe Text)

The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

cacheCluster_cacheClusterStatus :: Lens' CacheCluster (Maybe Text)

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.

cacheCluster_cacheNodeType :: Lens' CacheCluster (Maybe Text)

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

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.

cacheCluster_cacheNodes :: Lens' CacheCluster (Maybe [CacheNode])

A list of cache nodes that are members of the cluster.

cacheCluster_cacheParameterGroup :: Lens' CacheCluster (Maybe CacheParameterGroupStatus)

Status of the cache parameter group.

cacheCluster_cacheSecurityGroups :: Lens' CacheCluster (Maybe [CacheSecurityGroupMembership])

A list of cache security group elements, composed of name and status sub-elements.

cacheCluster_cacheSubnetGroupName :: Lens' CacheCluster (Maybe Text)

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

cacheCluster_clientDownloadLandingPage :: Lens' CacheCluster (Maybe Text)

The URL of the web page where you can download the latest ElastiCache client library.

cacheCluster_configurationEndpoint :: Lens' CacheCluster (Maybe Endpoint)

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

cacheCluster_engine :: Lens' CacheCluster (Maybe Text)

The name of the cache engine (memcached or redis) to be used for this cluster.

cacheCluster_engineVersion :: Lens' CacheCluster (Maybe Text)

The version of the cache engine that is used in this cluster.

cacheCluster_ipDiscovery :: Lens' CacheCluster (Maybe IpDiscovery)

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.

cacheCluster_logDeliveryConfigurations :: Lens' CacheCluster (Maybe [LogDeliveryConfiguration])

Returns the destination, format and type of the logs.

cacheCluster_networkType :: Lens' CacheCluster (Maybe NetworkType)

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.

cacheCluster_notificationConfiguration :: Lens' CacheCluster (Maybe NotificationConfiguration)

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

cacheCluster_numCacheNodes :: Lens' CacheCluster (Maybe Int)

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.

cacheCluster_pendingModifiedValues :: Lens' CacheCluster (Maybe PendingModifiedValues)

Undocumented member.

cacheCluster_preferredAvailabilityZone :: Lens' CacheCluster (Maybe Text)

The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

cacheCluster_preferredMaintenanceWindow :: Lens' CacheCluster (Maybe Text)

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

cacheCluster_preferredOutpostArn :: Lens' CacheCluster (Maybe Text)

The outpost ARN in which the cache cluster is created.

cacheCluster_replicationGroupId :: Lens' CacheCluster (Maybe Text)

The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

cacheCluster_replicationGroupLogDeliveryEnabled :: Lens' CacheCluster (Maybe Bool)

A boolean value indicating whether log delivery is enabled for the replication group.

cacheCluster_securityGroups :: Lens' CacheCluster (Maybe [SecurityGroupMembership])

A list of VPC Security Groups associated with the cluster.

cacheCluster_snapshotRetentionLimit :: Lens' CacheCluster (Maybe Int)

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.

cacheCluster_snapshotWindow :: Lens' CacheCluster (Maybe Text)

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

Example: 05:00-09:00

cacheCluster_transitEncryptionEnabled :: Lens' CacheCluster (Maybe Bool)

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

cacheCluster_transitEncryptionMode :: Lens' CacheCluster (Maybe TransitEncryptionMode)

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

CacheEngineVersion

cacheEngineVersion_cacheEngineDescription :: Lens' CacheEngineVersion (Maybe Text)

The description of the cache engine.

cacheEngineVersion_cacheEngineVersionDescription :: Lens' CacheEngineVersion (Maybe Text)

The description of the cache engine version.

cacheEngineVersion_cacheParameterGroupFamily :: Lens' CacheEngineVersion (Maybe Text)

The name of the cache parameter group family associated with this cache engine.

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x

cacheEngineVersion_engine :: Lens' CacheEngineVersion (Maybe Text)

The name of the cache engine.

cacheEngineVersion_engineVersion :: Lens' CacheEngineVersion (Maybe Text)

The version number of the cache engine.

CacheNode

cacheNode_cacheNodeCreateTime :: Lens' CacheNode (Maybe UTCTime)

The date and time when the cache node was created.

cacheNode_cacheNodeId :: Lens' CacheNode (Maybe Text)

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.

cacheNode_cacheNodeStatus :: Lens' CacheNode (Maybe Text)

The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

cacheNode_customerAvailabilityZone :: Lens' CacheNode (Maybe Text)

The Availability Zone where this node was created and now resides.

cacheNode_customerOutpostArn :: Lens' CacheNode (Maybe Text)

The customer outpost ARN of the cache node.

cacheNode_endpoint :: Lens' CacheNode (Maybe Endpoint)

The hostname for connecting to this cache node.

cacheNode_parameterGroupStatus :: Lens' CacheNode (Maybe Text)

The status of the parameter group applied to this cache node.

cacheNode_sourceCacheNodeId :: Lens' CacheNode (Maybe Text)

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.

CacheNodeTypeSpecificParameter

cacheNodeTypeSpecificParameter_allowedValues :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

The valid range of values for the parameter.

cacheNodeTypeSpecificParameter_cacheNodeTypeSpecificValues :: Lens' CacheNodeTypeSpecificParameter (Maybe [CacheNodeTypeSpecificValue])

A list of cache node types and their corresponding values for this parameter.

cacheNodeTypeSpecificParameter_changeType :: Lens' CacheNodeTypeSpecificParameter (Maybe ChangeType)

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

cacheNodeTypeSpecificParameter_dataType :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

The valid data type for the parameter.

cacheNodeTypeSpecificParameter_description :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

A description of the parameter.

cacheNodeTypeSpecificParameter_isModifiable :: Lens' CacheNodeTypeSpecificParameter (Maybe Bool)

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

cacheNodeTypeSpecificParameter_minimumEngineVersion :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

The earliest cache engine version to which the parameter can apply.

cacheNodeTypeSpecificParameter_parameterName :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

The name of the parameter.

cacheNodeTypeSpecificParameter_source :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

The source of the parameter value.

CacheNodeTypeSpecificValue

cacheNodeTypeSpecificValue_cacheNodeType :: Lens' CacheNodeTypeSpecificValue (Maybe Text)

The cache node type for which this value applies.

cacheNodeTypeSpecificValue_value :: Lens' CacheNodeTypeSpecificValue (Maybe Text)

The value for the cache node type.

CacheNodeUpdateStatus

cacheNodeUpdateStatus_cacheNodeId :: Lens' CacheNodeUpdateStatus (Maybe Text)

The node ID of the cache cluster

cacheNodeUpdateStatus_nodeDeletionDate :: Lens' CacheNodeUpdateStatus (Maybe UTCTime)

The deletion date of the node

cacheNodeUpdateStatus_nodeUpdateEndDate :: Lens' CacheNodeUpdateStatus (Maybe UTCTime)

The end date of the update for a node

cacheNodeUpdateStatus_nodeUpdateInitiatedBy :: Lens' CacheNodeUpdateStatus (Maybe NodeUpdateInitiatedBy)

Reflects whether the update was initiated by the customer or automatically applied

cacheNodeUpdateStatus_nodeUpdateInitiatedDate :: Lens' CacheNodeUpdateStatus (Maybe UTCTime)

The date when the update is triggered

cacheNodeUpdateStatus_nodeUpdateStartDate :: Lens' CacheNodeUpdateStatus (Maybe UTCTime)

The start date of the update for a node

cacheNodeUpdateStatus_nodeUpdateStatus :: Lens' CacheNodeUpdateStatus (Maybe NodeUpdateStatus)

The update status of the node

cacheNodeUpdateStatus_nodeUpdateStatusModifiedDate :: Lens' CacheNodeUpdateStatus (Maybe UTCTime)

The date when the NodeUpdateStatus was last modified>

CacheParameterGroup

cacheParameterGroup_arn :: Lens' CacheParameterGroup (Maybe Text)

The ARN (Amazon Resource Name) of the cache parameter group.

cacheParameterGroup_cacheParameterGroupFamily :: Lens' CacheParameterGroup (Maybe Text)

The name of the cache parameter group family that this cache parameter group is compatible with.

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

cacheParameterGroup_cacheParameterGroupName :: Lens' CacheParameterGroup (Maybe Text)

The name of the cache parameter group.

cacheParameterGroup_description :: Lens' CacheParameterGroup (Maybe Text)

The description for this cache parameter group.

cacheParameterGroup_isGlobal :: Lens' CacheParameterGroup (Maybe Bool)

Indicates whether the parameter group is associated with a Global datastore

CacheParameterGroupNameMessage

cacheParameterGroupNameMessage_cacheParameterGroupName :: Lens' CacheParameterGroupNameMessage (Maybe Text)

The name of the cache parameter group.

CacheParameterGroupStatus

cacheParameterGroupStatus_cacheNodeIdsToReboot :: Lens' CacheParameterGroupStatus (Maybe [Text])

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

cacheParameterGroupStatus_cacheParameterGroupName :: Lens' CacheParameterGroupStatus (Maybe Text)

The name of the cache parameter group.

cacheParameterGroupStatus_parameterApplyStatus :: Lens' CacheParameterGroupStatus (Maybe Text)

The status of parameter updates.

CacheSecurityGroup

cacheSecurityGroup_arn :: Lens' CacheSecurityGroup (Maybe Text)

The ARN of the cache security group,

cacheSecurityGroup_cacheSecurityGroupName :: Lens' CacheSecurityGroup (Maybe Text)

The name of the cache security group.

cacheSecurityGroup_description :: Lens' CacheSecurityGroup (Maybe Text)

The description of the cache security group.

cacheSecurityGroup_eC2SecurityGroups :: Lens' CacheSecurityGroup (Maybe [EC2SecurityGroup])

A list of Amazon EC2 security groups that are associated with this cache security group.

cacheSecurityGroup_ownerId :: Lens' CacheSecurityGroup (Maybe Text)

The Amazon account ID of the cache security group owner.

CacheSecurityGroupMembership

cacheSecurityGroupMembership_cacheSecurityGroupName :: Lens' CacheSecurityGroupMembership (Maybe Text)

The name of the cache security group.

cacheSecurityGroupMembership_status :: Lens' CacheSecurityGroupMembership (Maybe Text)

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.

CacheSubnetGroup

cacheSubnetGroup_arn :: Lens' CacheSubnetGroup (Maybe Text)

The ARN (Amazon Resource Name) of the cache subnet group.

cacheSubnetGroup_cacheSubnetGroupDescription :: Lens' CacheSubnetGroup (Maybe Text)

The description of the cache subnet group.

cacheSubnetGroup_cacheSubnetGroupName :: Lens' CacheSubnetGroup (Maybe Text)

The name of the cache subnet group.

cacheSubnetGroup_subnets :: Lens' CacheSubnetGroup (Maybe [Subnet])

A list of subnets associated with the cache subnet group.

cacheSubnetGroup_supportedNetworkTypes :: Lens' CacheSubnetGroup (Maybe [NetworkType])

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.

cacheSubnetGroup_vpcId :: Lens' CacheSubnetGroup (Maybe Text)

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

CloudWatchLogsDestinationDetails

cloudWatchLogsDestinationDetails_logGroup :: Lens' CloudWatchLogsDestinationDetails (Maybe Text)

The name of the CloudWatch Logs log group.

ConfigureShard

configureShard_preferredAvailabilityZones :: Lens' ConfigureShard (Maybe [Text])

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.

configureShard_preferredOutpostArns :: Lens' ConfigureShard (Maybe [Text])

The outpost ARNs in which the cache cluster is created.

configureShard_nodeGroupId :: Lens' ConfigureShard Text

The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

configureShard_newReplicaCount :: Lens' ConfigureShard Int

The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.

The minimum number of replicas in a shard or replication group is:

• Redis (cluster mode disabled)

  • If Multi-AZ: 1
  • If Multi-AZ: 0
• Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

CustomerNodeEndpoint

customerNodeEndpoint_address :: Lens' CustomerNodeEndpoint (Maybe Text)

The address of the node endpoint

customerNodeEndpoint_port :: Lens' CustomerNodeEndpoint (Maybe Int)

The port of the node endpoint

DestinationDetails

destinationDetails_cloudWatchLogsDetails :: Lens' DestinationDetails (Maybe CloudWatchLogsDestinationDetails)

The configuration details of the CloudWatch Logs destination.

destinationDetails_kinesisFirehoseDetails :: Lens' DestinationDetails (Maybe KinesisFirehoseDestinationDetails)

The configuration details of the Kinesis Data Firehose destination.

EC2SecurityGroup

eC2SecurityGroup_eC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text)

The name of the Amazon EC2 security group.

eC2SecurityGroup_eC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text)

The Amazon account ID of the Amazon EC2 security group owner.

eC2SecurityGroup_status :: Lens' EC2SecurityGroup (Maybe Text)

The status of the Amazon EC2 security group.

Endpoint

endpoint_address :: Lens' Endpoint (Maybe Text)

The DNS hostname of the cache node.

endpoint_port :: Lens' Endpoint (Maybe Int)

The port number that the cache engine is listening on.

EngineDefaults

engineDefaults_cacheNodeTypeSpecificParameters :: Lens' EngineDefaults (Maybe [CacheNodeTypeSpecificParameter])

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

engineDefaults_cacheParameterGroupFamily :: Lens' EngineDefaults (Maybe Text)

Specifies the name of the cache parameter group family to which the engine default parameters apply.

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.0 | redis6.x

engineDefaults_marker :: Lens' EngineDefaults (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

engineDefaults_parameters :: Lens' EngineDefaults (Maybe [Parameter])

Contains a list of engine default parameters.

Event

event_date :: Lens' Event (Maybe UTCTime)

The date and time when the event occurred.

event_message :: Lens' Event (Maybe Text)

The text of the event.

event_sourceIdentifier :: Lens' Event (Maybe Text)

The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.

event_sourceType :: Lens' Event (Maybe SourceType)

Specifies the origin of this event - a cluster, a parameter group, a security group, etc.

Filter

filter_name :: Lens' Filter Text

The property being filtered. For example, UserId.

filter_values :: Lens' Filter (NonEmpty Text)

The property values to filter on. For example, "user-123".

GlobalNodeGroup

globalNodeGroup_globalNodeGroupId :: Lens' GlobalNodeGroup (Maybe Text)

The name of the global node group

globalNodeGroup_slots :: Lens' GlobalNodeGroup (Maybe Text)

The keyspace for this node group

GlobalReplicationGroup

globalReplicationGroup_arn :: Lens' GlobalReplicationGroup (Maybe Text)

The ARN (Amazon Resource Name) of the global replication group.

globalReplicationGroup_atRestEncryptionEnabled :: Lens' GlobalReplicationGroup (Maybe Bool)

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

globalReplicationGroup_authTokenEnabled :: Lens' GlobalReplicationGroup (Maybe Bool)

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

globalReplicationGroup_cacheNodeType :: Lens' GlobalReplicationGroup (Maybe Text)

The cache node type of the Global datastore

globalReplicationGroup_clusterEnabled :: Lens' GlobalReplicationGroup (Maybe Bool)

A flag that indicates whether the Global datastore is cluster enabled.

globalReplicationGroup_engine :: Lens' GlobalReplicationGroup (Maybe Text)

The Elasticache engine. For Redis only.

globalReplicationGroup_engineVersion :: Lens' GlobalReplicationGroup (Maybe Text)

The Elasticache Redis engine version.

globalReplicationGroup_globalNodeGroups :: Lens' GlobalReplicationGroup (Maybe [GlobalNodeGroup])

Indicates the slot configuration and global identifier for each slice group.

globalReplicationGroup_globalReplicationGroupDescription :: Lens' GlobalReplicationGroup (Maybe Text)

The optional description of the Global datastore

globalReplicationGroup_globalReplicationGroupId :: Lens' GlobalReplicationGroup (Maybe Text)

The name of the Global datastore

globalReplicationGroup_members :: Lens' GlobalReplicationGroup (Maybe [GlobalReplicationGroupMember])

The replication groups that comprise the Global datastore.

globalReplicationGroup_status :: Lens' GlobalReplicationGroup (Maybe Text)

The status of the Global datastore

globalReplicationGroup_transitEncryptionEnabled :: Lens' GlobalReplicationGroup (Maybe Bool)

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.

GlobalReplicationGroupInfo

globalReplicationGroupInfo_globalReplicationGroupId :: Lens' GlobalReplicationGroupInfo (Maybe Text)

The name of the Global datastore

globalReplicationGroupInfo_globalReplicationGroupMemberRole :: Lens' GlobalReplicationGroupInfo (Maybe Text)

The role of the replication group in a Global datastore. Can be primary or secondary.

GlobalReplicationGroupMember

globalReplicationGroupMember_automaticFailover :: Lens' GlobalReplicationGroupMember (Maybe AutomaticFailoverStatus)

Indicates whether automatic failover is enabled for the replication group.

globalReplicationGroupMember_replicationGroupId :: Lens' GlobalReplicationGroupMember (Maybe Text)

The replication group id of the Global datastore member.

globalReplicationGroupMember_replicationGroupRegion :: Lens' GlobalReplicationGroupMember (Maybe Text)

The Amazon region of the Global datastore member.

globalReplicationGroupMember_role :: Lens' GlobalReplicationGroupMember (Maybe Text)

Indicates the role of the replication group, primary or secondary.

globalReplicationGroupMember_status :: Lens' GlobalReplicationGroupMember (Maybe Text)

The status of the membership of the replication group.

KinesisFirehoseDestinationDetails

kinesisFirehoseDestinationDetails_deliveryStream :: Lens' KinesisFirehoseDestinationDetails (Maybe Text)

The name of the Kinesis Data Firehose delivery stream.

LogDeliveryConfiguration

logDeliveryConfiguration_destinationDetails :: Lens' LogDeliveryConfiguration (Maybe DestinationDetails)

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

logDeliveryConfiguration_destinationType :: Lens' LogDeliveryConfiguration (Maybe DestinationType)

Returns the destination type, either cloudwatch-logs or kinesis-firehose.

logDeliveryConfiguration_logFormat :: Lens' LogDeliveryConfiguration (Maybe LogFormat)

Returns the log format, either JSON or TEXT.

logDeliveryConfiguration_logType :: Lens' LogDeliveryConfiguration (Maybe LogType)

Refers to slow-log or engine-log.

logDeliveryConfiguration_message :: Lens' LogDeliveryConfiguration (Maybe Text)

Returns an error message for the log delivery configuration.

logDeliveryConfiguration_status :: Lens' LogDeliveryConfiguration (Maybe LogDeliveryConfigurationStatus)

Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

LogDeliveryConfigurationRequest

logDeliveryConfigurationRequest_destinationDetails :: Lens' LogDeliveryConfigurationRequest (Maybe DestinationDetails)

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

logDeliveryConfigurationRequest_destinationType :: Lens' LogDeliveryConfigurationRequest (Maybe DestinationType)

Specify either cloudwatch-logs or kinesis-firehose as the destination type.

logDeliveryConfigurationRequest_enabled :: Lens' LogDeliveryConfigurationRequest (Maybe Bool)

Specify if log delivery is enabled. Default true.

logDeliveryConfigurationRequest_logFormat :: Lens' LogDeliveryConfigurationRequest (Maybe LogFormat)

Specifies either JSON or TEXT

logDeliveryConfigurationRequest_logType :: Lens' LogDeliveryConfigurationRequest (Maybe LogType)

Refers to slow-log or engine-log..

NodeGroup

nodeGroup_nodeGroupId :: Lens' NodeGroup (Maybe Text)

The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

nodeGroup_nodeGroupMembers :: Lens' NodeGroup (Maybe [NodeGroupMember])

A list containing information about individual nodes within the node group (shard).

nodeGroup_primaryEndpoint :: Lens' NodeGroup (Maybe Endpoint)

The endpoint of the primary node in this node group (shard).

nodeGroup_readerEndpoint :: Lens' NodeGroup (Maybe Endpoint)

The endpoint of the replica nodes in this node group (shard).

nodeGroup_slots :: Lens' NodeGroup (Maybe Text)

The keyspace for this node group (shard).

nodeGroup_status :: Lens' NodeGroup (Maybe Text)

The current state of this replication group - creating, available, modifying, deleting.

NodeGroupConfiguration

nodeGroupConfiguration_nodeGroupId :: Lens' NodeGroupConfiguration (Maybe Text)

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

nodeGroupConfiguration_primaryAvailabilityZone :: Lens' NodeGroupConfiguration (Maybe Text)

The Availability Zone where the primary node of this node group (shard) is launched.

nodeGroupConfiguration_primaryOutpostArn :: Lens' NodeGroupConfiguration (Maybe Text)

The outpost ARN of the primary node.

nodeGroupConfiguration_replicaAvailabilityZones :: Lens' NodeGroupConfiguration (Maybe [Text])

A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

nodeGroupConfiguration_replicaCount :: Lens' NodeGroupConfiguration (Maybe Int)

The number of read replica nodes in this node group (shard).

nodeGroupConfiguration_replicaOutpostArns :: Lens' NodeGroupConfiguration (Maybe [Text])

The outpost ARN of the node replicas.

nodeGroupConfiguration_slots :: Lens' NodeGroupConfiguration (Maybe Text)

A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

Example: "0-3999"

NodeGroupMember

nodeGroupMember_cacheClusterId :: Lens' NodeGroupMember (Maybe Text)

The ID of the cluster to which the node belongs.

nodeGroupMember_cacheNodeId :: Lens' NodeGroupMember (Maybe Text)

The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

nodeGroupMember_currentRole :: Lens' NodeGroupMember (Maybe Text)

The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

nodeGroupMember_preferredAvailabilityZone :: Lens' NodeGroupMember (Maybe Text)

The name of the Availability Zone in which the node is located.

nodeGroupMember_preferredOutpostArn :: Lens' NodeGroupMember (Maybe Text)

The outpost ARN of the node group member.

nodeGroupMember_readEndpoint :: Lens' NodeGroupMember (Maybe Endpoint)

The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

NodeGroupMemberUpdateStatus

nodeGroupMemberUpdateStatus_cacheClusterId :: Lens' NodeGroupMemberUpdateStatus (Maybe Text)

The cache cluster ID

nodeGroupMemberUpdateStatus_cacheNodeId :: Lens' NodeGroupMemberUpdateStatus (Maybe Text)

The node ID of the cache cluster

nodeGroupMemberUpdateStatus_nodeDeletionDate :: Lens' NodeGroupMemberUpdateStatus (Maybe UTCTime)

The deletion date of the node

nodeGroupMemberUpdateStatus_nodeUpdateEndDate :: Lens' NodeGroupMemberUpdateStatus (Maybe UTCTime)

The end date of the update for a node

nodeGroupMemberUpdateStatus_nodeUpdateInitiatedBy :: Lens' NodeGroupMemberUpdateStatus (Maybe NodeUpdateInitiatedBy)

Reflects whether the update was initiated by the customer or automatically applied

nodeGroupMemberUpdateStatus_nodeUpdateInitiatedDate :: Lens' NodeGroupMemberUpdateStatus (Maybe UTCTime)

The date when the update is triggered

nodeGroupMemberUpdateStatus_nodeUpdateStartDate :: Lens' NodeGroupMemberUpdateStatus (Maybe UTCTime)

The start date of the update for a node

nodeGroupMemberUpdateStatus_nodeUpdateStatus :: Lens' NodeGroupMemberUpdateStatus (Maybe NodeUpdateStatus)

The update status of the node

nodeGroupMemberUpdateStatus_nodeUpdateStatusModifiedDate :: Lens' NodeGroupMemberUpdateStatus (Maybe UTCTime)

The date when the NodeUpdateStatus was last modified

NodeGroupUpdateStatus

nodeGroupUpdateStatus_nodeGroupId :: Lens' NodeGroupUpdateStatus (Maybe Text)

The ID of the node group

nodeGroupUpdateStatus_nodeGroupMemberUpdateStatus :: Lens' NodeGroupUpdateStatus (Maybe [NodeGroupMemberUpdateStatus])

The status of the service update on the node group member

NodeSnapshot

nodeSnapshot_cacheClusterId :: Lens' NodeSnapshot (Maybe Text)

A unique identifier for the source cluster.

nodeSnapshot_cacheNodeCreateTime :: Lens' NodeSnapshot (Maybe UTCTime)

The date and time when the cache node was created in the source cluster.

nodeSnapshot_cacheNodeId :: Lens' NodeSnapshot (Maybe Text)

The cache node identifier for the node in the source cluster.

nodeSnapshot_cacheSize :: Lens' NodeSnapshot (Maybe Text)

The size of the cache on the source cache node.

nodeSnapshot_nodeGroupConfiguration :: Lens' NodeSnapshot (Maybe NodeGroupConfiguration)

The configuration for the source node group (shard).

nodeSnapshot_nodeGroupId :: Lens' NodeSnapshot (Maybe Text)

A unique identifier for the source node group (shard).

nodeSnapshot_snapshotCreateTime :: Lens' NodeSnapshot (Maybe UTCTime)

The date and time when the source node's metadata and cache data set was obtained for the snapshot.

NotificationConfiguration

notificationConfiguration_topicArn :: Lens' NotificationConfiguration (Maybe Text)

The Amazon Resource Name (ARN) that identifies the topic.

notificationConfiguration_topicStatus :: Lens' NotificationConfiguration (Maybe Text)

The current state of the topic.

Parameter

parameter_allowedValues :: Lens' Parameter (Maybe Text)

The valid range of values for the parameter.

parameter_changeType :: Lens' Parameter (Maybe ChangeType)

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

parameter_dataType :: Lens' Parameter (Maybe Text)

The valid data type for the parameter.

parameter_description :: Lens' Parameter (Maybe Text)

A description of the parameter.

parameter_isModifiable :: Lens' Parameter (Maybe Bool)

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text)

The earliest cache engine version to which the parameter can apply.

parameter_parameterName :: Lens' Parameter (Maybe Text)

The name of the parameter.

parameter_parameterValue :: Lens' Parameter (Maybe Text)

The value of the parameter.

parameter_source :: Lens' Parameter (Maybe Text)

The source of the parameter.

ParameterNameValue

parameterNameValue_parameterName :: Lens' ParameterNameValue (Maybe Text)

The name of the parameter.

parameterNameValue_parameterValue :: Lens' ParameterNameValue (Maybe Text)

The value of the parameter.

PendingLogDeliveryConfiguration

pendingLogDeliveryConfiguration_destinationDetails :: Lens' PendingLogDeliveryConfiguration (Maybe DestinationDetails)

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

pendingLogDeliveryConfiguration_destinationType :: Lens' PendingLogDeliveryConfiguration (Maybe DestinationType)

Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

pendingLogDeliveryConfiguration_logFormat :: Lens' PendingLogDeliveryConfiguration (Maybe LogFormat)

Returns the log format, either JSON or TEXT

pendingLogDeliveryConfiguration_logType :: Lens' PendingLogDeliveryConfiguration (Maybe LogType)

Refers to slow-log or engine-log..

PendingModifiedValues

pendingModifiedValues_authTokenStatus :: Lens' PendingModifiedValues (Maybe AuthTokenUpdateStatus)

The auth token status

pendingModifiedValues_cacheNodeIdsToRemove :: Lens' PendingModifiedValues (Maybe [Text])

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

pendingModifiedValues_cacheNodeType :: Lens' PendingModifiedValues (Maybe Text)

The cache node type that this cluster or replication group is scaled to.

pendingModifiedValues_engineVersion :: Lens' PendingModifiedValues (Maybe Text)

The new cache engine version that the cluster runs.

pendingModifiedValues_logDeliveryConfigurations :: Lens' PendingModifiedValues (Maybe [PendingLogDeliveryConfiguration])

The log delivery configurations being modified

pendingModifiedValues_numCacheNodes :: Lens' PendingModifiedValues (Maybe Int)

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.

pendingModifiedValues_transitEncryptionEnabled :: Lens' PendingModifiedValues (Maybe Bool)

A flag that enables in-transit encryption when set to true.

pendingModifiedValues_transitEncryptionMode :: Lens' PendingModifiedValues (Maybe TransitEncryptionMode)

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

ProcessedUpdateAction

processedUpdateAction_cacheClusterId :: Lens' ProcessedUpdateAction (Maybe Text)

The ID of the cache cluster

processedUpdateAction_replicationGroupId :: Lens' ProcessedUpdateAction (Maybe Text)

The ID of the replication group

processedUpdateAction_serviceUpdateName :: Lens' ProcessedUpdateAction (Maybe Text)

The unique ID of the service update

processedUpdateAction_updateActionStatus :: Lens' ProcessedUpdateAction (Maybe UpdateActionStatus)

The status of the update action on the Redis cluster

RecurringCharge

recurringCharge_recurringChargeAmount :: Lens' RecurringCharge (Maybe Double)

The monetary amount of the recurring charge.

recurringCharge_recurringChargeFrequency :: Lens' RecurringCharge (Maybe Text)

The frequency of the recurring charge.

RegionalConfiguration

regionalConfiguration_replicationGroupId :: Lens' RegionalConfiguration Text

The name of the secondary cluster

regionalConfiguration_replicationGroupRegion :: Lens' RegionalConfiguration Text

The Amazon region where the cluster is stored

regionalConfiguration_reshardingConfiguration :: Lens' RegionalConfiguration [ReshardingConfiguration]

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

ReplicationGroup

replicationGroup_arn :: Lens' ReplicationGroup (Maybe Text)

The ARN (Amazon Resource Name) of the replication group.

replicationGroup_atRestEncryptionEnabled :: Lens' ReplicationGroup (Maybe Bool)

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 encryption at-rest 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

replicationGroup_authTokenEnabled :: Lens' ReplicationGroup (Maybe Bool)

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

replicationGroup_authTokenLastModifiedDate :: Lens' ReplicationGroup (Maybe UTCTime)

The date the auth token was last modified

replicationGroup_autoMinorVersionUpgrade :: Lens' ReplicationGroup (Maybe 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.

replicationGroup_automaticFailover :: Lens' ReplicationGroup (Maybe AutomaticFailoverStatus)

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

replicationGroup_cacheNodeType :: Lens' ReplicationGroup (Maybe Text)

The name of the compute and memory capacity node type for each node in the replication group.

replicationGroup_clusterEnabled :: Lens' ReplicationGroup (Maybe Bool)

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

replicationGroup_configurationEndpoint :: Lens' ReplicationGroup (Maybe Endpoint)

The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

replicationGroup_dataTiering :: Lens' ReplicationGroup (Maybe DataTieringStatus)

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.

replicationGroup_description :: Lens' ReplicationGroup (Maybe Text)

The user supplied description of the replication group.

replicationGroup_globalReplicationGroupInfo :: Lens' ReplicationGroup (Maybe GlobalReplicationGroupInfo)

The name of the Global datastore and role of this replication group in the Global datastore.

replicationGroup_ipDiscovery :: Lens' ReplicationGroup (Maybe IpDiscovery)

The network type you choose when modifying a 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.

replicationGroup_kmsKeyId :: Lens' ReplicationGroup (Maybe Text)

The ID of the KMS key used to encrypt the disk in the cluster.

replicationGroup_logDeliveryConfigurations :: Lens' ReplicationGroup (Maybe [LogDeliveryConfiguration])

Returns the destination, format and type of the logs.

replicationGroup_memberClusters :: Lens' ReplicationGroup (Maybe [Text])

The names of all the cache clusters that are part of this replication group.

replicationGroup_memberClustersOutpostArns :: Lens' ReplicationGroup (Maybe [Text])

The outpost ARNs of the replication group's member clusters.

replicationGroup_multiAZ :: Lens' ReplicationGroup (Maybe MultiAZStatus)

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

replicationGroup_networkType :: Lens' ReplicationGroup (Maybe NetworkType)

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.

replicationGroup_nodeGroups :: Lens' ReplicationGroup (Maybe [NodeGroup])

A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

replicationGroup_pendingModifiedValues :: Lens' ReplicationGroup (Maybe ReplicationGroupPendingModifiedValues)

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

replicationGroup_replicationGroupCreateTime :: Lens' ReplicationGroup (Maybe UTCTime)

The date and time when the cluster was created.

replicationGroup_replicationGroupId :: Lens' ReplicationGroup (Maybe Text)

The identifier for the replication group.

replicationGroup_snapshotRetentionLimit :: Lens' ReplicationGroup (Maybe Int)

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.

replicationGroup_snapshotWindow :: Lens' ReplicationGroup (Maybe Text)

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.

replicationGroup_snapshottingClusterId :: Lens' ReplicationGroup (Maybe Text)

The cluster ID that is used as the daily snapshot source for the replication group.

replicationGroup_status :: Lens' ReplicationGroup (Maybe Text)

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

replicationGroup_transitEncryptionEnabled :: Lens' ReplicationGroup (Maybe Bool)

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

replicationGroup_transitEncryptionMode :: Lens' ReplicationGroup (Maybe TransitEncryptionMode)

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

replicationGroup_userGroupIds :: Lens' ReplicationGroup (Maybe [Text])

The ID of the user group associated to the replication group.

ReplicationGroupPendingModifiedValues

replicationGroupPendingModifiedValues_authTokenStatus :: Lens' ReplicationGroupPendingModifiedValues (Maybe AuthTokenUpdateStatus)

The auth token status

replicationGroupPendingModifiedValues_automaticFailoverStatus :: Lens' ReplicationGroupPendingModifiedValues (Maybe PendingAutomaticFailoverStatus)

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

replicationGroupPendingModifiedValues_logDeliveryConfigurations :: Lens' ReplicationGroupPendingModifiedValues (Maybe [PendingLogDeliveryConfiguration])

The log delivery configurations being modified

replicationGroupPendingModifiedValues_primaryClusterId :: Lens' ReplicationGroupPendingModifiedValues (Maybe Text)

The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

replicationGroupPendingModifiedValues_resharding :: Lens' ReplicationGroupPendingModifiedValues (Maybe ReshardingStatus)

The status of an online resharding operation.

replicationGroupPendingModifiedValues_transitEncryptionEnabled :: Lens' ReplicationGroupPendingModifiedValues (Maybe Bool)

A flag that enables in-transit encryption when set to true.

replicationGroupPendingModifiedValues_transitEncryptionMode :: Lens' ReplicationGroupPendingModifiedValues (Maybe TransitEncryptionMode)

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

replicationGroupPendingModifiedValues_userGroups :: Lens' ReplicationGroupPendingModifiedValues (Maybe UserGroupsUpdateStatus)

The user group being modified.

ReservedCacheNode

reservedCacheNode_cacheNodeCount :: Lens' ReservedCacheNode (Maybe Int)

The number of cache nodes that have been reserved.

reservedCacheNode_cacheNodeType :: Lens' ReservedCacheNode (Maybe Text)

The cache node type for the reserved cache nodes.

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.

reservedCacheNode_duration :: Lens' ReservedCacheNode (Maybe Int)

The duration of the reservation in seconds.

reservedCacheNode_fixedPrice :: Lens' ReservedCacheNode (Maybe Double)

The fixed price charged for this reserved cache node.

reservedCacheNode_offeringType :: Lens' ReservedCacheNode (Maybe Text)

The offering type of this reserved cache node.

reservedCacheNode_productDescription :: Lens' ReservedCacheNode (Maybe Text)

The description of the reserved cache node.

reservedCacheNode_recurringCharges :: Lens' ReservedCacheNode (Maybe [RecurringCharge])

The recurring price charged to run this reserved cache node.

reservedCacheNode_reservationARN :: Lens' ReservedCacheNode (Maybe Text)

The Amazon Resource Name (ARN) of the reserved cache node.

Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582

reservedCacheNode_reservedCacheNodeId :: Lens' ReservedCacheNode (Maybe Text)

The unique identifier for the reservation.

reservedCacheNode_reservedCacheNodesOfferingId :: Lens' ReservedCacheNode (Maybe Text)

The offering identifier.

reservedCacheNode_startTime :: Lens' ReservedCacheNode (Maybe UTCTime)

The time the reservation started.

reservedCacheNode_state :: Lens' ReservedCacheNode (Maybe Text)

The state of the reserved cache node.

reservedCacheNode_usagePrice :: Lens' ReservedCacheNode (Maybe Double)

The hourly price charged for this reserved cache node.

ReservedCacheNodesOffering

reservedCacheNodesOffering_cacheNodeType :: Lens' ReservedCacheNodesOffering (Maybe Text)

The cache node type for the reserved cache node.

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.

reservedCacheNodesOffering_duration :: Lens' ReservedCacheNodesOffering (Maybe Int)

The duration of the offering. in seconds.

reservedCacheNodesOffering_fixedPrice :: Lens' ReservedCacheNodesOffering (Maybe Double)

The fixed price charged for this offering.

reservedCacheNodesOffering_offeringType :: Lens' ReservedCacheNodesOffering (Maybe Text)

The offering type.

reservedCacheNodesOffering_productDescription :: Lens' ReservedCacheNodesOffering (Maybe Text)

The cache engine used by the offering.

reservedCacheNodesOffering_recurringCharges :: Lens' ReservedCacheNodesOffering (Maybe [RecurringCharge])

The recurring price charged to run this reserved cache node.

reservedCacheNodesOffering_reservedCacheNodesOfferingId :: Lens' ReservedCacheNodesOffering (Maybe Text)

A unique identifier for the reserved cache node offering.

reservedCacheNodesOffering_usagePrice :: Lens' ReservedCacheNodesOffering (Maybe Double)

The hourly price charged for this offering.

ReshardingConfiguration

reshardingConfiguration_nodeGroupId :: Lens' ReshardingConfiguration (Maybe Text)

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

reshardingConfiguration_preferredAvailabilityZones :: Lens' ReshardingConfiguration (Maybe [Text])

A list of preferred availability zones for the nodes in this cluster.

ReshardingStatus

reshardingStatus_slotMigration :: Lens' ReshardingStatus (Maybe SlotMigration)

Represents the progress of an online resharding operation.

SecurityGroupMembership

securityGroupMembership_securityGroupId :: Lens' SecurityGroupMembership (Maybe Text)

The identifier of the cache security group.

securityGroupMembership_status :: Lens' SecurityGroupMembership (Maybe Text)

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.

ServiceUpdate

serviceUpdate_autoUpdateAfterRecommendedApplyByDate :: Lens' ServiceUpdate (Maybe Bool)

Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.

serviceUpdate_engine :: Lens' ServiceUpdate (Maybe Text)

The Elasticache engine to which the update applies. Either Redis or Memcached

serviceUpdate_engineVersion :: Lens' ServiceUpdate (Maybe Text)

The Elasticache engine version to which the update applies. Either Redis or Memcached engine version

serviceUpdate_estimatedUpdateTime :: Lens' ServiceUpdate (Maybe Text)

The estimated length of time the service update will take

serviceUpdate_serviceUpdateDescription :: Lens' ServiceUpdate (Maybe Text)

Provides details of the service update

serviceUpdate_serviceUpdateEndDate :: Lens' ServiceUpdate (Maybe UTCTime)

The date after which the service update is no longer available

serviceUpdate_serviceUpdateName :: Lens' ServiceUpdate (Maybe Text)

The unique ID of the service update

serviceUpdate_serviceUpdateRecommendedApplyByDate :: Lens' ServiceUpdate (Maybe UTCTime)

The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

serviceUpdate_serviceUpdateReleaseDate :: Lens' ServiceUpdate (Maybe UTCTime)

The date when the service update is initially available

serviceUpdate_serviceUpdateSeverity :: Lens' ServiceUpdate (Maybe ServiceUpdateSeverity)

The severity of the service update

serviceUpdate_serviceUpdateStatus :: Lens' ServiceUpdate (Maybe ServiceUpdateStatus)

The status of the service update

serviceUpdate_serviceUpdateType :: Lens' ServiceUpdate (Maybe ServiceUpdateType)

Reflects the nature of the service update

SlotMigration

slotMigration_progressPercentage :: Lens' SlotMigration (Maybe Double)

The percentage of the slot migration that is complete.

Snapshot

snapshot_arn :: Lens' Snapshot (Maybe Text)

The ARN (Amazon Resource Name) of the snapshot.

snapshot_autoMinorVersionUpgrade :: Lens' Snapshot (Maybe 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_automaticFailover :: Lens' Snapshot (Maybe AutomaticFailoverStatus)

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

snapshot_cacheClusterCreateTime :: Lens' Snapshot (Maybe UTCTime)

The date and time when the source cluster was created.

snapshot_cacheClusterId :: Lens' Snapshot (Maybe Text)

The user-supplied identifier of the source cluster.

snapshot_cacheNodeType :: Lens' Snapshot (Maybe Text)

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.

snapshot_cacheParameterGroupName :: Lens' Snapshot (Maybe Text)

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

snapshot_cacheSubnetGroupName :: Lens' Snapshot (Maybe Text)

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

snapshot_dataTiering :: Lens' Snapshot (Maybe DataTieringStatus)

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.

snapshot_engine :: Lens' Snapshot (Maybe Text)

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

snapshot_engineVersion :: Lens' Snapshot (Maybe Text)

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

snapshot_kmsKeyId :: Lens' Snapshot (Maybe Text)

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

snapshot_nodeSnapshots :: Lens' Snapshot (Maybe [NodeSnapshot])

A list of the cache nodes in the source cluster.

snapshot_numCacheNodes :: Lens' Snapshot (Maybe Int)

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.

snapshot_numNodeGroups :: Lens' Snapshot (Maybe Int)

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.

snapshot_port :: Lens' Snapshot (Maybe Int)

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

snapshot_preferredAvailabilityZone :: Lens' Snapshot (Maybe Text)

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

snapshot_preferredMaintenanceWindow :: Lens' Snapshot (Maybe Text)

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

snapshot_preferredOutpostArn :: Lens' Snapshot (Maybe Text)

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

snapshot_replicationGroupDescription :: Lens' Snapshot (Maybe Text)

A description of the source replication group.

snapshot_replicationGroupId :: Lens' Snapshot (Maybe Text)

The unique identifier of the source replication group.

snapshot_snapshotName :: Lens' Snapshot (Maybe Text)

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

snapshot_snapshotRetentionLimit :: Lens' Snapshot (Maybe Int)

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.

snapshot_snapshotSource :: Lens' Snapshot (Maybe Text)

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

snapshot_snapshotStatus :: Lens' Snapshot (Maybe Text)

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

snapshot_snapshotWindow :: Lens' Snapshot (Maybe Text)

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

snapshot_topicArn :: Lens' Snapshot (Maybe Text)

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

snapshot_vpcId :: Lens' Snapshot (Maybe Text)

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

Subnet

subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone)

The Availability Zone associated with the subnet.

subnet_subnetIdentifier :: Lens' Subnet (Maybe Text)

The unique identifier for the subnet.

subnet_subnetOutpost :: Lens' Subnet (Maybe SubnetOutpost)

The outpost ARN of the subnet.

subnet_supportedNetworkTypes :: Lens' Subnet (Maybe [NetworkType])

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.

SubnetOutpost

subnetOutpost_subnetOutpostArn :: Lens' SubnetOutpost (Maybe Text)

The outpost ARN of the subnet.

Tag

tag_key :: Lens' Tag (Maybe Text)

The key for the tag. May not be null.

tag_value :: Lens' Tag (Maybe Text)

The tag's value. May be null.

TagListMessage

tagListMessage_tagList :: Lens' TagListMessage (Maybe [Tag])

A list of tags as key-value pairs.

TimeRangeFilter

timeRangeFilter_endTime :: Lens' TimeRangeFilter (Maybe UTCTime)

The end time of the time range filter

timeRangeFilter_startTime :: Lens' TimeRangeFilter (Maybe UTCTime)

The start time of the time range filter

UnprocessedUpdateAction

unprocessedUpdateAction_cacheClusterId :: Lens' UnprocessedUpdateAction (Maybe Text)

The ID of the cache cluster

unprocessedUpdateAction_errorMessage :: Lens' UnprocessedUpdateAction (Maybe Text)

The error message that describes the reason the request was not processed

unprocessedUpdateAction_errorType :: Lens' UnprocessedUpdateAction (Maybe Text)

The error type for requests that are not processed

unprocessedUpdateAction_replicationGroupId :: Lens' UnprocessedUpdateAction (Maybe Text)

The replication group ID

unprocessedUpdateAction_serviceUpdateName :: Lens' UnprocessedUpdateAction (Maybe Text)

The unique ID of the service update

UpdateAction

updateAction_cacheClusterId :: Lens' UpdateAction (Maybe Text)

The ID of the cache cluster

updateAction_cacheNodeUpdateStatus :: Lens' UpdateAction (Maybe [CacheNodeUpdateStatus])

The status of the service update on the cache node

updateAction_engine :: Lens' UpdateAction (Maybe Text)

The Elasticache engine to which the update applies. Either Redis or Memcached

updateAction_estimatedUpdateTime :: Lens' UpdateAction (Maybe Text)

The estimated length of time for the update to complete

updateAction_nodeGroupUpdateStatus :: Lens' UpdateAction (Maybe [NodeGroupUpdateStatus])

The status of the service update on the node group

updateAction_nodesUpdated :: Lens' UpdateAction (Maybe Text)

The progress of the service update on the replication group

updateAction_replicationGroupId :: Lens' UpdateAction (Maybe Text)

The ID of the replication group

updateAction_serviceUpdateName :: Lens' UpdateAction (Maybe Text)

The unique ID of the service update

updateAction_serviceUpdateRecommendedApplyByDate :: Lens' UpdateAction (Maybe UTCTime)

The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

updateAction_serviceUpdateReleaseDate :: Lens' UpdateAction (Maybe UTCTime)

The date the update is first available

updateAction_serviceUpdateSeverity :: Lens' UpdateAction (Maybe ServiceUpdateSeverity)

The severity of the service update

updateAction_serviceUpdateStatus :: Lens' UpdateAction (Maybe ServiceUpdateStatus)

The status of the service update

updateAction_serviceUpdateType :: Lens' UpdateAction (Maybe ServiceUpdateType)

Reflects the nature of the service update

updateAction_slaMet :: Lens' UpdateAction (Maybe SlaMet)

If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.

updateAction_updateActionAvailableDate :: Lens' UpdateAction (Maybe UTCTime)

The date that the service update is available to a replication group

updateAction_updateActionStatus :: Lens' UpdateAction (Maybe UpdateActionStatus)

The status of the update action

updateAction_updateActionStatusModifiedDate :: Lens' UpdateAction (Maybe UTCTime)

The date when the UpdateActionStatus was last modified

UpdateActionResultsMessage

updateActionResultsMessage_processedUpdateActions :: Lens' UpdateActionResultsMessage (Maybe [ProcessedUpdateAction])

Update actions that have been processed successfully

updateActionResultsMessage_unprocessedUpdateActions :: Lens' UpdateActionResultsMessage (Maybe [UnprocessedUpdateAction])

Update actions that haven't been processed successfully

User

user_arn :: Lens' User (Maybe Text)

The Amazon Resource Name (ARN) of the user.

user_accessString :: Lens' User (Maybe Text)

Access permissions string used for this user.

user_authentication :: Lens' User (Maybe Authentication)

Denotes whether the user requires a password to authenticate.

user_engine :: Lens' User (Maybe Text)

The current supported value is Redis.

user_minimumEngineVersion :: Lens' User (Maybe Text)

The minimum engine version required, which is Redis 6.0

user_status :: Lens' User (Maybe Text)

Indicates the user status. Can be "active", "modifying" or "deleting".

user_userGroupIds :: Lens' User (Maybe [Text])

Returns a list of the user group IDs the user belongs to.

user_userId :: Lens' User (Maybe Text)

The ID of the user.

user_userName :: Lens' User (Maybe Text)

The username of the user.

UserGroup

userGroup_arn :: Lens' UserGroup (Maybe Text)

The Amazon Resource Name (ARN) of the user group.

userGroup_engine :: Lens' UserGroup (Maybe Text)

The current supported value is Redis.

userGroup_minimumEngineVersion :: Lens' UserGroup (Maybe Text)

The minimum engine version required, which is Redis 6.0

userGroup_pendingChanges :: Lens' UserGroup (Maybe UserGroupPendingChanges)

A list of updates being applied to the user group.

userGroup_replicationGroups :: Lens' UserGroup (Maybe [Text])

A list of replication groups that the user group can access.

userGroup_status :: Lens' UserGroup (Maybe Text)

Indicates user group status. Can be "creating", "active", "modifying", "deleting".

userGroup_userGroupId :: Lens' UserGroup (Maybe Text)

The ID of the user group.

userGroup_userIds :: Lens' UserGroup (Maybe [Text])

The list of user IDs that belong to the user group.

UserGroupPendingChanges

userGroupPendingChanges_userIdsToAdd :: Lens' UserGroupPendingChanges (Maybe [Text])

The list of user IDs to add.

userGroupPendingChanges_userIdsToRemove :: Lens' UserGroupPendingChanges (Maybe [Text])

The list of user IDs to remove.

UserGroupsUpdateStatus

userGroupsUpdateStatus_userGroupIdsToAdd :: Lens' UserGroupsUpdateStatus (Maybe [Text])

The ID of the user group to add.

userGroupsUpdateStatus_userGroupIdsToRemove :: Lens' UserGroupsUpdateStatus (Maybe [Text])

The ID of the user group to remove.