- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateClusterCommand
Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DocDBElasticClient, UpdateClusterCommand } from "@aws-sdk/client-docdb-elastic"; // ES Modules import
// const { DocDBElasticClient, UpdateClusterCommand } = require("@aws-sdk/client-docdb-elastic"); // CommonJS import
const client = new DocDBElasticClient(config);
const input = { // UpdateClusterInput
clusterArn: "STRING_VALUE", // required
authType: "STRING_VALUE",
shardCapacity: Number("int"),
shardCount: Number("int"),
vpcSecurityGroupIds: [ // StringList
"STRING_VALUE",
],
subnetIds: [
"STRING_VALUE",
],
adminUserPassword: "STRING_VALUE",
clientToken: "STRING_VALUE",
preferredMaintenanceWindow: "STRING_VALUE",
backupRetentionPeriod: Number("int"),
preferredBackupWindow: "STRING_VALUE",
shardInstanceCount: Number("int"),
};
const command = new UpdateClusterCommand(input);
const response = await client.send(command);
// { // UpdateClusterOutput
// cluster: { // Cluster
// clusterName: "STRING_VALUE", // required
// clusterArn: "STRING_VALUE", // required
// status: "STRING_VALUE", // required
// clusterEndpoint: "STRING_VALUE", // required
// createTime: "STRING_VALUE", // required
// adminUserName: "STRING_VALUE", // required
// authType: "STRING_VALUE", // required
// shardCapacity: Number("int"), // required
// shardCount: Number("int"), // required
// vpcSecurityGroupIds: [ // StringList // required
// "STRING_VALUE",
// ],
// subnetIds: [ // required
// "STRING_VALUE",
// ],
// preferredMaintenanceWindow: "STRING_VALUE", // required
// kmsKeyId: "STRING_VALUE", // required
// shards: [ // ShardList
// { // Shard
// shardId: "STRING_VALUE", // required
// createTime: "STRING_VALUE", // required
// status: "STRING_VALUE", // required
// },
// ],
// backupRetentionPeriod: Number("int"),
// preferredBackupWindow: "STRING_VALUE",
// shardInstanceCount: Number("int"),
// },
// };
UpdateClusterCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
clusterArn Required | string | undefined | The ARN identifier of the elastic cluster. |
adminUserPassword | string | undefined | The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (). Constraints: Must contain from 8 to 100 characters. |
authType | Auth | undefined | The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are |
backupRetentionPeriod | number | undefined | The number of days for which automatic snapshots are retained. |
clientToken | string | undefined | The client token for the elastic cluster. |
preferredBackupWindow | string | undefined | The daily time range during which automated backups are created if automated backups are enabled, as determined by the |
preferredMaintenanceWindow | string | undefined | The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. |
shardCapacity | number | undefined | The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64. |
shardCount | number | undefined | The number of shards assigned to the elastic cluster. Maximum is 32. |
shardInstanceCount | number | undefined | The number of replica instances applying to all shards in the elastic cluster. A |
subnetIds | string[] | undefined | The Amazon EC2 subnet IDs for the elastic cluster. |
vpcSecurityGroupIds | string[] | undefined | A list of EC2 VPC security groups to associate with the elastic cluster. |
UpdateClusterCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
cluster Required | Cluster | undefined | Returns information about the updated elastic cluster. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | An exception that occurs when there are not sufficient permissions to perform an action. |
ConflictException | client | There was an access conflict. |
InternalServerException | server | There was an internal server error. |
ResourceNotFoundException | client | The specified resource could not be located. |
ThrottlingException | client | ThrottlingException will be thrown when request was denied due to request throttling. |
ValidationException | client | A structure defining a validation exception. |
DocDBElasticServiceException | Base exception class for all service exceptions from DocDBElastic service. |