Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14198183.8 KB

Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window

put/cluster/{clusterArn}

Path parameters

clusterArnstring required

The ARN identifier of the elastic cluster.

Request body

adminUserPasswordstring password
<p>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 (@).</p> <p> <i>Constraints</i>: Must contain from 8 to 100 characters.</p>
authType'PLAIN_TEXT' | 'SECRET_ARN'

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are <code>PLAIN_TEXT</code> or <code>SECRET_ARN</code>.

backupRetentionPeriodinteger

The number of days for which automatic snapshots are retained.

clientTokenstring

The client token for the elastic cluster.

preferredBackupWindowstring

The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>backupRetentionPeriod</code>.

preferredMaintenanceWindowstring
<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p> <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p> <i>Default</i>: 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.</p> <p> <i>Valid days</i>: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p> <i>Constraints</i>: Minimum 30-minute window.</p>
shardCapacityinteger

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

shardCountinteger

The number of shards assigned to the elastic cluster. Maximum is 32.

shardInstanceCountinteger

The number of replica instances applying to all shards in the elastic cluster. A <code>shardInstanceCount</code> value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

subnetIdsString[]

The Amazon EC2 subnet IDs for the elastic cluster.

vpcSecurityGroupIdsString[]

A list of EC2 VPC security groups to associate with the elastic cluster.

Response

Success