Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MemoryDb.UpdateCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- engineVersion :: Maybe Text
- securityGroupIds :: Maybe [Text]
- snsTopicArn :: Maybe Text
- snapshotWindow :: Maybe Text
- maintenanceWindow :: Maybe Text
- shardConfiguration :: Maybe ShardConfigurationRequest
- snapshotRetentionLimit :: Maybe Int
- replicaConfiguration :: Maybe ReplicaConfigurationRequest
- nodeType :: Maybe Text
- snsTopicStatus :: Maybe Text
- description :: Maybe Text
- aCLName :: Maybe Text
- parameterGroupName :: Maybe Text
- clusterName :: Text
}
newUpdateCluster :: Text -> UpdateCluster
updateCluster_engineVersion :: Lens' UpdateCluster (Maybe Text)
updateCluster_securityGroupIds :: Lens' UpdateCluster (Maybe [Text])
updateCluster_snsTopicArn :: Lens' UpdateCluster (Maybe Text)
updateCluster_snapshotWindow :: Lens' UpdateCluster (Maybe Text)
updateCluster_maintenanceWindow :: Lens' UpdateCluster (Maybe Text)
updateCluster_shardConfiguration :: Lens' UpdateCluster (Maybe ShardConfigurationRequest)
updateCluster_snapshotRetentionLimit :: Lens' UpdateCluster (Maybe Int)
updateCluster_replicaConfiguration :: Lens' UpdateCluster (Maybe ReplicaConfigurationRequest)
updateCluster_nodeType :: Lens' UpdateCluster (Maybe Text)
updateCluster_snsTopicStatus :: Lens' UpdateCluster (Maybe Text)
updateCluster_description :: Lens' UpdateCluster (Maybe Text)
updateCluster_aCLName :: Lens' UpdateCluster (Maybe Text)
updateCluster_parameterGroupName :: 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.

Constructors

UpdateCluster'

Fields

engineVersion :: Maybe Text
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.
securityGroupIds :: Maybe [Text]
The SecurityGroupIds to update
snsTopicArn :: Maybe Text
The SNS topic ARN to update
snapshotWindow :: Maybe Text
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
maintenanceWindow :: Maybe Text
The maintenance window to update
shardConfiguration :: Maybe ShardConfigurationRequest
The number of shards in the cluster
snapshotRetentionLimit :: Maybe Int
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.
replicaConfiguration :: Maybe ReplicaConfigurationRequest
The number of replicas that will reside in each shard
nodeType :: Maybe Text
A valid node type that you want to scale this cluster up or down to.
snsTopicStatus :: Maybe Text
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.
description :: Maybe Text
The description of the cluster to update
aCLName :: Maybe Text
The Access Control List that is associated with the cluster
parameterGroupName :: Maybe Text
The name of the parameter group to update
clusterName :: Text
The name of the cluster to update

Instances

Instances details

Eq UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods (==) :: UpdateCluster -> UpdateCluster -> Bool # (/=) :: UpdateCluster -> UpdateCluster -> Bool #
Read UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods readsPrec :: Int -> ReadS UpdateCluster # readList :: ReadS [UpdateCluster] # readPrec :: ReadPrec UpdateCluster # readListPrec :: ReadPrec [UpdateCluster] #
Show UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods showsPrec :: Int -> UpdateCluster -> ShowS # show :: UpdateCluster -> String # showList :: [UpdateCluster] -> ShowS #
Generic UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Associated Types type Rep UpdateCluster :: Type -> Type # Methods from :: UpdateCluster -> Rep UpdateCluster x # to :: Rep UpdateCluster x -> UpdateCluster #
NFData UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods rnf :: UpdateCluster -> () #
Hashable UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods hashWithSalt :: Int -> UpdateCluster -> Int # hash :: UpdateCluster -> Int #
ToJSON UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods toJSON :: UpdateCluster -> Value # toEncoding :: UpdateCluster -> Encoding # toJSONList :: [UpdateCluster] -> Value # toEncodingList :: [UpdateCluster] -> Encoding #
AWSRequest UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Associated Types type AWSResponse UpdateCluster # Methods request :: UpdateCluster -> Request UpdateCluster # response :: MonadResource m => Logger -> Service -> Proxy UpdateCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateCluster))) #
ToHeaders UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods toHeaders :: UpdateCluster -> [Header] #
ToPath UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods toPath :: UpdateCluster -> ByteString #
ToQuery UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods toQuery :: UpdateCluster -> QueryString #
type Rep UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster type Rep UpdateCluster = D1 ('MetaData "UpdateCluster" "Amazonka.MemoryDb.UpdateCluster" "libZSservicesZSamazonka-memorydbZSamazonka-memorydb" 'False) (C1 ('MetaCons "UpdateCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "snapshotWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "shardConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShardConfigurationRequest)) :: S1 ('MetaSel ('Just "snapshotRetentionLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "replicaConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicaConfigurationRequest)) :: (S1 ('MetaSel ('Just "nodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "snsTopicStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "aCLName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "parameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse UpdateCluster Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster type AWSResponse UpdateCluster = UpdateClusterResponse

newUpdateCluster Source #

Arguments

:: Text	`$sel:clusterName:UpdateCluster'`
-> UpdateCluster

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:

$sel:engineVersion: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.

$sel:securityGroupIds:UpdateCluster', updateCluster_securityGroupIds - The SecurityGroupIds to update

$sel:snsTopicArn:UpdateCluster', updateCluster_snsTopicArn - The SNS topic ARN to update

$sel:snapshotWindow:UpdateCluster', updateCluster_snapshotWindow - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

$sel:maintenanceWindow:UpdateCluster', updateCluster_maintenanceWindow - The maintenance window to update

$sel:shardConfiguration:UpdateCluster', updateCluster_shardConfiguration - The number of shards in the cluster

$sel:snapshotRetentionLimit: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.

$sel:replicaConfiguration:UpdateCluster', updateCluster_replicaConfiguration - The number of replicas that will reside in each shard

$sel:nodeType:UpdateCluster', updateCluster_nodeType - A valid node type that you want to scale this cluster up or down to.

$sel:snsTopicStatus:UpdateCluster', updateCluster_snsTopicStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

$sel:description:UpdateCluster', updateCluster_description - The description of the cluster to update

$sel:aCLName:UpdateCluster', updateCluster_aCLName - The Access Control List that is associated with the cluster

$sel:parameterGroupName:UpdateCluster', updateCluster_parameterGroupName - The name of the parameter group to update

$sel:clusterName:UpdateCluster', updateCluster_clusterName - The name of the cluster to update

Request Lenses

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

The SecurityGroupIds to update

updateCluster_snsTopicArn :: Lens' UpdateCluster (Maybe Text) Source #

The SNS topic ARN to update

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

The maintenance window 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_replicaConfiguration :: Lens' UpdateCluster (Maybe ReplicaConfigurationRequest) Source #

The number of replicas that will reside in each shard

updateCluster_nodeType :: Lens' UpdateCluster (Maybe Text) Source #

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

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

The description of the cluster to update

updateCluster_aCLName :: Lens' UpdateCluster (Maybe Text) Source #

The Access Control List that is associated with the cluster

updateCluster_parameterGroupName :: Lens' UpdateCluster (Maybe Text) Source #

The name of the parameter group to update

updateCluster_clusterName :: Lens' UpdateCluster Text Source #

The name of the cluster to update

Destructuring the Response

data UpdateClusterResponse Source #

See: newUpdateClusterResponse smart constructor.

Constructors

UpdateClusterResponse'
Fields cluster :: Maybe Cluster The updated cluster httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpdateClusterResponse Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods (==) :: UpdateClusterResponse -> UpdateClusterResponse -> Bool # (/=) :: UpdateClusterResponse -> UpdateClusterResponse -> Bool #
Read UpdateClusterResponse Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods readsPrec :: Int -> ReadS UpdateClusterResponse # readList :: ReadS [UpdateClusterResponse] # readPrec :: ReadPrec UpdateClusterResponse # readListPrec :: ReadPrec [UpdateClusterResponse] #
Show UpdateClusterResponse Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods showsPrec :: Int -> UpdateClusterResponse -> ShowS # show :: UpdateClusterResponse -> String # showList :: [UpdateClusterResponse] -> ShowS #
Generic UpdateClusterResponse Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Associated Types type Rep UpdateClusterResponse :: Type -> Type # Methods from :: UpdateClusterResponse -> Rep UpdateClusterResponse x # to :: Rep UpdateClusterResponse x -> UpdateClusterResponse #
NFData UpdateClusterResponse Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster Methods rnf :: UpdateClusterResponse -> () #
type Rep UpdateClusterResponse Source #
Instance details Defined in Amazonka.MemoryDb.UpdateCluster type Rep UpdateClusterResponse = D1 ('MetaData "UpdateClusterResponse" "Amazonka.MemoryDb.UpdateCluster" "libZSservicesZSamazonka-memorydbZSamazonka-memorydb" 'False) (C1 ('MetaCons "UpdateClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateClusterResponse'`
-> UpdateClusterResponse

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.