IncreaseNodeGroupsInGlobalReplicationGroupCommand

Suggest an Edit

Increase the number of node groups in the Global datastore

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ElastiCacheClient, IncreaseNodeGroupsInGlobalReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import
// const { ElastiCacheClient, IncreaseNodeGroupsInGlobalReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import
const client = new ElastiCacheClient(config);
const input = { // IncreaseNodeGroupsInGlobalReplicationGroupMessage
  GlobalReplicationGroupId: "STRING_VALUE", // required
  NodeGroupCount: Number("int"), // required
  RegionalConfigurations: [ // RegionalConfigurationList
    { // RegionalConfiguration
      ReplicationGroupId: "STRING_VALUE", // required
      ReplicationGroupRegion: "STRING_VALUE", // required
      ReshardingConfiguration: [ // ReshardingConfigurationList // required
        { // ReshardingConfiguration
          NodeGroupId: "STRING_VALUE",
          PreferredAvailabilityZones: [ // AvailabilityZonesList
            "STRING_VALUE",
          ],
        },
      ],
    },
  ],
  ApplyImmediately: true || false, // required
};
const command = new IncreaseNodeGroupsInGlobalReplicationGroupCommand(input);
const response = await client.send(command);
// { // IncreaseNodeGroupsInGlobalReplicationGroupResult
//   GlobalReplicationGroup: { // GlobalReplicationGroup
//     GlobalReplicationGroupId: "STRING_VALUE",
//     GlobalReplicationGroupDescription: "STRING_VALUE",
//     Status: "STRING_VALUE",
//     CacheNodeType: "STRING_VALUE",
//     Engine: "STRING_VALUE",
//     EngineVersion: "STRING_VALUE",
//     Members: [ // GlobalReplicationGroupMemberList
//       { // GlobalReplicationGroupMember
//         ReplicationGroupId: "STRING_VALUE",
//         ReplicationGroupRegion: "STRING_VALUE",
//         Role: "STRING_VALUE",
//         AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling",
//         Status: "STRING_VALUE",
//       },
//     ],
//     ClusterEnabled: true || false,
//     GlobalNodeGroups: [ // GlobalNodeGroupList
//       { // GlobalNodeGroup
//         GlobalNodeGroupId: "STRING_VALUE",
//         Slots: "STRING_VALUE",
//       },
//     ],
//     AuthTokenEnabled: true || false,
//     TransitEncryptionEnabled: true || false,
//     AtRestEncryptionEnabled: true || false,
//     ARN: "STRING_VALUE",
//   },
// };

IncreaseNodeGroupsInGlobalReplicationGroupCommand Input

See IncreaseNodeGroupsInGlobalReplicationGroupCommandInput for more details

Parameter
Type
Description
ApplyImmediately
Required
boolean | undefined

Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.

GlobalReplicationGroupId
Required
string | undefined

The name of the Global datastore

NodeGroupCount
Required
number | undefined

Total number of node groups you want

RegionalConfigurations
RegionalConfiguration[] | undefined

Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore

IncreaseNodeGroupsInGlobalReplicationGroupCommand Output

See IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
GlobalReplicationGroup
GlobalReplicationGroup | undefined

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

  • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

Throws

Name
Fault
Details
GlobalReplicationGroupNotFoundFault
client

The Global datastore does not exist

InvalidGlobalReplicationGroupStateFault
client

The Global datastore is not available or in primary-only state.

InvalidParameterValueException
client

The value for a parameter is invalid.

ElastiCacheServiceException
Base exception class for all service exceptions from ElastiCache service.