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

Amazonka.ElastiCache.Types.ReplicationGroup

Description

 
Synopsis

Documentation

data ReplicationGroup Source #

Contains all of the attributes of a specific Redis replication group.

See: newReplicationGroup smart constructor.

Constructors

ReplicationGroup' 

Fields

  • authTokenLastModifiedDate :: Maybe ISO8601

    The date the auth token was last modified

  • status :: Maybe Text

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

  • cacheNodeType :: Maybe Text

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

  • nodeGroups :: 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).

  • snapshottingClusterId :: Maybe Text

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

  • clusterEnabled :: 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

  • atRestEncryptionEnabled :: 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

  • replicationGroupCreateTime :: Maybe ISO8601

    The date and time when the cluster was created.

  • arn :: Maybe Text

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

  • transitEncryptionEnabled :: Maybe Bool

    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.

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

    Default: false

  • userGroupIds :: Maybe [Text]

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

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

  • logDeliveryConfigurations :: Maybe [LogDeliveryConfiguration]

    Returns the destination, format and type of the logs.

  • configurationEndpoint :: Maybe Endpoint

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

  • authTokenEnabled :: Maybe Bool

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

    Default: false

  • memberClusters :: Maybe [Text]

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

  • kmsKeyId :: Maybe Text

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

  • multiAZ :: Maybe MultiAZStatus

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

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

  • description :: Maybe Text

    The user supplied description of the replication group.

  • replicationGroupId :: Maybe Text

    The identifier for the replication group.

  • pendingModifiedValues :: Maybe ReplicationGroupPendingModifiedValues

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

  • globalReplicationGroupInfo :: Maybe GlobalReplicationGroupInfo

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

  • memberClustersOutpostArns :: Maybe [Text]

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

  • automaticFailover :: Maybe AutomaticFailoverStatus

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

Instances

Instances details
Eq ReplicationGroup Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.ReplicationGroup

Read ReplicationGroup Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.ReplicationGroup

Show ReplicationGroup Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.ReplicationGroup

Generic ReplicationGroup Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.ReplicationGroup

Associated Types

type Rep ReplicationGroup :: Type -> Type #

NFData ReplicationGroup Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.ReplicationGroup

Methods

rnf :: ReplicationGroup -> () #

Hashable ReplicationGroup Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.ReplicationGroup

FromXML ReplicationGroup Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.ReplicationGroup

type Rep ReplicationGroup Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.ReplicationGroup

type Rep ReplicationGroup = D1 ('MetaData "ReplicationGroup" "Amazonka.ElastiCache.Types.ReplicationGroup" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "ReplicationGroup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "authTokenLastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cacheNodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "nodeGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NodeGroup])) :*: (S1 ('MetaSel ('Just "snapshottingClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clusterEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "atRestEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "replicationGroupCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "transitEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "userGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "snapshotWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "logDeliveryConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LogDeliveryConfiguration])) :*: (S1 ('MetaSel ('Just "configurationEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Endpoint)) :*: S1 ('MetaSel ('Just "authTokenEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "memberClusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiAZStatus))))) :*: ((S1 ('MetaSel ('Just "snapshotRetentionLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "replicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "pendingModifiedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationGroupPendingModifiedValues)) :*: S1 ('MetaSel ('Just "globalReplicationGroupInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalReplicationGroupInfo))) :*: (S1 ('MetaSel ('Just "memberClustersOutpostArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "automaticFailover") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutomaticFailoverStatus))))))))

newReplicationGroup :: ReplicationGroup Source #

Create a value of ReplicationGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authTokenLastModifiedDate:ReplicationGroup', replicationGroup_authTokenLastModifiedDate - The date the auth token was last modified

$sel:status:ReplicationGroup', replicationGroup_status - The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

$sel:cacheNodeType:ReplicationGroup', replicationGroup_cacheNodeType - The name of the compute and memory capacity node type for each node in the replication group.

$sel:nodeGroups:ReplicationGroup', replicationGroup_nodeGroups - 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).

$sel:snapshottingClusterId:ReplicationGroup', replicationGroup_snapshottingClusterId - The cluster ID that is used as the daily snapshot source for the replication group.

$sel:clusterEnabled:ReplicationGroup', replicationGroup_clusterEnabled - 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

$sel:atRestEncryptionEnabled:ReplicationGroup', replicationGroup_atRestEncryptionEnabled - 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

$sel:replicationGroupCreateTime:ReplicationGroup', replicationGroup_replicationGroupCreateTime - The date and time when the cluster was created.

$sel:arn:ReplicationGroup', replicationGroup_arn - The ARN (Amazon Resource Name) of the replication group.

$sel:transitEncryptionEnabled:ReplicationGroup', replicationGroup_transitEncryptionEnabled - 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.

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

Default: false

$sel:userGroupIds:ReplicationGroup', replicationGroup_userGroupIds - The ID of the user group associated to the replication group.

$sel:snapshotWindow:ReplicationGroup', replicationGroup_snapshotWindow - 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.

$sel:logDeliveryConfigurations:ReplicationGroup', replicationGroup_logDeliveryConfigurations - Returns the destination, format and type of the logs.

$sel:configurationEndpoint:ReplicationGroup', replicationGroup_configurationEndpoint - The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

$sel:authTokenEnabled:ReplicationGroup', replicationGroup_authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

$sel:memberClusters:ReplicationGroup', replicationGroup_memberClusters - The names of all the cache clusters that are part of this replication group.

$sel:kmsKeyId:ReplicationGroup', replicationGroup_kmsKeyId - The ID of the KMS key used to encrypt the disk in the cluster.

$sel:multiAZ:ReplicationGroup', replicationGroup_multiAZ - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

$sel:snapshotRetentionLimit:ReplicationGroup', replicationGroup_snapshotRetentionLimit - 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.

$sel:description:ReplicationGroup', replicationGroup_description - The user supplied description of the replication group.

$sel:replicationGroupId:ReplicationGroup', replicationGroup_replicationGroupId - The identifier for the replication group.

$sel:pendingModifiedValues:ReplicationGroup', replicationGroup_pendingModifiedValues - A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

$sel:globalReplicationGroupInfo:ReplicationGroup', replicationGroup_globalReplicationGroupInfo - The name of the Global datastore and role of this replication group in the Global datastore.

$sel:memberClustersOutpostArns:ReplicationGroup', replicationGroup_memberClustersOutpostArns - The outpost ARNs of the replication group's member clusters.

$sel:automaticFailover:ReplicationGroup', replicationGroup_automaticFailover - Indicates the status of automatic failover for this Redis replication group.

replicationGroup_status :: Lens' ReplicationGroup (Maybe Text) Source #

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

replicationGroup_cacheNodeType :: Lens' ReplicationGroup (Maybe Text) Source #

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

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

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_snapshottingClusterId :: Lens' ReplicationGroup (Maybe Text) Source #

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

replicationGroup_clusterEnabled :: Lens' ReplicationGroup (Maybe Bool) Source #

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_atRestEncryptionEnabled :: Lens' ReplicationGroup (Maybe Bool) Source #

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_replicationGroupCreateTime :: Lens' ReplicationGroup (Maybe UTCTime) Source #

The date and time when the cluster was created.

replicationGroup_arn :: Lens' ReplicationGroup (Maybe Text) Source #

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

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

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_userGroupIds :: Lens' ReplicationGroup (Maybe [Text]) Source #

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

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

This parameter is only valid if the Engine parameter is redis.

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

Returns the destination, format and type of the logs.

replicationGroup_configurationEndpoint :: Lens' ReplicationGroup (Maybe Endpoint) Source #

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

replicationGroup_authTokenEnabled :: Lens' ReplicationGroup (Maybe Bool) Source #

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

Default: false

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

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

replicationGroup_kmsKeyId :: Lens' ReplicationGroup (Maybe Text) Source #

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

replicationGroup_multiAZ :: Lens' ReplicationGroup (Maybe MultiAZStatus) Source #

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

replicationGroup_snapshotRetentionLimit :: Lens' ReplicationGroup (Maybe Int) Source #

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_description :: Lens' ReplicationGroup (Maybe Text) Source #

The user supplied description of the replication group.

replicationGroup_replicationGroupId :: Lens' ReplicationGroup (Maybe Text) Source #

The identifier for the replication group.

replicationGroup_pendingModifiedValues :: Lens' ReplicationGroup (Maybe ReplicationGroupPendingModifiedValues) Source #

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

replicationGroup_globalReplicationGroupInfo :: Lens' ReplicationGroup (Maybe GlobalReplicationGroupInfo) Source #

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

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

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

replicationGroup_automaticFailover :: Lens' ReplicationGroup (Maybe AutomaticFailoverStatus) Source #

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