- 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.
UpdateKxClusterDatabasesCommand
Updates the databases mounted on a kdb cluster, which includes the changesetId
and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.
Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { FinspaceClient, UpdateKxClusterDatabasesCommand } from "@aws-sdk/client-finspace"; // ES Modules import
// const { FinspaceClient, UpdateKxClusterDatabasesCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
const client = new FinspaceClient(config);
const input = { // UpdateKxClusterDatabasesRequest
environmentId: "STRING_VALUE", // required
clusterName: "STRING_VALUE", // required
clientToken: "STRING_VALUE",
databases: [ // KxDatabaseConfigurations // required
{ // KxDatabaseConfiguration
databaseName: "STRING_VALUE", // required
cacheConfigurations: [ // KxDatabaseCacheConfigurations
{ // KxDatabaseCacheConfiguration
cacheType: "STRING_VALUE", // required
dbPaths: [ // DbPaths // required
"STRING_VALUE",
],
dataviewName: "STRING_VALUE",
},
],
changesetId: "STRING_VALUE",
dataviewName: "STRING_VALUE",
dataviewConfiguration: { // KxDataviewConfiguration
dataviewName: "STRING_VALUE",
dataviewVersionId: "STRING_VALUE",
changesetId: "STRING_VALUE",
segmentConfigurations: [ // KxDataviewSegmentConfigurationList
{ // KxDataviewSegmentConfiguration
dbPaths: [ // SegmentConfigurationDbPathList // required
"STRING_VALUE",
],
volumeName: "STRING_VALUE", // required
onDemand: true || false,
},
],
},
},
],
deploymentConfiguration: { // KxDeploymentConfiguration
deploymentStrategy: "NO_RESTART" || "ROLLING", // required
},
};
const command = new UpdateKxClusterDatabasesCommand(input);
const response = await client.send(command);
// {};
UpdateKxClusterDatabasesCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
clusterName Required | string | undefined | A unique name for the cluster that you want to modify. |
databases Required | KxDatabaseConfiguration[] | undefined | The structure of databases mounted on the cluster. |
environmentId Required | string | undefined | The unique identifier of a kdb environment. |
clientToken | string | undefined | A token that ensures idempotency. This token expires in 10 minutes. |
deploymentConfiguration | KxDeploymentConfiguration | undefined | The configuration that allows you to choose how you want to update the databases on a cluster. |
UpdateKxClusterDatabasesCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ConflictException | client | There was a conflict with this action, and it could not be completed. |
InternalServerException | server | The request processing has failed because of an unknown error, exception or failure. |
LimitExceededException | client | A service limit or quota is exceeded. |
ResourceNotFoundException | client | One or more resources can't be found. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy the constraints specified by an AWS service. |
FinspaceServiceException | Base exception class for all service exceptions from Finspace service. |