Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class IncreaseReplicationFactorCommandProtected

Adds one or more nodes to a DAX cluster.

Example

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

import { DAXClient, IncreaseReplicationFactorCommand } from "@aws-sdk/client-dax"; // ES Modules import
// const { DAXClient, IncreaseReplicationFactorCommand } = require("@aws-sdk/client-dax"); // CommonJS import
const client = new DAXClient(config);
const input = { // IncreaseReplicationFactorRequest
ClusterName: "STRING_VALUE", // required
NewReplicationFactor: Number("int"), // required
AvailabilityZones: [ // AvailabilityZoneList
"STRING_VALUE",
],
};
const command = new IncreaseReplicationFactorCommand(input);
const response = await client.send(command);
// { // IncreaseReplicationFactorResponse
// Cluster: { // Cluster
// ClusterName: "STRING_VALUE",
// Description: "STRING_VALUE",
// ClusterArn: "STRING_VALUE",
// TotalNodes: Number("int"),
// ActiveNodes: Number("int"),
// NodeType: "STRING_VALUE",
// Status: "STRING_VALUE",
// ClusterDiscoveryEndpoint: { // Endpoint
// Address: "STRING_VALUE",
// Port: Number("int"),
// URL: "STRING_VALUE",
// },
// NodeIdsToRemove: [ // NodeIdentifierList
// "STRING_VALUE",
// ],
// Nodes: [ // NodeList
// { // Node
// NodeId: "STRING_VALUE",
// Endpoint: {
// Address: "STRING_VALUE",
// Port: Number("int"),
// URL: "STRING_VALUE",
// },
// NodeCreateTime: new Date("TIMESTAMP"),
// AvailabilityZone: "STRING_VALUE",
// NodeStatus: "STRING_VALUE",
// ParameterGroupStatus: "STRING_VALUE",
// },
// ],
// PreferredMaintenanceWindow: "STRING_VALUE",
// NotificationConfiguration: { // NotificationConfiguration
// TopicArn: "STRING_VALUE",
// TopicStatus: "STRING_VALUE",
// },
// SubnetGroup: "STRING_VALUE",
// SecurityGroups: [ // SecurityGroupMembershipList
// { // SecurityGroupMembership
// SecurityGroupIdentifier: "STRING_VALUE",
// Status: "STRING_VALUE",
// },
// ],
// IamRoleArn: "STRING_VALUE",
// ParameterGroup: { // ParameterGroupStatus
// ParameterGroupName: "STRING_VALUE",
// ParameterApplyStatus: "STRING_VALUE",
// NodeIdsToReboot: [
// "STRING_VALUE",
// ],
// },
// SSEDescription: { // SSEDescription
// Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED",
// },
// ClusterEndpointEncryptionType: "NONE" || "TLS",
// },
// };

Param

IncreaseReplicationFactorCommandInput

Returns

IncreaseReplicationFactorCommandOutput

See

Throws

ClusterNotFoundFault (client fault)

The requested cluster ID does not refer to an existing DAX cluster.

Throws

InsufficientClusterCapacityFault (client fault)

There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).

Throws

InvalidClusterStateFault (client fault)

The requested DAX cluster is not in the available state.

Throws

InvalidParameterCombinationException (client fault)

Two or more incompatible parameters were specified.

Throws

InvalidParameterValueException (client fault)

The value for a parameter is invalid.

Throws

InvalidVPCNetworkStateFault (client fault)

The VPC network is in an invalid state.

Throws

NodeQuotaForClusterExceededFault (client fault)

You have attempted to exceed the maximum number of nodes for a DAX cluster.

Throws

NodeQuotaForCustomerExceededFault (client fault)

You have attempted to exceed the maximum number of nodes for your AWS account.

Throws

ServiceLinkedRoleNotFoundFault (client fault)

The specified service linked role (SLR) was not found.

Throws

DAXServiceException

Base exception class for all service exceptions from DAX service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods