Copyright	(c) 2013-2021 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

Amazonka.RDS.ModifyGlobalCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modify a setting for an Amazon Aurora global 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 What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Synopsis

data ModifyGlobalCluster = ModifyGlobalCluster' {
- engineVersion :: Maybe Text
- deletionProtection :: Maybe Bool
- globalClusterIdentifier :: Maybe Text
- allowMajorVersionUpgrade :: Maybe Bool
- newGlobalClusterIdentifier' :: Maybe Text
}
newModifyGlobalCluster :: ModifyGlobalCluster
modifyGlobalCluster_engineVersion :: Lens' ModifyGlobalCluster (Maybe Text)
modifyGlobalCluster_deletionProtection :: Lens' ModifyGlobalCluster (Maybe Bool)
modifyGlobalCluster_globalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text)
modifyGlobalCluster_allowMajorVersionUpgrade :: Lens' ModifyGlobalCluster (Maybe Bool)
modifyGlobalCluster_newGlobalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text)
data ModifyGlobalClusterResponse = ModifyGlobalClusterResponse' {
- globalCluster :: Maybe GlobalCluster
- httpStatus :: Int
}
newModifyGlobalClusterResponse :: Int -> ModifyGlobalClusterResponse
modifyGlobalClusterResponse_globalCluster :: Lens' ModifyGlobalClusterResponse (Maybe GlobalCluster)
modifyGlobalClusterResponse_httpStatus :: Lens' ModifyGlobalClusterResponse Int

Creating a Request

data ModifyGlobalCluster Source #

See: newModifyGlobalCluster smart constructor.

Constructors

ModifyGlobalCluster'

Fields

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 ApplyImmediately is enabled.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
```
aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
```
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
```
aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
```
To list all of the available engine versions for aurora-postgresql, use the following command:
```
aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
```
deletionProtection :: Maybe Bool
Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.
globalClusterIdentifier :: Maybe Text
The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing global database cluster.
allowMajorVersionUpgrade :: Maybe Bool
A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying 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. Apply any custom parameter groups after completing the upgrade.
newGlobalClusterIdentifier' :: Maybe Text
The new cluster identifier for the global database cluster when modifying a global database 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
- Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2

Instances

Instances details

Eq ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods (==) :: ModifyGlobalCluster -> ModifyGlobalCluster -> Bool # (/=) :: ModifyGlobalCluster -> ModifyGlobalCluster -> Bool #
Read ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods readsPrec :: Int -> ReadS ModifyGlobalCluster # readList :: ReadS [ModifyGlobalCluster] # readPrec :: ReadPrec ModifyGlobalCluster # readListPrec :: ReadPrec [ModifyGlobalCluster] #
Show ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods showsPrec :: Int -> ModifyGlobalCluster -> ShowS # show :: ModifyGlobalCluster -> String # showList :: [ModifyGlobalCluster] -> ShowS #
Generic ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Associated Types type Rep ModifyGlobalCluster :: Type -> Type # Methods from :: ModifyGlobalCluster -> Rep ModifyGlobalCluster x # to :: Rep ModifyGlobalCluster x -> ModifyGlobalCluster #
NFData ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods rnf :: ModifyGlobalCluster -> () #
Hashable ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods hashWithSalt :: Int -> ModifyGlobalCluster -> Int # hash :: ModifyGlobalCluster -> Int #
AWSRequest ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Associated Types type AWSResponse ModifyGlobalCluster # Methods request :: ModifyGlobalCluster -> Request ModifyGlobalCluster # response :: MonadResource m => Logger -> Service -> Proxy ModifyGlobalCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyGlobalCluster))) #
ToHeaders ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods toHeaders :: ModifyGlobalCluster -> [Header] #
ToPath ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods toPath :: ModifyGlobalCluster -> ByteString #
ToQuery ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods toQuery :: ModifyGlobalCluster -> QueryString #
type Rep ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster type Rep ModifyGlobalCluster = D1 ('MetaData "ModifyGlobalCluster" "Amazonka.RDS.ModifyGlobalCluster" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "ModifyGlobalCluster'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "allowMajorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "newGlobalClusterIdentifier'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse ModifyGlobalCluster Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster type AWSResponse ModifyGlobalCluster = ModifyGlobalClusterResponse

newModifyGlobalCluster :: ModifyGlobalCluster 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:engineVersion:ModifyGlobalCluster', modifyGlobalCluster_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 ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

$sel:deletionProtection:ModifyGlobalCluster', modifyGlobalCluster_deletionProtection - Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.

$sel:globalClusterIdentifier:ModifyGlobalCluster', modifyGlobalCluster_globalClusterIdentifier - The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing global database cluster.

$sel:allowMajorVersionUpgrade:ModifyGlobalCluster', modifyGlobalCluster_allowMajorVersionUpgrade - A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying 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. Apply any custom parameter groups after completing the upgrade.

$sel:newGlobalClusterIdentifier':ModifyGlobalCluster', modifyGlobalCluster_newGlobalClusterIdentifier - The new cluster identifier for the global database cluster when modifying a global database 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
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Request Lenses

modifyGlobalCluster_engineVersion :: Lens' ModifyGlobalCluster (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 ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

modifyGlobalCluster_deletionProtection :: Lens' ModifyGlobalCluster (Maybe Bool) Source #

Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.

modifyGlobalCluster_globalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text) Source #

The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing global database cluster.

modifyGlobalCluster_allowMajorVersionUpgrade :: Lens' ModifyGlobalCluster (Maybe Bool) Source #

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying 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. Apply any custom parameter groups after completing the upgrade.

modifyGlobalCluster_newGlobalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text) Source #

The new cluster identifier for the global database cluster when modifying a global database 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
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Destructuring the Response

data ModifyGlobalClusterResponse Source #

See: newModifyGlobalClusterResponse smart constructor.

Constructors

ModifyGlobalClusterResponse'
Fields globalCluster :: Maybe GlobalCluster httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ModifyGlobalClusterResponse Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods (==) :: ModifyGlobalClusterResponse -> ModifyGlobalClusterResponse -> Bool # (/=) :: ModifyGlobalClusterResponse -> ModifyGlobalClusterResponse -> Bool #
Read ModifyGlobalClusterResponse Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods readsPrec :: Int -> ReadS ModifyGlobalClusterResponse # readList :: ReadS [ModifyGlobalClusterResponse] # readPrec :: ReadPrec ModifyGlobalClusterResponse # readListPrec :: ReadPrec [ModifyGlobalClusterResponse] #
Show ModifyGlobalClusterResponse Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods showsPrec :: Int -> ModifyGlobalClusterResponse -> ShowS # show :: ModifyGlobalClusterResponse -> String # showList :: [ModifyGlobalClusterResponse] -> ShowS #
Generic ModifyGlobalClusterResponse Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Associated Types type Rep ModifyGlobalClusterResponse :: Type -> Type # Methods from :: ModifyGlobalClusterResponse -> Rep ModifyGlobalClusterResponse x # to :: Rep ModifyGlobalClusterResponse x -> ModifyGlobalClusterResponse #
NFData ModifyGlobalClusterResponse Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster Methods rnf :: ModifyGlobalClusterResponse -> () #
type Rep ModifyGlobalClusterResponse Source #
Instance details Defined in Amazonka.RDS.ModifyGlobalCluster type Rep ModifyGlobalClusterResponse = D1 ('MetaData "ModifyGlobalClusterResponse" "Amazonka.RDS.ModifyGlobalCluster" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "ModifyGlobalClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyGlobalClusterResponse Source #

Arguments

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

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.