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

Amazonka.DocumentDB.ModifyDBCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Synopsis

data ModifyDBCluster = ModifyDBCluster' {
- applyImmediately :: Maybe Bool
- backupRetentionPeriod :: Maybe Int
- cloudwatchLogsExportConfiguration :: Maybe CloudwatchLogsExportConfiguration
- dbClusterParameterGroupName :: Maybe Text
- deletionProtection :: Maybe Bool
- engineVersion :: Maybe Text
- masterUserPassword :: Maybe Text
- newDBClusterIdentifier' :: Maybe Text
- port :: Maybe Int
- preferredBackupWindow :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- vpcSecurityGroupIds :: Maybe [Text]
- dbClusterIdentifier :: Text
}
newModifyDBCluster :: Text -> ModifyDBCluster
modifyDBCluster_applyImmediately :: Lens' ModifyDBCluster (Maybe Bool)
modifyDBCluster_backupRetentionPeriod :: Lens' ModifyDBCluster (Maybe Int)
modifyDBCluster_cloudwatchLogsExportConfiguration :: Lens' ModifyDBCluster (Maybe CloudwatchLogsExportConfiguration)
modifyDBCluster_dbClusterParameterGroupName :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_deletionProtection :: Lens' ModifyDBCluster (Maybe Bool)
modifyDBCluster_engineVersion :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_masterUserPassword :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_newDBClusterIdentifier :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_port :: Lens' ModifyDBCluster (Maybe Int)
modifyDBCluster_preferredBackupWindow :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_preferredMaintenanceWindow :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_vpcSecurityGroupIds :: Lens' ModifyDBCluster (Maybe [Text])
modifyDBCluster_dbClusterIdentifier :: Lens' ModifyDBCluster Text
data ModifyDBClusterResponse = ModifyDBClusterResponse' {
- dbCluster :: Maybe DBCluster
- httpStatus :: Int
}
newModifyDBClusterResponse :: Int -> ModifyDBClusterResponse
modifyDBClusterResponse_dbCluster :: Lens' ModifyDBClusterResponse (Maybe DBCluster)
modifyDBClusterResponse_httpStatus :: Lens' ModifyDBClusterResponse Int

Creating a Request

data ModifyDBCluster Source #

Represents the input to ModifyDBCluster.

See: newModifyDBCluster smart constructor.

Constructors

ModifyDBCluster'

Fields

applyImmediately :: Maybe Bool
A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.
The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.
Default: false
backupRetentionPeriod :: Maybe Int
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
- Must be a value from 1 to 35.
cloudwatchLogsExportConfiguration :: Maybe CloudwatchLogsExportConfiguration
The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.
dbClusterParameterGroupName :: Maybe Text
The name of the cluster parameter group to use for the cluster.
deletionProtection :: Maybe Bool
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
engineVersion :: Maybe Text
The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.
masterUserPassword :: Maybe Text
The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
newDBClusterIdentifier' :: Maybe Text
The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
port :: Maybe Int
The port number on which the cluster accepts connections.
Constraints: Must be a value from 1150 to 65535.
Default: The same port as the original cluster.
preferredBackupWindow :: Maybe Text
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.
Constraints:
- Must be in the format hh24:mi-hh24:mi.
- Must be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
preferredMaintenanceWindow :: Maybe Text
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
vpcSecurityGroupIds :: Maybe [Text]
A list of virtual private cloud (VPC) security groups that the cluster will belong to.
dbClusterIdentifier :: Text
The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.
Constraints:
- Must match the identifier of an existing DBCluster.

Instances

Instances details

ToHeaders ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods toHeaders :: ModifyDBCluster -> [Header] #
ToPath ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods toPath :: ModifyDBCluster -> ByteString #
ToQuery ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods toQuery :: ModifyDBCluster -> QueryString #
AWSRequest ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Associated Types type AWSResponse ModifyDBCluster # Methods request :: (Service -> Service) -> ModifyDBCluster -> Request ModifyDBCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyDBCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyDBCluster))) #
Generic ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Associated Types type Rep ModifyDBCluster :: Type -> Type # Methods from :: ModifyDBCluster -> Rep ModifyDBCluster x # to :: Rep ModifyDBCluster x -> ModifyDBCluster #
Read ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods readsPrec :: Int -> ReadS ModifyDBCluster # readList :: ReadS [ModifyDBCluster] # readPrec :: ReadPrec ModifyDBCluster # readListPrec :: ReadPrec [ModifyDBCluster] #
Show ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods showsPrec :: Int -> ModifyDBCluster -> ShowS # show :: ModifyDBCluster -> String # showList :: [ModifyDBCluster] -> ShowS #
NFData ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods rnf :: ModifyDBCluster -> () #
Eq ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods (==) :: ModifyDBCluster -> ModifyDBCluster -> Bool # (/=) :: ModifyDBCluster -> ModifyDBCluster -> Bool #
Hashable ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods hashWithSalt :: Int -> ModifyDBCluster -> Int # hash :: ModifyDBCluster -> Int #
type AWSResponse ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster type AWSResponse ModifyDBCluster = ModifyDBClusterResponse
type Rep ModifyDBCluster Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster type Rep ModifyDBCluster = D1 ('MetaData "ModifyDBCluster" "Amazonka.DocumentDB.ModifyDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applyImmediately") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "cloudwatchLogsExportConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudwatchLogsExportConfiguration)))) :: (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "newDBClusterIdentifier'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifyDBCluster Source #

Arguments

:: Text	`ModifyDBCluster`
-> ModifyDBCluster

Create a value of ModifyDBCluster 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:applyImmediately:ModifyDBCluster', modifyDBCluster_applyImmediately - A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

ModifyDBCluster, modifyDBCluster_backupRetentionPeriod - The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35.

$sel:cloudwatchLogsExportConfiguration:ModifyDBCluster', modifyDBCluster_cloudwatchLogsExportConfiguration - The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

ModifyDBCluster, modifyDBCluster_dbClusterParameterGroupName - The name of the cluster parameter group to use for the cluster.

ModifyDBCluster, modifyDBCluster_deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

ModifyDBCluster, modifyDBCluster_engineVersion - The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

ModifyDBCluster, modifyDBCluster_masterUserPassword - The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

$sel:newDBClusterIdentifier':ModifyDBCluster', modifyDBCluster_newDBClusterIdentifier - The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

ModifyDBCluster, modifyDBCluster_port - The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

ModifyDBCluster, modifyDBCluster_preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

ModifyDBCluster, modifyDBCluster_preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

$sel:vpcSecurityGroupIds:ModifyDBCluster', modifyDBCluster_vpcSecurityGroupIds - A list of virtual private cloud (VPC) security groups that the cluster will belong to.

ModifyDBCluster, modifyDBCluster_dbClusterIdentifier - The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

Request Lenses

modifyDBCluster_applyImmediately :: Lens' ModifyDBCluster (Maybe Bool) Source #

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

modifyDBCluster_backupRetentionPeriod :: Lens' ModifyDBCluster (Maybe Int) Source #

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35.

modifyDBCluster_cloudwatchLogsExportConfiguration :: Lens' ModifyDBCluster (Maybe CloudwatchLogsExportConfiguration) Source #

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

modifyDBCluster_dbClusterParameterGroupName :: Lens' ModifyDBCluster (Maybe Text) Source #

The name of the cluster parameter group to use for the cluster.

modifyDBCluster_deletionProtection :: Lens' ModifyDBCluster (Maybe Bool) Source #

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

modifyDBCluster_engineVersion :: Lens' ModifyDBCluster (Maybe Text) Source #

The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

modifyDBCluster_masterUserPassword :: Lens' ModifyDBCluster (Maybe Text) Source #

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

modifyDBCluster_newDBClusterIdentifier :: Lens' ModifyDBCluster (Maybe Text) Source #

The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

modifyDBCluster_port :: Lens' ModifyDBCluster (Maybe Int) Source #

The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

modifyDBCluster_preferredBackupWindow :: Lens' ModifyDBCluster (Maybe Text) Source #

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

modifyDBCluster_preferredMaintenanceWindow :: Lens' ModifyDBCluster (Maybe Text) Source #

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

modifyDBCluster_vpcSecurityGroupIds :: Lens' ModifyDBCluster (Maybe [Text]) Source #

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

modifyDBCluster_dbClusterIdentifier :: Lens' ModifyDBCluster Text Source #

The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

Destructuring the Response

data ModifyDBClusterResponse Source #

See: newModifyDBClusterResponse smart constructor.

Constructors

ModifyDBClusterResponse'
Fields dbCluster :: Maybe DBCluster httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ModifyDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Associated Types type Rep ModifyDBClusterResponse :: Type -> Type # Methods from :: ModifyDBClusterResponse -> Rep ModifyDBClusterResponse x # to :: Rep ModifyDBClusterResponse x -> ModifyDBClusterResponse #
Read ModifyDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods readsPrec :: Int -> ReadS ModifyDBClusterResponse # readList :: ReadS [ModifyDBClusterResponse] # readPrec :: ReadPrec ModifyDBClusterResponse # readListPrec :: ReadPrec [ModifyDBClusterResponse] #
Show ModifyDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods showsPrec :: Int -> ModifyDBClusterResponse -> ShowS # show :: ModifyDBClusterResponse -> String # showList :: [ModifyDBClusterResponse] -> ShowS #
NFData ModifyDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods rnf :: ModifyDBClusterResponse -> () #
Eq ModifyDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster Methods (==) :: ModifyDBClusterResponse -> ModifyDBClusterResponse -> Bool # (/=) :: ModifyDBClusterResponse -> ModifyDBClusterResponse -> Bool #
type Rep ModifyDBClusterResponse Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBCluster type Rep ModifyDBClusterResponse = D1 ('MetaData "ModifyDBClusterResponse" "Amazonka.DocumentDB.ModifyDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyDBClusterResponse Source #

Arguments

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

Create a value of ModifyDBClusterResponse 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:dbCluster:ModifyDBClusterResponse', modifyDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:ModifyDBClusterResponse', modifyDBClusterResponse_httpStatus - The response's http status code.

Response Lenses

modifyDBClusterResponse_dbCluster :: Lens' ModifyDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

modifyDBClusterResponse_httpStatus :: Lens' ModifyDBClusterResponse Int Source #

The response's http status code.