amazonka-elasticache-1.6.1: Amazon ElastiCache SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElastiCache.CreateReplicationGroup

Contents

Description

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide .

Synopsis

Creating a Request

createReplicationGroup Source #

Creates a value of CreateReplicationGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • crgAutomaticFailoverEnabled - Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. If true , Multi-AZ is enabled for this replication group. If false , Multi-AZ is disabled for this replication group. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups. Default: false Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: * Redis versions earlier than 2.8.6. * Redis (cluster mode disabled): T1 and T2 cache node types. * Redis (cluster mode enabled): T1 node types.
  • crgEngineVersion - 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.
  • crgCacheNodeType - 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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge * Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , cache.m1.large , cache.m1.xlarge * Compute optimized: * Previous generation: (not recommended) C1 node types: cache.c1.xlarge * Memory optimized: * Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge * Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge Notes: * All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). * Redis (cluster mode disabled): Redis backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore is not supported on T1 instances. * Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis .
  • crgNodeGroupConfiguration - A list of node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount. 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.
  • crgAtRestEncryptionEnabled - 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. Default: false
  • crgSecurityGroupIds - 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).
  • crgSnapshotARNs - 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
  • crgAutoMinorVersionUpgrade - This parameter is currently disabled.
  • crgCacheParameterGroupName - 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 .
  • crgTransitEncryptionEnabled - A flag that enables in-transit encryption when set to true . You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. This parameter is valid only if the Engine parameter is redis , the EngineVersion parameter is 3.2.4 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 . Default: false
  • crgSnapshotWindow - 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.
  • crgAuthToken - Reserved parameter. The password used to access a password protected server. This parameter is valid only if: * The parameter TransitEncryptionEnabled was set to true when the cluster was created. * The line requirepass was added to the database configuration file. 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 http://redis.io/commands/AUTH.
  • crgPrimaryClusterId - 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.
  • crgEngine - The name of the cache engine to be used for the clusters in this replication group.
  • crgPreferredMaintenanceWindow - 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
  • crgCacheSubnetGroupName - The name of the cache subnet group to be used for the replication group. Important: 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 .
  • crgNumNodeGroups - 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
  • crgSnapshotRetentionLimit - 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).
  • crgReplicasPerNodeGroup - An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
  • crgNumCacheClusters - 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 (primary plus 5 replicas).
  • crgPreferredCacheClusterAZs - 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. Default: system chosen Availability Zones.
  • crgSnapshotName - 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.
  • crgNotificationTopicARN - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
  • crgTags - A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key does not have to be accompanied by a tag value.
  • crgPort - The port number on which each member of the replication group accepts connections.
  • crgCacheSecurityGroupNames - A list of cache security group names to associate with this replication group.
  • crgReplicationGroupId - The replication group identifier. This parameter is stored as a lowercase string. Constraints: * A name must contain from 1 to 20 alphanumeric characters or hyphens. * The first character must be a letter. * A name cannot end with a hyphen or contain two consecutive hyphens.
  • crgReplicationGroupDescription - A user-created description for the replication group.

data CreateReplicationGroup Source #

Represents the input of a CreateReplicationGroup operation.

See: createReplicationGroup smart constructor.

Instances
Eq CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Data CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateReplicationGroup -> c CreateReplicationGroup #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateReplicationGroup #

toConstr :: CreateReplicationGroup -> Constr #

dataTypeOf :: CreateReplicationGroup -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateReplicationGroup) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateReplicationGroup) #

gmapT :: (forall b. Data b => b -> b) -> CreateReplicationGroup -> CreateReplicationGroup #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateReplicationGroup -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateReplicationGroup -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateReplicationGroup -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateReplicationGroup -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateReplicationGroup -> m CreateReplicationGroup #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateReplicationGroup -> m CreateReplicationGroup #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateReplicationGroup -> m CreateReplicationGroup #

Read CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Show CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Generic CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Associated Types

type Rep CreateReplicationGroup :: Type -> Type #

Hashable CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

AWSRequest CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Associated Types

type Rs CreateReplicationGroup :: Type #

ToHeaders CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

ToPath CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

ToQuery CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

NFData CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Methods

rnf :: CreateReplicationGroup -> () #

type Rep CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

type Rep CreateReplicationGroup = D1 (MetaData "CreateReplicationGroup" "Network.AWS.ElastiCache.CreateReplicationGroup" "amazonka-elasticache-1.6.1-7qPjCRJV7Sp8jKm0QWBmxX" False) (C1 (MetaCons "CreateReplicationGroup'" PrefixI True) ((((S1 (MetaSel (Just "_crgAutomaticFailoverEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_crgEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_crgCacheNodeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_crgNodeGroupConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [NodeGroupConfiguration])) :*: S1 (MetaSel (Just "_crgAtRestEncryptionEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_crgSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_crgSnapshotARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 (MetaSel (Just "_crgAutoMinorVersionUpgrade") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_crgCacheParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_crgTransitEncryptionEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 (MetaSel (Just "_crgSnapshotWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_crgAuthToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_crgPrimaryClusterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_crgEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 (MetaSel (Just "_crgPreferredMaintenanceWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_crgCacheSubnetGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_crgNumNodeGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 (MetaSel (Just "_crgSnapshotRetentionLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_crgReplicasPerNodeGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 (MetaSel (Just "_crgNumCacheClusters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_crgPreferredCacheClusterAZs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 (MetaSel (Just "_crgSnapshotName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_crgNotificationTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_crgTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 (MetaSel (Just "_crgPort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_crgCacheSecurityGroupNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_crgReplicationGroupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_crgReplicationGroupDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))
type Rs CreateReplicationGroup Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Request Lenses

crgAutomaticFailoverEnabled :: Lens' CreateReplicationGroup (Maybe Bool) Source #

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. If true , Multi-AZ is enabled for this replication group. If false , Multi-AZ is disabled for this replication group. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups. Default: false Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: * Redis versions earlier than 2.8.6. * Redis (cluster mode disabled): T1 and T2 cache node types. * Redis (cluster mode enabled): T1 node types.

crgEngineVersion :: Lens' CreateReplicationGroup (Maybe Text) Source #

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.

crgCacheNodeType :: Lens' CreateReplicationGroup (Maybe Text) Source #

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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge * Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , cache.m1.large , cache.m1.xlarge * Compute optimized: * Previous generation: (not recommended) C1 node types: cache.c1.xlarge * Memory optimized: * Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge * Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge Notes: * All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). * Redis (cluster mode disabled): Redis backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore is not supported on T1 instances. * Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis .

crgNodeGroupConfiguration :: Lens' CreateReplicationGroup [NodeGroupConfiguration] Source #

A list of node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount. 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.

crgAtRestEncryptionEnabled :: Lens' CreateReplicationGroup (Maybe Bool) Source #

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. Default: false

crgSecurityGroupIds :: Lens' CreateReplicationGroup [Text] Source #

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

crgSnapshotARNs :: Lens' CreateReplicationGroup [Text] Source #

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

crgAutoMinorVersionUpgrade :: Lens' CreateReplicationGroup (Maybe Bool) Source #

This parameter is currently disabled.

crgCacheParameterGroupName :: Lens' CreateReplicationGroup (Maybe Text) Source #

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 .

crgTransitEncryptionEnabled :: Lens' CreateReplicationGroup (Maybe Bool) Source #

A flag that enables in-transit encryption when set to true . You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. This parameter is valid only if the Engine parameter is redis , the EngineVersion parameter is 3.2.4 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 . Default: false

crgSnapshotWindow :: Lens' CreateReplicationGroup (Maybe Text) Source #

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.

crgAuthToken :: Lens' CreateReplicationGroup (Maybe Text) Source #

Reserved parameter. The password used to access a password protected server. This parameter is valid only if: * The parameter TransitEncryptionEnabled was set to true when the cluster was created. * The line requirepass was added to the database configuration file. 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 http://redis.io/commands/AUTH.

crgPrimaryClusterId :: Lens' CreateReplicationGroup (Maybe Text) Source #

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.

crgEngine :: Lens' CreateReplicationGroup (Maybe Text) Source #

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

crgPreferredMaintenanceWindow :: Lens' CreateReplicationGroup (Maybe Text) Source #

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

crgCacheSubnetGroupName :: Lens' CreateReplicationGroup (Maybe Text) Source #

The name of the cache subnet group to be used for the replication group. Important: 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 .

crgNumNodeGroups :: Lens' CreateReplicationGroup (Maybe Int) Source #

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

crgSnapshotRetentionLimit :: Lens' CreateReplicationGroup (Maybe Int) Source #

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

crgReplicasPerNodeGroup :: Lens' CreateReplicationGroup (Maybe Int) Source #

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

crgNumCacheClusters :: Lens' CreateReplicationGroup (Maybe Int) Source #

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 (primary plus 5 replicas).

crgPreferredCacheClusterAZs :: Lens' CreateReplicationGroup [Text] Source #

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. Default: system chosen Availability Zones.

crgSnapshotName :: Lens' CreateReplicationGroup (Maybe Text) Source #

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.

crgNotificationTopicARN :: Lens' CreateReplicationGroup (Maybe Text) Source #

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

crgTags :: Lens' CreateReplicationGroup [Tag] Source #

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key does not have to be accompanied by a tag value.

crgPort :: Lens' CreateReplicationGroup (Maybe Int) Source #

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

crgCacheSecurityGroupNames :: Lens' CreateReplicationGroup [Text] Source #

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

crgReplicationGroupId :: Lens' CreateReplicationGroup Text Source #

The replication group identifier. This parameter is stored as a lowercase string. Constraints: * A name must contain from 1 to 20 alphanumeric characters or hyphens. * The first character must be a letter. * A name cannot end with a hyphen or contain two consecutive hyphens.

crgReplicationGroupDescription :: Lens' CreateReplicationGroup Text Source #

A user-created description for the replication group.

Destructuring the Response

createReplicationGroupResponse Source #

Creates a value of CreateReplicationGroupResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateReplicationGroupResponse Source #

See: createReplicationGroupResponse smart constructor.

Instances
Eq CreateReplicationGroupResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Data CreateReplicationGroupResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateReplicationGroupResponse -> c CreateReplicationGroupResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateReplicationGroupResponse #

toConstr :: CreateReplicationGroupResponse -> Constr #

dataTypeOf :: CreateReplicationGroupResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateReplicationGroupResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateReplicationGroupResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateReplicationGroupResponse -> CreateReplicationGroupResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateReplicationGroupResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateReplicationGroupResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateReplicationGroupResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateReplicationGroupResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateReplicationGroupResponse -> m CreateReplicationGroupResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateReplicationGroupResponse -> m CreateReplicationGroupResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateReplicationGroupResponse -> m CreateReplicationGroupResponse #

Read CreateReplicationGroupResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Show CreateReplicationGroupResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Generic CreateReplicationGroupResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

Associated Types

type Rep CreateReplicationGroupResponse :: Type -> Type #

NFData CreateReplicationGroupResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

type Rep CreateReplicationGroupResponse Source # 
Instance details

Defined in Network.AWS.ElastiCache.CreateReplicationGroup

type Rep CreateReplicationGroupResponse = D1 (MetaData "CreateReplicationGroupResponse" "Network.AWS.ElastiCache.CreateReplicationGroup" "amazonka-elasticache-1.6.1-7qPjCRJV7Sp8jKm0QWBmxX" False) (C1 (MetaCons "CreateReplicationGroupResponse'" PrefixI True) (S1 (MetaSel (Just "_crgrsReplicationGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ReplicationGroup)) :*: S1 (MetaSel (Just "_crgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses