Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Cluster = Cluster' {
- aCLName :: Maybe Text
- arn :: Maybe Text
- autoMinorVersionUpgrade :: Maybe Bool
- availabilityMode :: Maybe AZStatus
- clusterEndpoint :: Maybe Endpoint
- dataTiering :: Maybe DataTieringStatus
- description :: Maybe Text
- enginePatchVersion :: Maybe Text
- engineVersion :: Maybe Text
- kmsKeyId :: Maybe Text
- maintenanceWindow :: Maybe Text
- name :: Maybe Text
- nodeType :: Maybe Text
- numberOfShards :: Maybe Int
- parameterGroupName :: Maybe Text
- parameterGroupStatus :: Maybe Text
- pendingUpdates :: Maybe ClusterPendingUpdates
- securityGroups :: Maybe [SecurityGroupMembership]
- shards :: Maybe [Shard]
- snapshotRetentionLimit :: Maybe Int
- snapshotWindow :: Maybe Text
- snsTopicArn :: Maybe Text
- snsTopicStatus :: Maybe Text
- status :: Maybe Text
- subnetGroupName :: Maybe Text
- tLSEnabled :: Maybe Bool
- newCluster :: Cluster
- cluster_aCLName :: Lens' Cluster (Maybe Text)
- cluster_arn :: Lens' Cluster (Maybe Text)
- cluster_autoMinorVersionUpgrade :: Lens' Cluster (Maybe Bool)
- cluster_availabilityMode :: Lens' Cluster (Maybe AZStatus)
- cluster_clusterEndpoint :: Lens' Cluster (Maybe Endpoint)
- cluster_dataTiering :: Lens' Cluster (Maybe DataTieringStatus)
- cluster_description :: Lens' Cluster (Maybe Text)
- cluster_enginePatchVersion :: Lens' Cluster (Maybe Text)
- cluster_engineVersion :: Lens' Cluster (Maybe Text)
- cluster_kmsKeyId :: Lens' Cluster (Maybe Text)
- cluster_maintenanceWindow :: Lens' Cluster (Maybe Text)
- cluster_name :: Lens' Cluster (Maybe Text)
- cluster_nodeType :: Lens' Cluster (Maybe Text)
- cluster_numberOfShards :: Lens' Cluster (Maybe Int)
- cluster_parameterGroupName :: Lens' Cluster (Maybe Text)
- cluster_parameterGroupStatus :: Lens' Cluster (Maybe Text)
- cluster_pendingUpdates :: Lens' Cluster (Maybe ClusterPendingUpdates)
- cluster_securityGroups :: Lens' Cluster (Maybe [SecurityGroupMembership])
- cluster_shards :: Lens' Cluster (Maybe [Shard])
- cluster_snapshotRetentionLimit :: Lens' Cluster (Maybe Int)
- cluster_snapshotWindow :: Lens' Cluster (Maybe Text)
- cluster_snsTopicArn :: Lens' Cluster (Maybe Text)
- cluster_snsTopicStatus :: Lens' Cluster (Maybe Text)
- cluster_status :: Lens' Cluster (Maybe Text)
- cluster_subnetGroupName :: Lens' Cluster (Maybe Text)
- cluster_tLSEnabled :: Lens' Cluster (Maybe Bool)
Documentation
Contains all of the attributes of a specific cluster.
See: newCluster
smart constructor.
Cluster' | |
|
Instances
newCluster :: Cluster Source #
Create a value of Cluster
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:aCLName:Cluster'
, cluster_aCLName
- The name of the Access Control List associated with this cluster.
$sel:arn:Cluster'
, cluster_arn
- The Amazon Resource Name (ARN) of the cluster.
$sel:autoMinorVersionUpgrade:Cluster'
, cluster_autoMinorVersionUpgrade
- When set to true, the cluster will automatically receive minor engine
version upgrades after launch.
$sel:availabilityMode:Cluster'
, cluster_availabilityMode
- Indicates if the cluster has a Multi-AZ configuration (multiaz) or not
(singleaz).
$sel:clusterEndpoint:Cluster'
, cluster_clusterEndpoint
- The cluster's configuration endpoint
$sel:dataTiering:Cluster'
, cluster_dataTiering
- Enables data tiering. Data tiering is only supported for clusters using
the r6gd node type. This parameter must be set when using r6gd nodes.
For more information, see
Data tiering.
$sel:description:Cluster'
, cluster_description
- A description of the cluster
$sel:enginePatchVersion:Cluster'
, cluster_enginePatchVersion
- The Redis engine patch version used by the cluster
$sel:engineVersion:Cluster'
, cluster_engineVersion
- The Redis engine version used by the cluster
$sel:kmsKeyId:Cluster'
, cluster_kmsKeyId
- The ID of the KMS key used to encrypt the cluster
$sel:maintenanceWindow:Cluster'
, cluster_maintenanceWindow
- 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.
Cluster
, cluster_name
- The user-supplied name of the cluster. This identifier is a unique key
that identifies a cluster.
$sel:nodeType:Cluster'
, cluster_nodeType
- The cluster's node type
$sel:numberOfShards:Cluster'
, cluster_numberOfShards
- The number of shards in the cluster
$sel:parameterGroupName:Cluster'
, cluster_parameterGroupName
- The name of the parameter group used by the cluster
$sel:parameterGroupStatus:Cluster'
, cluster_parameterGroupStatus
- The status of the parameter group used by the cluster, for example
'active' or 'applying'.
$sel:pendingUpdates:Cluster'
, cluster_pendingUpdates
- A group of settings that are currently being applied.
$sel:securityGroups:Cluster'
, cluster_securityGroups
- A list of security groups used by the cluster
$sel:shards:Cluster'
, cluster_shards
- A list of shards that are members of the cluster.
$sel:snapshotRetentionLimit:Cluster'
, cluster_snapshotRetentionLimit
- The number of days for which MemoryDB 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.
$sel:snapshotWindow:Cluster'
, cluster_snapshotWindow
- The daily time range (in UTC) during which MemoryDB begins taking a
daily snapshot of your shard. Example: 05:00-09:00 If you do not specify
this parameter, MemoryDB automatically chooses an appropriate time
range.
$sel:snsTopicArn:Cluster'
, cluster_snsTopicArn
- The Amazon Resource Name (ARN) of the SNS notification topic
$sel:snsTopicStatus:Cluster'
, cluster_snsTopicStatus
- The SNS topic must be in Active status to receive notifications
Cluster
, cluster_status
- The status of the cluster. For example, Available, Updating, Creating.
$sel:subnetGroupName:Cluster'
, cluster_subnetGroupName
- The name of the subnet group used by the cluster
$sel:tLSEnabled:Cluster'
, cluster_tLSEnabled
- A flag to indicate if In-transit encryption is enabled
cluster_aCLName :: Lens' Cluster (Maybe Text) Source #
The name of the Access Control List associated with this cluster.
cluster_autoMinorVersionUpgrade :: Lens' Cluster (Maybe Bool) Source #
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
cluster_availabilityMode :: Lens' Cluster (Maybe AZStatus) Source #
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
cluster_clusterEndpoint :: Lens' Cluster (Maybe Endpoint) Source #
The cluster's configuration endpoint
cluster_dataTiering :: Lens' Cluster (Maybe DataTieringStatus) Source #
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
cluster_enginePatchVersion :: Lens' Cluster (Maybe Text) Source #
The Redis engine patch version used by the cluster
cluster_engineVersion :: Lens' Cluster (Maybe Text) Source #
The Redis engine version used by the cluster
cluster_kmsKeyId :: Lens' Cluster (Maybe Text) Source #
The ID of the KMS key used to encrypt the cluster
cluster_maintenanceWindow :: Lens' Cluster (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.
cluster_name :: Lens' Cluster (Maybe Text) Source #
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
cluster_parameterGroupName :: Lens' Cluster (Maybe Text) Source #
The name of the parameter group used by the cluster
cluster_parameterGroupStatus :: Lens' Cluster (Maybe Text) Source #
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
cluster_pendingUpdates :: Lens' Cluster (Maybe ClusterPendingUpdates) Source #
A group of settings that are currently being applied.
cluster_securityGroups :: Lens' Cluster (Maybe [SecurityGroupMembership]) Source #
A list of security groups used by the cluster
cluster_shards :: Lens' Cluster (Maybe [Shard]) Source #
A list of shards that are members of the cluster.
cluster_snapshotRetentionLimit :: Lens' Cluster (Maybe Int) Source #
The number of days for which MemoryDB 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.
cluster_snapshotWindow :: Lens' Cluster (Maybe Text) Source #
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
cluster_snsTopicArn :: Lens' Cluster (Maybe Text) Source #
The Amazon Resource Name (ARN) of the SNS notification topic
cluster_snsTopicStatus :: Lens' Cluster (Maybe Text) Source #
The SNS topic must be in Active status to receive notifications
cluster_status :: Lens' Cluster (Maybe Text) Source #
The status of the cluster. For example, Available, Updating, Creating.