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 |
Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.
Synopsis
- data ModifyGlobalCluster = ModifyGlobalCluster' {}
- newModifyGlobalCluster :: Text -> ModifyGlobalCluster
- modifyGlobalCluster_allowMajorVersionUpgrade :: Lens' ModifyGlobalCluster (Maybe Bool)
- modifyGlobalCluster_deletionProtection :: Lens' ModifyGlobalCluster (Maybe Bool)
- modifyGlobalCluster_engineVersion :: Lens' ModifyGlobalCluster (Maybe Text)
- modifyGlobalCluster_newGlobalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text)
- modifyGlobalCluster_globalClusterIdentifier :: Lens' ModifyGlobalCluster Text
- data ModifyGlobalClusterResponse = ModifyGlobalClusterResponse' {}
- newModifyGlobalClusterResponse :: Int -> ModifyGlobalClusterResponse
- modifyGlobalClusterResponse_globalCluster :: Lens' ModifyGlobalClusterResponse (Maybe GlobalCluster)
- modifyGlobalClusterResponse_httpStatus :: Lens' ModifyGlobalClusterResponse Int
Creating a Request
data ModifyGlobalCluster Source #
See: newModifyGlobalCluster
smart constructor.
ModifyGlobalCluster' | |
|
Instances
newModifyGlobalCluster Source #
Create a value of ModifyGlobalCluster
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:ModifyGlobalCluster'
, modifyGlobalCluster_allowMajorVersionUpgrade
- A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades if you specify a
value for the EngineVersion
parameter that is a different major
version than the DB cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.
ModifyGlobalCluster
, modifyGlobalCluster_deletionProtection
- Indicates whether the global database has deletion protection enabled.
The global database cannot be deleted when deletion protection is
enabled.
ModifyGlobalCluster
, modifyGlobalCluster_engineVersion
- The version number of the database engine to which you want to upgrade.
Changing this parameter will result in an outage. The change is applied
during the next maintenance window unless ApplyImmediately
is enabled.
To list all of the available Neptune engine versions, use the following command:
$sel:newGlobalClusterIdentifier':ModifyGlobalCluster'
, modifyGlobalCluster_newGlobalClusterIdentifier
- A new cluster identifier to assign to the global database. 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.
- Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
ModifyGlobalCluster
, modifyGlobalCluster_globalClusterIdentifier
- The DB cluster identifier for the global cluster being modified. This
parameter is not case-sensitive.
Constraints: Must match the identifier of an existing global database cluster.
Request Lenses
modifyGlobalCluster_allowMajorVersionUpgrade :: Lens' ModifyGlobalCluster (Maybe Bool) Source #
A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades if you specify a
value for the EngineVersion
parameter that is a different major
version than the DB cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.
modifyGlobalCluster_deletionProtection :: Lens' ModifyGlobalCluster (Maybe Bool) Source #
Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled.
modifyGlobalCluster_engineVersion :: Lens' ModifyGlobalCluster (Maybe Text) Source #
The version number of the database engine to which you want to upgrade.
Changing this parameter will result in an outage. The change is applied
during the next maintenance window unless ApplyImmediately
is enabled.
To list all of the available Neptune engine versions, use the following command:
modifyGlobalCluster_newGlobalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text) Source #
A new cluster identifier to assign to the global database. 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.
- Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
modifyGlobalCluster_globalClusterIdentifier :: Lens' ModifyGlobalCluster Text Source #
The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.
Constraints: Must match the identifier of an existing global database cluster.
Destructuring the Response
data ModifyGlobalClusterResponse Source #
See: newModifyGlobalClusterResponse
smart constructor.
ModifyGlobalClusterResponse' | |
|
Instances
newModifyGlobalClusterResponse Source #
Create a value of ModifyGlobalClusterResponse
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:globalCluster:ModifyGlobalClusterResponse'
, modifyGlobalClusterResponse_globalCluster
- Undocumented member.
$sel:httpStatus:ModifyGlobalClusterResponse'
, modifyGlobalClusterResponse_httpStatus
- The response's http status code.
Response Lenses
modifyGlobalClusterResponse_globalCluster :: Lens' ModifyGlobalClusterResponse (Maybe GlobalCluster) Source #
Undocumented member.
modifyGlobalClusterResponse_httpStatus :: Lens' ModifyGlobalClusterResponse Int Source #
The response's http status code.