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 |
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
Synopsis
- data UpdateCluster = UpdateCluster' {
- aCLName :: Maybe Text
- description :: Maybe Text
- engineVersion :: Maybe Text
- maintenanceWindow :: Maybe Text
- nodeType :: Maybe Text
- parameterGroupName :: Maybe Text
- replicaConfiguration :: Maybe ReplicaConfigurationRequest
- securityGroupIds :: Maybe [Text]
- shardConfiguration :: Maybe ShardConfigurationRequest
- snapshotRetentionLimit :: Maybe Int
- snapshotWindow :: Maybe Text
- snsTopicArn :: Maybe Text
- snsTopicStatus :: Maybe Text
- clusterName :: Text
- newUpdateCluster :: Text -> UpdateCluster
- updateCluster_aCLName :: Lens' UpdateCluster (Maybe Text)
- updateCluster_description :: Lens' UpdateCluster (Maybe Text)
- updateCluster_engineVersion :: Lens' UpdateCluster (Maybe Text)
- updateCluster_maintenanceWindow :: Lens' UpdateCluster (Maybe Text)
- updateCluster_nodeType :: Lens' UpdateCluster (Maybe Text)
- updateCluster_parameterGroupName :: Lens' UpdateCluster (Maybe Text)
- updateCluster_replicaConfiguration :: Lens' UpdateCluster (Maybe ReplicaConfigurationRequest)
- updateCluster_securityGroupIds :: Lens' UpdateCluster (Maybe [Text])
- updateCluster_shardConfiguration :: Lens' UpdateCluster (Maybe ShardConfigurationRequest)
- updateCluster_snapshotRetentionLimit :: Lens' UpdateCluster (Maybe Int)
- updateCluster_snapshotWindow :: Lens' UpdateCluster (Maybe Text)
- updateCluster_snsTopicArn :: Lens' UpdateCluster (Maybe Text)
- updateCluster_snsTopicStatus :: Lens' UpdateCluster (Maybe Text)
- updateCluster_clusterName :: Lens' UpdateCluster Text
- data UpdateClusterResponse = UpdateClusterResponse' {
- cluster :: Maybe Cluster
- httpStatus :: Int
- newUpdateClusterResponse :: Int -> UpdateClusterResponse
- updateClusterResponse_cluster :: Lens' UpdateClusterResponse (Maybe Cluster)
- updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int
Creating a Request
data UpdateCluster Source #
See: newUpdateCluster
smart constructor.
UpdateCluster' | |
|
Instances
Create a value of UpdateCluster
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:
UpdateCluster
, updateCluster_aCLName
- The Access Control List that is associated with the cluster
UpdateCluster
, updateCluster_description
- The description of the cluster to update
UpdateCluster
, updateCluster_engineVersion
- The upgraded version of the engine to be run on the nodes. You can
upgrade to a newer engine 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.
UpdateCluster
, updateCluster_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.
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
UpdateCluster
, updateCluster_nodeType
- A valid node type that you want to scale this cluster up or down to.
UpdateCluster
, updateCluster_parameterGroupName
- The name of the parameter group to update
$sel:replicaConfiguration:UpdateCluster'
, updateCluster_replicaConfiguration
- The number of replicas that will reside in each shard
$sel:securityGroupIds:UpdateCluster'
, updateCluster_securityGroupIds
- The SecurityGroupIds to update
$sel:shardConfiguration:UpdateCluster'
, updateCluster_shardConfiguration
- The number of shards in the cluster
UpdateCluster
, updateCluster_snapshotRetentionLimit
- The number of days for which MemoryDB 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.
UpdateCluster
, updateCluster_snapshotWindow
- The daily time range (in UTC) during which MemoryDB begins taking a
daily snapshot of your cluster.
UpdateCluster
, updateCluster_snsTopicArn
- The SNS topic ARN to update
UpdateCluster
, updateCluster_snsTopicStatus
- The status of the Amazon SNS notification topic. Notifications are sent
only if the status is active.
UpdateCluster
, updateCluster_clusterName
- The name of the cluster to update
Request Lenses
updateCluster_aCLName :: Lens' UpdateCluster (Maybe Text) Source #
The Access Control List that is associated with the cluster
updateCluster_description :: Lens' UpdateCluster (Maybe Text) Source #
The description of the cluster to update
updateCluster_engineVersion :: Lens' UpdateCluster (Maybe Text) Source #
The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine 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.
updateCluster_maintenanceWindow :: Lens' UpdateCluster (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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
updateCluster_nodeType :: Lens' UpdateCluster (Maybe Text) Source #
A valid node type that you want to scale this cluster up or down to.
updateCluster_parameterGroupName :: Lens' UpdateCluster (Maybe Text) Source #
The name of the parameter group to update
updateCluster_replicaConfiguration :: Lens' UpdateCluster (Maybe ReplicaConfigurationRequest) Source #
The number of replicas that will reside in each shard
updateCluster_securityGroupIds :: Lens' UpdateCluster (Maybe [Text]) Source #
The SecurityGroupIds to update
updateCluster_shardConfiguration :: Lens' UpdateCluster (Maybe ShardConfigurationRequest) Source #
The number of shards in the cluster
updateCluster_snapshotRetentionLimit :: Lens' UpdateCluster (Maybe Int) Source #
The number of days for which MemoryDB 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.
updateCluster_snapshotWindow :: Lens' UpdateCluster (Maybe Text) Source #
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
updateCluster_snsTopicArn :: Lens' UpdateCluster (Maybe Text) Source #
The SNS topic ARN to update
updateCluster_snsTopicStatus :: Lens' UpdateCluster (Maybe Text) Source #
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.
updateCluster_clusterName :: Lens' UpdateCluster Text Source #
The name of the cluster to update
Destructuring the Response
data UpdateClusterResponse Source #
See: newUpdateClusterResponse
smart constructor.
UpdateClusterResponse' | |
|
Instances
newUpdateClusterResponse Source #
Create a value of UpdateClusterResponse
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:cluster:UpdateClusterResponse'
, updateClusterResponse_cluster
- The updated cluster
$sel:httpStatus:UpdateClusterResponse'
, updateClusterResponse_httpStatus
- The response's http status code.
Response Lenses
updateClusterResponse_cluster :: Lens' UpdateClusterResponse (Maybe Cluster) Source #
The updated cluster
updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int Source #
The response's http status code.