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.Neptune.ModifyDBCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modify a setting for a DB 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' {
- allowMajorVersionUpgrade :: Maybe Bool
- applyImmediately :: Maybe Bool
- backupRetentionPeriod :: Maybe Int
- cloudwatchLogsExportConfiguration :: Maybe CloudwatchLogsExportConfiguration
- copyTagsToSnapshot :: Maybe Bool
- dbClusterParameterGroupName :: Maybe Text
- dbInstanceParameterGroupName :: Maybe Text
- deletionProtection :: Maybe Bool
- enableIAMDatabaseAuthentication :: Maybe Bool
- engineVersion :: Maybe Text
- masterUserPassword :: Maybe Text
- newDBClusterIdentifier' :: Maybe Text
- optionGroupName :: Maybe Text
- port :: Maybe Int
- preferredBackupWindow :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- serverlessV2ScalingConfiguration :: Maybe ServerlessV2ScalingConfiguration
- vpcSecurityGroupIds :: Maybe [Text]
- dbClusterIdentifier :: Text
}
newModifyDBCluster :: Text -> ModifyDBCluster
modifyDBCluster_allowMajorVersionUpgrade :: Lens' ModifyDBCluster (Maybe Bool)
modifyDBCluster_applyImmediately :: Lens' ModifyDBCluster (Maybe Bool)
modifyDBCluster_backupRetentionPeriod :: Lens' ModifyDBCluster (Maybe Int)
modifyDBCluster_cloudwatchLogsExportConfiguration :: Lens' ModifyDBCluster (Maybe CloudwatchLogsExportConfiguration)
modifyDBCluster_copyTagsToSnapshot :: Lens' ModifyDBCluster (Maybe Bool)
modifyDBCluster_dbClusterParameterGroupName :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_dbInstanceParameterGroupName :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_deletionProtection :: Lens' ModifyDBCluster (Maybe Bool)
modifyDBCluster_enableIAMDatabaseAuthentication :: Lens' ModifyDBCluster (Maybe Bool)
modifyDBCluster_engineVersion :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_masterUserPassword :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_newDBClusterIdentifier :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_optionGroupName :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_port :: Lens' ModifyDBCluster (Maybe Int)
modifyDBCluster_preferredBackupWindow :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_preferredMaintenanceWindow :: Lens' ModifyDBCluster (Maybe Text)
modifyDBCluster_serverlessV2ScalingConfiguration :: Lens' ModifyDBCluster (Maybe ServerlessV2ScalingConfiguration)
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 #

See: newModifyDBCluster smart constructor.

Constructors

ModifyDBCluster'

Fields

allowMajorVersionUpgrade :: Maybe Bool
A value that indicates whether upgrades between different major versions are allowed.
Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster's current version.
applyImmediately :: 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 NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier 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 CloudWatch Logs for a specific DB cluster.
copyTagsToSnapshot :: Maybe Bool
/If set to true, tags are copied to any snapshot of the DB cluster that is created./
dbClusterParameterGroupName :: Maybe Text
The name of the DB cluster parameter group to use for the DB cluster.
dbInstanceParameterGroupName :: Maybe Text
The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance window but instead are applied immediately.
Default: The existing name setting
Constraints:
- The DB parameter group must be in the same DB parameter group family as the target DB cluster version.
- The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.
deletionProtection :: Maybe Bool
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
enableIAMDatabaseAuthentication :: Maybe Bool
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
engineVersion :: 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 Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.
masterUserPassword :: Maybe Text
Not supported by Neptune.
newDBClusterIdentifier' :: 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
optionGroupName :: Maybe Text
Not supported by Neptune.
port :: 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.
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 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 Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
serverlessV2ScalingConfiguration :: Maybe ServerlessV2ScalingConfiguration
vpcSecurityGroupIds :: Maybe [Text]
A list of VPC security groups that the DB cluster will belong to.
dbClusterIdentifier :: 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.

Instances

Instances details

ToHeaders ModifyDBCluster Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster Methods toHeaders :: ModifyDBCluster -> [Header] #
ToPath ModifyDBCluster Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster Methods toPath :: ModifyDBCluster -> ByteString #
ToQuery ModifyDBCluster Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster Methods toQuery :: ModifyDBCluster -> QueryString #
AWSRequest ModifyDBCluster Source #
Instance details Defined in Amazonka.Neptune.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.Neptune.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.Neptune.ModifyDBCluster Methods readsPrec :: Int -> ReadS ModifyDBCluster # readList :: ReadS [ModifyDBCluster] # readPrec :: ReadPrec ModifyDBCluster # readListPrec :: ReadPrec [ModifyDBCluster] #
Show ModifyDBCluster Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster Methods showsPrec :: Int -> ModifyDBCluster -> ShowS # show :: ModifyDBCluster -> String # showList :: [ModifyDBCluster] -> ShowS #
NFData ModifyDBCluster Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster Methods rnf :: ModifyDBCluster -> () #
Eq ModifyDBCluster Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster Methods (==) :: ModifyDBCluster -> ModifyDBCluster -> Bool # (/=) :: ModifyDBCluster -> ModifyDBCluster -> Bool #
Hashable ModifyDBCluster Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster Methods hashWithSalt :: Int -> ModifyDBCluster -> Int # hash :: ModifyDBCluster -> Int #
type AWSResponse ModifyDBCluster Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster type AWSResponse ModifyDBCluster = ModifyDBClusterResponse
type Rep ModifyDBCluster Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster type Rep ModifyDBCluster = D1 ('MetaData "ModifyDBCluster" "Amazonka.Neptune.ModifyDBCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "ModifyDBCluster'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "allowMajorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: 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 "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dbInstanceParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "enableIAMDatabaseAuthentication") '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 "optionGroupName") '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 "serverlessV2ScalingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerlessV2ScalingConfiguration)) :: (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:allowMajorVersionUpgrade:ModifyDBCluster', modifyDBCluster_allowMajorVersionUpgrade - A value that indicates whether upgrades between different major versions are allowed.

Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster's current version.

$sel:applyImmediately:ModifyDBCluster', modifyDBCluster_applyImmediately - 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 NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier 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 CloudWatch Logs for a specific DB cluster.

ModifyDBCluster, modifyDBCluster_copyTagsToSnapshot - /If set to true, tags are copied to any snapshot of the DB cluster that is created./

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

$sel:dbInstanceParameterGroupName:ModifyDBCluster', modifyDBCluster_dbInstanceParameterGroupName - The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as the target DB cluster version.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

ModifyDBCluster, modifyDBCluster_deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

$sel:enableIAMDatabaseAuthentication:ModifyDBCluster', modifyDBCluster_enableIAMDatabaseAuthentication - True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

ModifyDBCluster, modifyDBCluster_engineVersion - 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 Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.

ModifyDBCluster, modifyDBCluster_masterUserPassword - Not supported by Neptune.

$sel:newDBClusterIdentifier':ModifyDBCluster', modifyDBCluster_newDBClusterIdentifier - 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

ModifyDBCluster, modifyDBCluster_optionGroupName - Not supported by Neptune.

ModifyDBCluster, modifyDBCluster_port - 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.

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 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 Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

ModifyDBCluster, modifyDBCluster_serverlessV2ScalingConfiguration - Undocumented member.

$sel:vpcSecurityGroupIds:ModifyDBCluster', modifyDBCluster_vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.

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

Constraints:

Must match the identifier of an existing DBCluster.

Request Lenses

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

A value that indicates whether upgrades between different major versions are allowed.

Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster's current version.

modifyDBCluster_applyImmediately :: 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 NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier 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 CloudWatch Logs for a specific DB cluster.

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

/If set to true, tags are copied to any snapshot of the DB cluster that is created./

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

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

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

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as the target DB cluster version.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

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

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

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

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

Default: false

modifyDBCluster_engineVersion :: 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 Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.

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

Not supported by Neptune.

modifyDBCluster_newDBClusterIdentifier :: 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

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

Not supported by Neptune.

modifyDBCluster_port :: 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.

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 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 Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

modifyDBCluster_serverlessV2ScalingConfiguration :: Lens' ModifyDBCluster (Maybe ServerlessV2ScalingConfiguration) Source #

Undocumented member.

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

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

modifyDBCluster_dbClusterIdentifier :: 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

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.Neptune.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.Neptune.ModifyDBCluster Methods readsPrec :: Int -> ReadS ModifyDBClusterResponse # readList :: ReadS [ModifyDBClusterResponse] # readPrec :: ReadPrec ModifyDBClusterResponse # readListPrec :: ReadPrec [ModifyDBClusterResponse] #
Show ModifyDBClusterResponse Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster Methods showsPrec :: Int -> ModifyDBClusterResponse -> ShowS # show :: ModifyDBClusterResponse -> String # showList :: [ModifyDBClusterResponse] -> ShowS #
NFData ModifyDBClusterResponse Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster Methods rnf :: ModifyDBClusterResponse -> () #
Eq ModifyDBClusterResponse Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster Methods (==) :: ModifyDBClusterResponse -> ModifyDBClusterResponse -> Bool # (/=) :: ModifyDBClusterResponse -> ModifyDBClusterResponse -> Bool #
type Rep ModifyDBClusterResponse Source #
Instance details Defined in Amazonka.Neptune.ModifyDBCluster type Rep ModifyDBClusterResponse = D1 ('MetaData "ModifyDBClusterResponse" "Amazonka.Neptune.ModifyDBCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" '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.