Network.AWS.RDS.ModifyDBCluster

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.

Creating a Request

modifyDBCluster

Arguments

:: Text

mdcDBClusterIdentifier

-> ModifyDBCluster

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, see CreateDBInstance , or call DescribeDBEngineVersions .
• 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 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 - 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 - 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 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 - 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 - 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 be 1150-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

See: modifyDBCluster smart constructor.

Instances

Eq ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

(==) :: ModifyDBCluster -> ModifyDBCluster -> Bool

(/=) :: ModifyDBCluster -> ModifyDBCluster -> Bool

Data ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyDBCluster -> c ModifyDBCluster

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyDBCluster

toConstr :: ModifyDBCluster -> Constr

dataTypeOf :: ModifyDBCluster -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModifyDBCluster)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyDBCluster)

gmapT :: (forall b. Data b => b -> b) -> ModifyDBCluster -> ModifyDBCluster

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyDBCluster -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyDBCluster -> r

gmapQ :: (forall d. Data d => d -> u) -> ModifyDBCluster -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyDBCluster -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyDBCluster -> m ModifyDBCluster

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyDBCluster -> m ModifyDBCluster

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyDBCluster -> m ModifyDBCluster

Read ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

readsPrec :: Int -> ReadS ModifyDBCluster

readList :: ReadS [ModifyDBCluster]

readPrec :: ReadPrec ModifyDBCluster

readListPrec :: ReadPrec [ModifyDBCluster]

Show ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

showsPrec :: Int -> ModifyDBCluster -> ShowS

show :: ModifyDBCluster -> String

showList :: [ModifyDBCluster] -> ShowS

Generic ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Associated Types

type Rep ModifyDBCluster :: Type -> Type

Methods

from :: ModifyDBCluster -> Rep ModifyDBCluster x

to :: Rep ModifyDBCluster x -> ModifyDBCluster

Hashable ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

hashWithSalt :: Int -> ModifyDBCluster -> Int

hash :: ModifyDBCluster -> Int

AWSRequest ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Associated Types

type Rs ModifyDBCluster :: Type

Methods

request :: ModifyDBCluster -> Request ModifyDBCluster

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ModifyDBCluster -> ClientResponse -> m (Response ModifyDBCluster)

ToHeaders ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

toHeaders :: ModifyDBCluster -> [Header]

ToPath ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

toPath :: ModifyDBCluster -> ByteString

ToQuery ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

toQuery :: ModifyDBCluster -> QueryString

NFData ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

rnf :: ModifyDBCluster -> ()

type Rep ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

type Rep ModifyDBCluster = D1 (MetaData "ModifyDBCluster" "Network.AWS.RDS.ModifyDBCluster" "amazonka-rds-1.6.1-GvYb6r2di9RGFKQcoJXq1A" False) (C1 (MetaCons "ModifyDBCluster'" PrefixI True) (((S1 (MetaSel (Just "_mdcEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_mdcMasterUserPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mdcBacktrackWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)))) :*: ((S1 (MetaSel (Just "_mdcPreferredMaintenanceWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mdcPreferredBackupWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_mdcBackupRetentionPeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_mdcVPCSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 (MetaSel (Just "_mdcDBClusterParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_mdcApplyImmediately") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_mdcOptionGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_mdcNewDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mdcPort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 (MetaSel (Just "_mdcEnableIAMDatabaseAuthentication") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_mdcDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs ModifyDBCluster

Defined in Network.AWS.RDS.ModifyDBCluster

type Rs ModifyDBCluster = ModifyDBClusterResponse

Request Lenses

mdcEngineVersion :: Lens' ModifyDBCluster (Maybe Text)

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)

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)

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)

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)

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)

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]

A list of VPC security groups that the DB cluster will belong to.

mdcDBClusterParameterGroupName :: Lens' ModifyDBCluster (Maybe Text)

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

mdcApplyImmediately :: Lens' ModifyDBCluster (Maybe Bool)

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)

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)

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)

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)

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false

mdcDBClusterIdentifier :: Lens' ModifyDBCluster Text

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

Arguments

:: Int

mdcrsResponseStatus

-> ModifyDBClusterResponse

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

See: modifyDBClusterResponse smart constructor.

Instances

Eq ModifyDBClusterResponse

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

(==) :: ModifyDBClusterResponse -> ModifyDBClusterResponse -> Bool

(/=) :: ModifyDBClusterResponse -> ModifyDBClusterResponse -> Bool

Data ModifyDBClusterResponse

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyDBClusterResponse -> c ModifyDBClusterResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyDBClusterResponse

toConstr :: ModifyDBClusterResponse -> Constr

dataTypeOf :: ModifyDBClusterResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModifyDBClusterResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyDBClusterResponse)

gmapT :: (forall b. Data b => b -> b) -> ModifyDBClusterResponse -> ModifyDBClusterResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyDBClusterResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyDBClusterResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ModifyDBClusterResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyDBClusterResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyDBClusterResponse -> m ModifyDBClusterResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyDBClusterResponse -> m ModifyDBClusterResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyDBClusterResponse -> m ModifyDBClusterResponse

Read ModifyDBClusterResponse

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

readsPrec :: Int -> ReadS ModifyDBClusterResponse

readList :: ReadS [ModifyDBClusterResponse]

readPrec :: ReadPrec ModifyDBClusterResponse

readListPrec :: ReadPrec [ModifyDBClusterResponse]

Show ModifyDBClusterResponse

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

showsPrec :: Int -> ModifyDBClusterResponse -> ShowS

show :: ModifyDBClusterResponse -> String

showList :: [ModifyDBClusterResponse] -> ShowS

Generic ModifyDBClusterResponse

Defined in Network.AWS.RDS.ModifyDBCluster

Associated Types

type Rep ModifyDBClusterResponse :: Type -> Type

Methods

from :: ModifyDBClusterResponse -> Rep ModifyDBClusterResponse x

to :: Rep ModifyDBClusterResponse x -> ModifyDBClusterResponse

NFData ModifyDBClusterResponse

Defined in Network.AWS.RDS.ModifyDBCluster

Methods

rnf :: ModifyDBClusterResponse -> ()

type Rep ModifyDBClusterResponse

Defined in Network.AWS.RDS.ModifyDBCluster

type Rep ModifyDBClusterResponse = D1 (MetaData "ModifyDBClusterResponse" "Network.AWS.RDS.ModifyDBCluster" "amazonka-rds-1.6.1-GvYb6r2di9RGFKQcoJXq1A" False) (C1 (MetaCons "ModifyDBClusterResponse'" PrefixI True) (S1 (MetaSel (Just "_mdcrsDBCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 (MetaSel (Just "_mdcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

mdcrsDBCluster :: Lens' ModifyDBClusterResponse (Maybe DBCluster)

Undocumented member.

mdcrsResponseStatus :: Lens' ModifyDBClusterResponse Int

• - | The response status code.