Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
- modifyDBCluster :: Text -> ModifyDBCluster
- data ModifyDBCluster
- mdcEngineVersion :: Lens' ModifyDBCluster (Maybe Text)
- mdcMasterUserPassword :: Lens' ModifyDBCluster (Maybe Text)
- mdcBacktrackWindow :: Lens' ModifyDBCluster (Maybe Integer)
- mdcPreferredMaintenanceWindow :: Lens' ModifyDBCluster (Maybe Text)
- mdcPreferredBackupWindow :: Lens' ModifyDBCluster (Maybe Text)
- mdcBackupRetentionPeriod :: Lens' ModifyDBCluster (Maybe Int)
- mdcVPCSecurityGroupIds :: Lens' ModifyDBCluster [Text]
- mdcDBClusterParameterGroupName :: Lens' ModifyDBCluster (Maybe Text)
- mdcApplyImmediately :: Lens' ModifyDBCluster (Maybe Bool)
- mdcOptionGroupName :: Lens' ModifyDBCluster (Maybe Text)
- mdcNewDBClusterIdentifier :: Lens' ModifyDBCluster (Maybe Text)
- mdcPort :: Lens' ModifyDBCluster (Maybe Int)
- mdcEnableIAMDatabaseAuthentication :: Lens' ModifyDBCluster (Maybe Bool)
- mdcDBClusterIdentifier :: Lens' ModifyDBCluster Text
- modifyDBClusterResponse :: Int -> ModifyDBClusterResponse
- data ModifyDBClusterResponse
- mdcrsDBCluster :: Lens' ModifyDBClusterResponse (Maybe DBCluster)
- mdcrsResponseStatus :: Lens' ModifyDBClusterResponse Int
Creating a Request
Creates a value of ModifyDBCluster
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdcEngineVersion
- The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true. For a list of valid engine versions, seeCreateDBInstance
, or callDescribeDBEngineVersions
.mdcMasterUserPassword
- The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.mdcBacktrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours).mdcPreferredMaintenanceWindow
- 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 AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.mdcPreferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, using theBackupRetentionPeriod
parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: * Must be in the formathh24:mi-hh24:mi
. * Must be in Universal Coordinated Time (UTC). * Must not conflict with the preferred maintenance window. * Must be at least 30 minutes.mdcBackupRetentionPeriod
- 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 35mdcVPCSecurityGroupIds
- A list of VPC security groups that the DB cluster will belong to.mdcDBClusterParameterGroupName
- The name of the DB cluster parameter group to use for the DB cluster.mdcApplyImmediately
- A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of thePreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set tofalse
, changes to the DB cluster are applied during the next maintenance window. TheApplyImmediately
parameter only affects theNewDBClusterIdentifier
andMasterUserPassword
values. If you set theApplyImmediately
parameter value to false, then changes to theNewDBClusterIdentifier
andMasterUserPassword
values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of theApplyImmediately
parameter. Default:false
mdcOptionGroupName
- A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless theApplyImmediately
parameter is set totrue
for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.mdcNewDBClusterIdentifier
- The new DB cluster identifier for the DB cluster when renaming a DB 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
mdcPort
- The port number on which the DB cluster accepts connections. Constraints: Value must be1150-65535
Default: The same port as the original DB cluster.mdcEnableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default:false
mdcDBClusterIdentifier
- The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: * Must match the identifier of an existing DBCluster.
data ModifyDBCluster Source #
See: modifyDBCluster
smart constructor.
Request Lenses
mdcEngineVersion :: Lens' ModifyDBCluster (Maybe Text) Source #
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true. For a list of valid engine versions, see CreateDBInstance
, or call DescribeDBEngineVersions
.
mdcMasterUserPassword :: Lens' ModifyDBCluster (Maybe Text) Source #
The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
mdcBacktrackWindow :: Lens' ModifyDBCluster (Maybe Integer) Source #
The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours).
mdcPreferredMaintenanceWindow :: 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 AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
mdcPreferredBackupWindow :: 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 AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. 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.
mdcBackupRetentionPeriod :: 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
mdcVPCSecurityGroupIds :: Lens' ModifyDBCluster [Text] Source #
A list of VPC security groups that the DB cluster will belong to.
mdcDBClusterParameterGroupName :: Lens' ModifyDBCluster (Maybe Text) Source #
The name of the DB cluster parameter group to use for the DB cluster.
mdcApplyImmediately :: Lens' ModifyDBCluster (Maybe Bool) Source #
A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to false
, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately
parameter only affects the NewDBClusterIdentifier
and MasterUserPassword
values. If you set the ApplyImmediately
parameter value to false, then 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
mdcOptionGroupName :: Lens' ModifyDBCluster (Maybe Text) Source #
A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately
parameter is set to true
for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
mdcNewDBClusterIdentifier :: Lens' ModifyDBCluster (Maybe Text) Source #
The new DB cluster identifier for the DB cluster when renaming a DB 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
mdcPort :: Lens' ModifyDBCluster (Maybe Int) Source #
The port number on which the DB cluster accepts connections. Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
mdcEnableIAMDatabaseAuthentication :: Lens' ModifyDBCluster (Maybe Bool) Source #
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
mdcDBClusterIdentifier :: Lens' ModifyDBCluster Text Source #
The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: * Must match the identifier of an existing DBCluster.
Destructuring the Response
modifyDBClusterResponse Source #
Creates a value of ModifyDBClusterResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdcrsDBCluster
- Undocumented member.mdcrsResponseStatus
- -- | The response status code.
data ModifyDBClusterResponse Source #
See: modifyDBClusterResponse
smart constructor.
Response Lenses
mdcrsDBCluster :: Lens' ModifyDBClusterResponse (Maybe DBCluster) Source #
Undocumented member.
mdcrsResponseStatus :: Lens' ModifyDBClusterResponse Int Source #
- - | The response status code.