/AWS1/CL_DOE=>UPDATECLUSTER()
¶
About UpdateCluster¶
Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CLUSTERARN
TYPE /AWS1/DOESTRING
/AWS1/DOESTRING
¶
The ARN identifier of the elastic cluster.
Optional arguments:¶
IV_AUTHTYPE
TYPE /AWS1/DOEAUTH
/AWS1/DOEAUTH
¶
The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are
PLAIN_TEXT
orSECRET_ARN
.
IV_SHARDCAPACITY
TYPE /AWS1/DOEINTEGER
/AWS1/DOEINTEGER
¶
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
IV_SHARDCOUNT
TYPE /AWS1/DOEINTEGER
/AWS1/DOEINTEGER
¶
The number of shards assigned to the elastic cluster. Maximum is 32.
IT_VPCSECURITYGROUPIDS
TYPE /AWS1/CL_DOESTRINGLIST_W=>TT_STRINGLIST
TT_STRINGLIST
¶
A list of EC2 VPC security groups to associate with the elastic cluster.
IT_SUBNETIDS
TYPE /AWS1/CL_DOESTRINGLIST_W=>TT_STRINGLIST
TT_STRINGLIST
¶
The Amazon EC2 subnet IDs for the elastic cluster.
IV_ADMINUSERPASSWORD
TYPE /AWS1/DOEPASSWORD
/AWS1/DOEPASSWORD
¶
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.
IV_CLIENTTOKEN
TYPE /AWS1/DOESTRING
/AWS1/DOESTRING
¶
The client token for the elastic cluster.
IV_PREFERREDMAINTENANCEWIN00
TYPE /AWS1/DOESTRING
/AWS1/DOESTRING
¶
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:mi
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.
IV_BACKUPRETENTIONPERIOD
TYPE /AWS1/DOEINTEGER
/AWS1/DOEINTEGER
¶
The number of days for which automatic snapshots are retained.
IV_PREFERREDBACKUPWINDOW
TYPE /AWS1/DOESTRING
/AWS1/DOESTRING
¶
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
backupRetentionPeriod
.
IV_SHARDINSTANCECOUNT
TYPE /AWS1/DOEINTEGER
/AWS1/DOEINTEGER
¶
The number of replica instances applying to all shards in the elastic cluster. A
shardInstanceCount
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.