The AWS SDK for JavaScript v2 has reached end-of-support.
We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

Class: AWS.Finspace

Inherits:
AWS.Service show all
Identifier:
finspace
API Version:
2021-03-12
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The FinSpace management service provides the APIs for managing FinSpace environments.

Sending a Request Using Finspace

var finspace = new AWS.Finspace();
finspace.createEnvironment(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Finspace object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var finspace = new AWS.Finspace({apiVersion: '2021-03-12'});

You can also set the API version globally in AWS.config.apiVersions using the finspace service identifier:

AWS.config.apiVersions = {
  finspace: '2021-03-12',
  // other service API versions
};

var finspace = new AWS.Finspace();

Version:

  • 2021-03-12

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Finspace(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Finspace object

var finspace = new AWS.Finspace({apiVersion: '2021-03-12'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Finspace.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Finspace.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Finspace.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Create a new FinSpace environment.

Service Reference:

Examples:

Calling the createEnvironment operation

var params = {
  name: 'STRING_VALUE', /* required */
  dataBundles: [
    'STRING_VALUE',
    /* more items */
  ],
  description: 'STRING_VALUE',
  federationMode: FEDERATED | LOCAL,
  federationParameters: {
    applicationCallBackURL: 'STRING_VALUE',
    attributeMap: {
      '<FederationAttributeKey>': 'STRING_VALUE',
      /* '<FederationAttributeKey>': ... */
    },
    federationProviderName: 'STRING_VALUE',
    federationURN: 'STRING_VALUE',
    samlMetadataDocument: 'STRING_VALUE',
    samlMetadataURL: 'STRING_VALUE'
  },
  kmsKeyId: 'STRING_VALUE',
  superuserParameters: {
    emailAddress: 'STRING_VALUE', /* required */
    firstName: 'STRING_VALUE', /* required */
    lastName: 'STRING_VALUE' /* required */
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
finspace.createEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • name — (String)

      The name of the FinSpace environment to be created.

    • description — (String)

      The description of the FinSpace environment to be created.

    • kmsKeyId — (String)

      The KMS key id to encrypt your data in the FinSpace environment.

    • tags — (map<String>)

      Add tags to your FinSpace environment.

    • federationMode — (String)

      Authentication mode for the environment.

      • FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

      • LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

      Possible values include:
      • "FEDERATED"
      • "LOCAL"
    • federationParameters — (map)

      Configuration information when authentication mode is FEDERATED.

      • samlMetadataDocument — (String)

        SAML 2.0 Metadata document from identity provider (IdP).

      • samlMetadataURL — (String)

        Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

      • applicationCallBackURL — (String)

        The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

      • federationURN — (String)

        The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

      • federationProviderName — (String)

        Name of the identity provider (IdP).

      • attributeMap — (map<String>)

        SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

    • superuserParameters — (map)

      Configuration information for the superuser.

      • emailAddress — required — (String)

        The email address of the superuser.

      • firstName — required — (String)

        The first name of the superuser.

      • lastName — required — (String)

        The last name of the superuser.

    • dataBundles — (Array<String>)

      The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

      • arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.

      • arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentId — (String)

        The unique identifier for FinSpace environment that you created.

      • environmentArn — (String)

        The Amazon Resource Name (ARN) of the FinSpace environment that you created.

      • environmentUrl — (String)

        The sign-in URL for the web application of the FinSpace environment you created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the createKxChangeset operation

var params = {
  changeRequests: [ /* required */
    {
      changeType: PUT | DELETE, /* required */
      dbPath: 'STRING_VALUE', /* required */
      s3Path: 'STRING_VALUE'
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE', /* required */
  databaseName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE' /* required */
};
finspace.createKxChangeset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • environmentId — (String)

      A unique identifier of the kdb environment.

    • databaseName — (String)

      The name of the kdb database.

    • changeRequests — (Array<map>)

      A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. A changeType can have the following values:

      • PUT – Adds or updates files in a database.

      • DELETE – Deletes files in a database.

      All the change requests require a mandatory dbPath attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The s3Path attribute defines the s3 source file path and is required for a PUT change type. The s3path must end with a trailing / if it is a directory and must end without a trailing / if it is a file.

      Here are few examples of how you can use the change request object:

      1. This request adds a single sym file at database root location.

        { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}

      2. This request adds files in the given s3Path under the 2020.01.02 partition of the database.

        { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}

      3. This request adds files in the given s3Path under the taq table partition of the database.

        [ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}]

      4. This request deletes the 2020.01.02 partition of the database.

        [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]

      5. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it.

        [ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}]

      • changeType — required — (String)

        Defines the type of change request. A changeType can have the following values:

        • PUT – Adds or updates files in a database.

        • DELETE – Deletes files in a database.

        Possible values include:
        • "PUT"
        • "DELETE"
      • s3Path — (String)

        Defines the S3 path of the source file that is required to add or update files in a database.

      • dbPath — required — (String)

        Defines the path within the database directory.

    • clientToken — (String)

      A token that ensures idempotency. This token expires in 10 minutes.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • changesetId — (String)

        A unique identifier for the changeset.

      • databaseName — (String)

        The name of the kdb database.

      • environmentId — (String)

        A unique identifier for the kdb environment.

      • changeRequests — (Array<map>)

        A list of change requests.

        • changeType — required — (String)

          Defines the type of change request. A changeType can have the following values:

          • PUT – Adds or updates files in a database.

          • DELETE – Deletes files in a database.

          Possible values include:
          • "PUT"
          • "DELETE"
        • s3Path — (String)

          Defines the S3 path of the source file that is required to add or update files in a database.

        • dbPath — required — (String)

          Defines the path within the database directory.

      • createdTimestamp — (Date)

        The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • lastModifiedTimestamp — (Date)

        The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • status — (String)

        Status of the changeset creation process.

        • Pending – Changeset creation is pending.

        • Processing – Changeset creation is running.

        • Failed – Changeset creation has failed.

        • Complete – Changeset creation has succeeded.

        Possible values include:
        • "PENDING"
        • "PROCESSING"
        • "FAILED"
        • "COMPLETED"
      • errorInfo — (map)

        The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.

        • errorMessage — (String)

          Specifies the error message that appears if a flow fails.

        • errorType — (String)

          Specifies the type of error.

          Possible values include:
          • "The inputs to this request are invalid."
          • "Service limits have been exceeded."
          • "Missing required permission to perform this request."
          • "One or more inputs to this request were not found."
          • "The system temporarily lacks sufficient resources to process the request."
          • "An internal error has occurred."
          • "Cancelled"
          • "A user recoverable error has occurred"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Creates a new kdb cluster.

Service Reference:

Examples:

Calling the createKxCluster operation

var params = {
  azMode: SINGLE | MULTI, /* required */
  clusterName: 'STRING_VALUE', /* required */
  clusterType: HDB | RDB | GATEWAY | GP | TICKERPLANT, /* required */
  environmentId: 'STRING_VALUE', /* required */
  releaseLabel: 'STRING_VALUE', /* required */
  vpcConfiguration: { /* required */
    ipAddressType: IP_V4,
    securityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    subnetIds: [
      'STRING_VALUE',
      /* more items */
    ],
    vpcId: 'STRING_VALUE'
  },
  autoScalingConfiguration: {
    autoScalingMetric: CPU_UTILIZATION_PERCENTAGE,
    maxNodeCount: 'NUMBER_VALUE',
    metricTarget: 'NUMBER_VALUE',
    minNodeCount: 'NUMBER_VALUE',
    scaleInCooldownSeconds: 'NUMBER_VALUE',
    scaleOutCooldownSeconds: 'NUMBER_VALUE'
  },
  availabilityZoneId: 'STRING_VALUE',
  cacheStorageConfigurations: [
    {
      size: 'NUMBER_VALUE', /* required */
      type: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  capacityConfiguration: {
    nodeCount: 'NUMBER_VALUE',
    nodeType: 'STRING_VALUE'
  },
  clientToken: 'STRING_VALUE',
  clusterDescription: 'STRING_VALUE',
  code: {
    s3Bucket: 'STRING_VALUE',
    s3Key: 'STRING_VALUE',
    s3ObjectVersion: 'STRING_VALUE'
  },
  commandLineArguments: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  databases: [
    {
      databaseName: 'STRING_VALUE', /* required */
      cacheConfigurations: [
        {
          cacheType: 'STRING_VALUE', /* required */
          dbPaths: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          dataviewName: 'STRING_VALUE'
        },
        /* more items */
      ],
      changesetId: 'STRING_VALUE',
      dataviewConfiguration: {
        changesetId: 'STRING_VALUE',
        dataviewName: 'STRING_VALUE',
        dataviewVersionId: 'STRING_VALUE',
        segmentConfigurations: [
          {
            dbPaths: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            volumeName: 'STRING_VALUE', /* required */
            onDemand: true || false
          },
          /* more items */
        ]
      },
      dataviewName: 'STRING_VALUE'
    },
    /* more items */
  ],
  executionRole: 'STRING_VALUE',
  initializationScript: 'STRING_VALUE',
  savedownStorageConfiguration: {
    size: 'NUMBER_VALUE',
    type: SDS01,
    volumeName: 'STRING_VALUE'
  },
  scalingGroupConfiguration: {
    memoryReservation: 'NUMBER_VALUE', /* required */
    nodeCount: 'NUMBER_VALUE', /* required */
    scalingGroupName: 'STRING_VALUE', /* required */
    cpu: 'NUMBER_VALUE',
    memoryLimit: 'NUMBER_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  tickerplantLogConfiguration: {
    tickerplantLogVolumes: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
finspace.createKxCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • clientToken — (String)

      A token that ensures idempotency. This token expires in 10 minutes.

      If a token is not provided, the SDK will use a version 4 UUID.
    • environmentId — (String)

      A unique identifier for the kdb environment.

    • clusterName — (String)

      A unique name for the cluster that you want to create.

    • clusterType — (String)

      Specifies the type of KDB database that is being created. The following types are available:

      • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

      • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

      • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

      • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

      • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

      Possible values include:
      • "HDB"
      • "RDB"
      • "GATEWAY"
      • "GP"
      • "TICKERPLANT"
    • tickerplantLogConfiguration — (map)

      A configuration to store Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.

      • tickerplantLogVolumes — (Array<String>)

        The name of the volumes for tickerplant logs.

    • databases — (Array<map>)

      A list of databases that will be available for querying.

      • databaseName — required — (String)

        The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.

      • cacheConfigurations — (Array<map>)

        Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.

        • cacheType — required — (String)

          The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

          • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

        • dbPaths — required — (Array<String>)

          Specifies the portions of database that will be loaded into the cache for access.

        • dataviewName — (String)

          The name of the dataview to be used for caching historical data on disk.

      • changesetId — (String)

        A unique identifier of the changeset that is associated with the cluster.

      • dataviewName — (String)

        The name of the dataview to be used for caching historical data on disk.

      • dataviewConfiguration — (map)

        The configuration of the dataview to be used with specified cluster.

        • dataviewName — (String)

          The unique identifier of the dataview.

        • dataviewVersionId — (String)

          The version of the dataview corresponding to a given changeset.

        • changesetId — (String)

          A unique identifier for the changeset.

        • segmentConfigurations — (Array<map>)

          The db path and volume configuration for the segmented database.

          • dbPaths — required — (Array<String>)

            The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

          • volumeName — required — (String)

            The name of the volume where you want to add data.

          • onDemand — (Boolean)

            Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

    • cacheStorageConfigurations — (Array<map>)

      The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

      • type — required — (String)

        The type of cache storage. The valid values are:

        • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

        • CACHE_250 – This type provides at least 250 MB/s disk access throughput.

        • CACHE_12 – This type provides at least 12 MB/s disk access throughput.

        For cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache size in increments of 6000 GB.

      • size — required — (Integer)

        The size of cache in Gigabytes.

    • autoScalingConfiguration — (map)

      The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

      • minNodeCount — (Integer)

        The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.

      • maxNodeCount — (Integer)

        The highest number of nodes to scale. This value cannot be greater than 5.

      • autoScalingMetric — (String)

        The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.

        Possible values include:
        • "CPU_UTILIZATION_PERCENTAGE"
      • metricTarget — (Float)

        The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.

      • scaleInCooldownSeconds — (Float)

        The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.

      • scaleOutCooldownSeconds — (Float)

        The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.

    • clusterDescription — (String)

      A description of the cluster.

    • capacityConfiguration — (map)

      A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

      • nodeType — (String)

        The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.

        You can only specify one of the following values:

        • kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs.

        • kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs.

        • kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs.

        • kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs.

        • kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs.

        • kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs.

        • kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.

      • nodeCount — (Integer)

        The number of instances running in a cluster.

    • releaseLabel — (String)

      The version of FinSpace managed kdb to run.

    • vpcConfiguration — (map)

      Configuration details about the network where the Privatelink endpoint of the cluster resides.

      • vpcId — (String)

        The identifier of the VPC endpoint.

      • securityGroupIds — (Array<String>)

        The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.

      • subnetIds — (Array<String>)

        The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.

      • ipAddressType — (String)

        The IP address type for cluster network configuration parameters. The following type is available:

        • IP_V4 – IP address version 4

        Possible values include:
        • "IP_V4"
    • initializationScript — (String)

      Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

    • commandLineArguments — (Array<map>)

      Defines the key-value pairs to make them available inside the cluster.

      • key — (String)

        The name of the key.

      • value — (String)

        The value of the key.

    • code — (map)

      The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

      • s3Bucket — (String)

        A unique name for the S3 bucket.

      • s3Key — (String)

        The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.

      • s3ObjectVersion — (String)

        The version of an S3 object.

    • executionRole — (String)

      An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

    • savedownStorageConfiguration — (map)

      The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

      • type — (String)

        The type of writeable storage space for temporarily storing your savedown data. The valid values are:

        • SDS01 – This type represents 3000 IOPS and io2 ebs volume type.

        Possible values include:
        • "SDS01"
      • size — (Integer)

        The size of temporary storage in gibibytes.

      • volumeName — (String)

        The name of the kdb volume that you want to use as writeable save-down storage for clusters.

    • azMode — (String)

      The number of availability zones you want to assign per cluster. This can be one of the following

      • SINGLE – Assigns one availability zone per cluster.

      • MULTI – Assigns all the availability zones per cluster.

      Possible values include:
      • "SINGLE"
      • "MULTI"
    • availabilityZoneId — (String)

      The availability zone identifiers for the requested regions.

    • tags — (map<String>)

      A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.

    • scalingGroupConfiguration — (map)

      The structure that stores the configuration details of a scaling group.

      • scalingGroupName — required — (String)

        A unique identifier for the kdb scaling group.

      • memoryLimit — (Integer)

        An optional hard limit on the amount of memory a kdb cluster can use.

      • memoryReservation — required — (Integer)

        A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group.

      • nodeCount — required — (Integer)

        The number of kdb cluster nodes.

      • cpu — (Float)

        The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentId — (String)

        A unique identifier for the kdb environment.

      • status — (String)

        The status of cluster creation.

        • PENDING – The cluster is pending creation.

        • CREATING – The cluster creation process is in progress.

        • CREATE_FAILED – The cluster creation process has failed.

        • RUNNING – The cluster creation process is running.

        • UPDATING – The cluster is in the process of being updated.

        • DELETING – The cluster is in the process of being deleted.

        • DELETED – The cluster has been deleted.

        • DELETE_FAILED – The cluster failed to delete.

        Possible values include:
        • "PENDING"
        • "CREATING"
        • "CREATE_FAILED"
        • "RUNNING"
        • "UPDATING"
        • "DELETING"
        • "DELETED"
        • "DELETE_FAILED"
      • statusReason — (String)

        The error message when a failed state occurs.

      • clusterName — (String)

        A unique name for the cluster.

      • clusterType — (String)

        Specifies the type of KDB database that is being created. The following types are available:

        • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

        • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

        • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

        • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

        • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

        Possible values include:
        • "HDB"
        • "RDB"
        • "GATEWAY"
        • "GP"
        • "TICKERPLANT"
      • tickerplantLogConfiguration — (map)

        A configuration to store the Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.

        • tickerplantLogVolumes — (Array<String>)

          The name of the volumes for tickerplant logs.

      • volumes — (Array<map>)

        A list of volumes mounted on the cluster.

        • volumeName — (String)

          A unique identifier for the volume.

        • volumeType — (String)

          The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

          Possible values include:
          • "NAS_1"
      • databases — (Array<map>)

        A list of databases that will be available for querying.

        • databaseName — required — (String)

          The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.

        • cacheConfigurations — (Array<map>)

          Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.

          • cacheType — required — (String)

            The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

            • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

          • dbPaths — required — (Array<String>)

            Specifies the portions of database that will be loaded into the cache for access.

          • dataviewName — (String)

            The name of the dataview to be used for caching historical data on disk.

        • changesetId — (String)

          A unique identifier of the changeset that is associated with the cluster.

        • dataviewName — (String)

          The name of the dataview to be used for caching historical data on disk.

        • dataviewConfiguration — (map)

          The configuration of the dataview to be used with specified cluster.

          • dataviewName — (String)

            The unique identifier of the dataview.

          • dataviewVersionId — (String)

            The version of the dataview corresponding to a given changeset.

          • changesetId — (String)

            A unique identifier for the changeset.

          • segmentConfigurations — (Array<map>)

            The db path and volume configuration for the segmented database.

            • dbPaths — required — (Array<String>)

              The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

            • volumeName — required — (String)

              The name of the volume where you want to add data.

            • onDemand — (Boolean)

              Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

      • cacheStorageConfigurations — (Array<map>)

        The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

        • type — required — (String)

          The type of cache storage. The valid values are:

          • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

          • CACHE_250 – This type provides at least 250 MB/s disk access throughput.

          • CACHE_12 – This type provides at least 12 MB/s disk access throughput.

          For cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache size in increments of 6000 GB.

        • size — required — (Integer)

          The size of cache in Gigabytes.

      • autoScalingConfiguration — (map)

        The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

        • minNodeCount — (Integer)

          The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.

        • maxNodeCount — (Integer)

          The highest number of nodes to scale. This value cannot be greater than 5.

        • autoScalingMetric — (String)

          The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.

          Possible values include:
          • "CPU_UTILIZATION_PERCENTAGE"
        • metricTarget — (Float)

          The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.

        • scaleInCooldownSeconds — (Float)

          The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.

        • scaleOutCooldownSeconds — (Float)

          The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.

      • clusterDescription — (String)

        A description of the cluster.

      • capacityConfiguration — (map)

        A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

        • nodeType — (String)

          The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.

          You can only specify one of the following values:

          • kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs.

          • kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs.

          • kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs.

          • kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs.

          • kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs.

          • kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs.

          • kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.

        • nodeCount — (Integer)

          The number of instances running in a cluster.

      • releaseLabel — (String)

        A version of the FinSpace managed kdb to run.

      • vpcConfiguration — (map)

        Configuration details about the network where the Privatelink endpoint of the cluster resides.

        • vpcId — (String)

          The identifier of the VPC endpoint.

        • securityGroupIds — (Array<String>)

          The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.

        • subnetIds — (Array<String>)

          The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.

        • ipAddressType — (String)

          The IP address type for cluster network configuration parameters. The following type is available:

          • IP_V4 – IP address version 4

          Possible values include:
          • "IP_V4"
      • initializationScript — (String)

        Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

      • commandLineArguments — (Array<map>)

        Defines the key-value pairs to make them available inside the cluster.

        • key — (String)

          The name of the key.

        • value — (String)

          The value of the key.

      • code — (map)

        The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

        • s3Bucket — (String)

          A unique name for the S3 bucket.

        • s3Key — (String)

          The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.

        • s3ObjectVersion — (String)

          The version of an S3 object.

      • executionRole — (String)

        An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

      • lastModifiedTimestamp — (Date)

        The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • savedownStorageConfiguration — (map)

        The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

        • type — (String)

          The type of writeable storage space for temporarily storing your savedown data. The valid values are:

          • SDS01 – This type represents 3000 IOPS and io2 ebs volume type.

          Possible values include:
          • "SDS01"
        • size — (Integer)

          The size of temporary storage in gibibytes.

        • volumeName — (String)

          The name of the kdb volume that you want to use as writeable save-down storage for clusters.

      • azMode — (String)

        The number of availability zones you want to assign per cluster. This can be one of the following

        • SINGLE – Assigns one availability zone per cluster.

        • MULTI – Assigns all the availability zones per cluster.

        Possible values include:
        • "SINGLE"
        • "MULTI"
      • availabilityZoneId — (String)

        The availability zone identifiers for the requested regions.

      • createdTimestamp — (Date)

        The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      • scalingGroupConfiguration — (map)

        The structure that stores the configuration details of a scaling group.

        • scalingGroupName — required — (String)

          A unique identifier for the kdb scaling group.

        • memoryLimit — (Integer)

          An optional hard limit on the amount of memory a kdb cluster can use.

        • memoryReservation — required — (Integer)

          A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group.

        • nodeCount — required — (Integer)

          The number of kdb cluster nodes.

        • cpu — (Float)

          The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Creates a new kdb database in the environment.

Service Reference:

Examples:

Calling the createKxDatabase operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  databaseName: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
finspace.createKxDatabase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters: