AWS.Finspace — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createEnvironment(params = {}, callback) ⇒ AWS.Request

Create a new FinSpace environment.

createKxChangeset(params = {}, callback) ⇒ AWS.Request

Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.

createKxCluster(params = {}, callback) ⇒ AWS.Request

Creates a new kdb cluster.

createKxDatabase(params = {}, callback) ⇒ AWS.Request

Creates a new kdb database in the environment.

createKxDataview(params = {}, callback) ⇒ AWS.Request

Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.

createKxEnvironment(params = {}, callback) ⇒ AWS.Request

Creates a managed kdb environment for the account.

createKxScalingGroup(params = {}, callback) ⇒ AWS.Request

Creates a new scaling group.

createKxUser(params = {}, callback) ⇒ AWS.Request

Creates a user in FinSpace kdb environment with an associated IAM role.

createKxVolume(params = {}, callback) ⇒ AWS.Request

Creates a new volume with a specific amount of throughput and storage capacity.

deleteEnvironment(params = {}, callback) ⇒ AWS.Request

Delete an FinSpace environment.

deleteKxCluster(params = {}, callback) ⇒ AWS.Request

deleteKxClusterNode(params = {}, callback) ⇒ AWS.Request

Deletes the specified nodes from a cluster.

deleteKxDatabase(params = {}, callback) ⇒ AWS.Request

Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.

deleteKxDataview(params = {}, callback) ⇒ AWS.Request

Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.

deleteKxEnvironment(params = {}, callback) ⇒ AWS.Request

Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.

deleteKxScalingGroup(params = {}, callback) ⇒ AWS.Request

Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.

deleteKxUser(params = {}, callback) ⇒ AWS.Request

Deletes a user in the specified kdb environment.

deleteKxVolume(params = {}, callback) ⇒ AWS.Request

Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.

getEnvironment(params = {}, callback) ⇒ AWS.Request

Returns the FinSpace environment object.

getKxChangeset(params = {}, callback) ⇒ AWS.Request

Returns information about a kdb changeset.

getKxCluster(params = {}, callback) ⇒ AWS.Request

Retrieves information about a kdb cluster.

getKxConnectionString(params = {}, callback) ⇒ AWS.Request

Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.

getKxDatabase(params = {}, callback) ⇒ AWS.Request

Returns database information for the specified environment ID.

getKxDataview(params = {}, callback) ⇒ AWS.Request

Retrieves details of the dataview.

getKxEnvironment(params = {}, callback) ⇒ AWS.Request

Retrieves all the information for the specified kdb environment.

getKxScalingGroup(params = {}, callback) ⇒ AWS.Request

Retrieves details of a scaling group.

getKxUser(params = {}, callback) ⇒ AWS.Request

Retrieves information about the specified kdb user.

getKxVolume(params = {}, callback) ⇒ AWS.Request

Retrieves the information about the volume.

listEnvironments(params = {}, callback) ⇒ AWS.Request

A list of all of your FinSpace environments.

listKxChangesets(params = {}, callback) ⇒ AWS.Request

Returns a list of all the changesets for a database.

listKxClusterNodes(params = {}, callback) ⇒ AWS.Request

Lists all the nodes in a kdb cluster.

listKxClusters(params = {}, callback) ⇒ AWS.Request

Returns a list of clusters.

listKxDatabases(params = {}, callback) ⇒ AWS.Request

Returns a list of all the databases in the kdb environment.

listKxDataviews(params = {}, callback) ⇒ AWS.Request

Returns a list of all the dataviews in the database.

listKxEnvironments(params = {}, callback) ⇒ AWS.Request

Returns a list of kdb environments created in an account.

listKxScalingGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of scaling groups in a kdb environment.

listKxUsers(params = {}, callback) ⇒ AWS.Request

Lists all the users in a kdb environment.

listKxVolumes(params = {}, callback) ⇒ AWS.Request

Lists all the volumes in a kdb environment.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

A list of all tags for a resource.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds metadata tags to a FinSpace resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes metadata tags from a FinSpace resource.

updateEnvironment(params = {}, callback) ⇒ AWS.Request

Update your FinSpace environment.

updateKxClusterCodeConfiguration(params = {}, callback) ⇒ AWS.Request

Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.

updateKxClusterDatabases(params = {}, callback) ⇒ AWS.Request

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.

updateKxDatabase(params = {}, callback) ⇒ AWS.Request

Updates information for the given kdb database.

updateKxDataview(params = {}, callback) ⇒ AWS.Request

Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations

updateKxEnvironment(params = {}, callback) ⇒ AWS.Request

Updates information for the given kdb environment.

updateKxEnvironmentNetwork(params = {}, callback) ⇒ AWS.Request

Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.

Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.

updateKxUser(params = {}, callback) ⇒ AWS.Request

Updates the user details. You can only update the IAM role associated with a user.

updateKxVolume(params = {}, callback) ⇒ AWS.Request

Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.