Integer minNodeCount
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.
Integer maxNodeCount
The highest number of nodes to scale. This value cannot be greater than 5.
String autoScalingMetric
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.
Double metricTarget
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.
Double scaleInCooldownSeconds
The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
Double scaleOutCooldownSeconds
The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
String nodeType
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.
Integer nodeCount
The number of instances running in a cluster.
String changeType
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.
String s3Path
Defines the S3 path of the source file that is required to add or update files in a database.
String dbPath
Defines the path within the database directory.
String reason
The reason for the conflict exception.
String name
The name of the FinSpace environment to be created.
String description
The description of the FinSpace environment to be created.
String kmsKeyId
The KMS key id to encrypt your data in the FinSpace environment.
Map<K,V> tags
Add tags to your FinSpace environment.
String federationMode
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.
FederationParameters federationParameters
Configuration information when authentication mode is FEDERATED.
SuperuserParameters superuserParameters
Configuration information for the superuser.
List<E> dataBundles
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.
String environmentId
The unique identifier for FinSpace environment that you created.
String environmentArn
The Amazon Resource Name (ARN) of the FinSpace environment that you created.
String environmentUrl
The sign-in URL for the web application of the FinSpace environment you created.
String environmentId
A unique identifier of the kdb environment.
String databaseName
The name of the kdb database.
List<E> changeRequests
A list of change request objects that are run in order. A change request object consists of
changeType , s3Path, and dbPath. A changeType can has 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:
This request adds a single sym file at database root location.
{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}
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/"}
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/"}]
This request deletes the 2020.01.02 partition of the database.
[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]
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/"}]
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String changesetId
A unique identifier for the changeset.
String databaseName
The name of the kdb database.
String environmentId
A unique identifier for the kdb environment.
List<E> changeRequests
A list of change requests.
Date createdTimestamp
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.
Date lastModifiedTimestamp
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.
String status
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.
ErrorInfo errorInfo
The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String environmentId
A unique identifier for the kdb environment.
String clusterName
A unique name for the cluster that you want to create.
String clusterType
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.
TickerplantLogConfiguration tickerplantLogConfiguration
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.
List<E> databases
A list of databases that will be available for querying.
List<E> cacheStorageConfigurations
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.
AutoScalingConfiguration autoScalingConfiguration
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
String clusterDescription
A description of the cluster.
CapacityConfiguration capacityConfiguration
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
String releaseLabel
The version of FinSpace managed kdb to run.
VpcConfiguration vpcConfiguration
Configuration details about the network where the Privatelink endpoint of the cluster resides.
String initializationScript
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.
List<E> commandLineArguments
Defines the key-value pairs to make them available inside the cluster.
CodeConfiguration code
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.
String executionRole
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.
KxSavedownStorageConfiguration savedownStorageConfiguration
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.
String azMode
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.
String availabilityZoneId
The availability zone identifiers for the requested regions.
Map<K,V> tags
A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
KxScalingGroupConfiguration scalingGroupConfiguration
The structure that stores the configuration details of a scaling group.
String environmentId
A unique identifier for the kdb environment.
String status
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.
String statusReason
The error message when a failed state occurs.
String clusterName
A unique name for the cluster.
String clusterType
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.
TickerplantLogConfiguration tickerplantLogConfiguration
List<E> volumes
A list of volumes mounted on the cluster.
List<E> databases
A list of databases that will be available for querying.
List<E> cacheStorageConfigurations
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.
AutoScalingConfiguration autoScalingConfiguration
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
String clusterDescription
A description of the cluster.
CapacityConfiguration capacityConfiguration
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
String releaseLabel
A version of the FinSpace managed kdb to run.
VpcConfiguration vpcConfiguration
Configuration details about the network where the Privatelink endpoint of the cluster resides.
String initializationScript
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.
List<E> commandLineArguments
Defines the key-value pairs to make them available inside the cluster.
CodeConfiguration code
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.
String executionRole
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.
Date lastModifiedTimestamp
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.
KxSavedownStorageConfiguration savedownStorageConfiguration
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.
String azMode
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.
String availabilityZoneId
The availability zone identifiers for the requested regions.
Date createdTimestamp
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.
KxScalingGroupConfiguration scalingGroupConfiguration
The structure that stores the configuration details of a scaling group.
String environmentId
A unique identifier for the kdb environment.
String databaseName
The name of the kdb database.
String description
A description of the database.
Map<K,V> tags
A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String databaseName
The name of the kdb database.
String databaseArn
The ARN identifier of the database.
String environmentId
A unique identifier for the kdb environment.
String description
A description of the database.
Date createdTimestamp
The timestamp at which the database is 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.
Date lastModifiedTimestamp
The last time that the database 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.
String environmentId
A unique identifier for the kdb environment, where you want to create the dataview.
String databaseName
The name of the database where you want to create a dataview.
String dataviewName
A unique identifier for the dataview.
String azMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLE for volumes. This places dataview in a single AZ.
String availabilityZoneId
The identifier of the availability zones.
String changesetId
A unique identifier of the changeset that you want to use to ingest data.
List<E> segmentConfigurations
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
Boolean autoUpdate
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.
Boolean readWrite
The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.
You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.
You cannot perform updates on a writeable dataview. Hence, autoUpdate must be set as False if
readWrite is True for a dataview.
You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the
readWrite parameter later.
String description
A description of the dataview.
Map<K,V> tags
A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String dataviewName
A unique identifier for the dataview.
String databaseName
The name of the database where you want to create a dataview.
String environmentId
A unique identifier for the kdb environment, where you want to create the dataview.
String azMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLE for volumes. This places dataview in a single AZ.
String availabilityZoneId
The identifier of the availability zones.
String changesetId
A unique identifier for the changeset.
List<E> segmentConfigurations
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
String description
A description of the dataview.
Boolean autoUpdate
The option to select whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.
Boolean readWrite
Returns True if the dataview is created as writeable and False otherwise.
Date createdTimestamp
The timestamp at which the dataview 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.
Date lastModifiedTimestamp
The last time that the dataview 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.
String status
The status of dataview creation.
CREATING – The dataview creation is in progress.
UPDATING – The dataview is in the process of being updated.
ACTIVE – The dataview is active.
String name
The name of the kdb environment that you want to create.
String description
A description for the kdb environment.
String kmsKeyId
The KMS key ID to encrypt your data in the FinSpace environment.
Map<K,V> tags
A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String name
The name of the kdb environment.
String status
The status of the kdb environment.
String environmentId
A unique identifier for the kdb environment.
String description
A description for the kdb environment.
String environmentArn
The ARN identifier of the environment.
String kmsKeyId
The KMS key ID to encrypt your data in the FinSpace environment.
Date creationTimestamp
The timestamp at which the kdb environment was created in FinSpace.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String environmentId
A unique identifier for the kdb environment, where you want to create the scaling group.
String scalingGroupName
A unique identifier for the kdb scaling group.
String hostType
The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
You can add one of the following values:
kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
String availabilityZoneId
The identifier of the availability zones.
Map<K,V> tags
A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.
String environmentId
A unique identifier for the kdb environment, where you create the scaling group.
String scalingGroupName
A unique identifier for the kdb scaling group.
String hostType
The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
String availabilityZoneId
The identifier of the availability zones.
String status
The status of scaling group.
CREATING – The scaling group creation is in progress.
CREATE_FAILED – The scaling group creation has failed.
ACTIVE – The scaling group is active.
UPDATING – The scaling group is in the process of being updated.
UPDATE_FAILED – The update action failed.
DELETING – The scaling group is in the process of being deleted.
DELETE_FAILED – The system failed to delete the scaling group.
DELETED – The scaling group is successfully deleted.
Date lastModifiedTimestamp
The last time that the scaling group 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.
Date createdTimestamp
The timestamp at which the scaling group 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.
String environmentId
A unique identifier for the kdb environment where you want to create a user.
String userName
A unique identifier for the user.
String iamRole
The IAM role ARN that will be associated with the user.
Map<K,V> tags
A list of key-value pairs to label the user. You can add up to 50 tags to a user.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String userName
A unique identifier for the user.
String userArn
The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
String environmentId
A unique identifier for the kdb environment.
String iamRole
The IAM role ARN that will be associated with the user.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String environmentId
A unique identifier for the kdb environment, whose clusters can attach to the volume.
String volumeType
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select
NAS_1 volume type, you must also provide nas1Configuration.
String volumeName
A unique identifier for the volume.
String description
A description of the volume.
KxNAS1Configuration nas1Configuration
Specifies the configuration for the Network attached storage (NAS_1) file system volume. This parameter is
required when you choose volumeType as NAS_1.
String azMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLE for volumes. This places dataview in a single AZ.
List<E> availabilityZoneIds
The identifier of the availability zones.
Map<K,V> tags
A list of key-value pairs to label the volume. You can add up to 50 tags to a volume.
String environmentId
A unique identifier for the kdb environment, whose clusters can attach to the volume.
String volumeName
A unique identifier for the volume.
String volumeType
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
String volumeArn
The ARN identifier of the volume.
KxNAS1Configuration nas1Configuration
Specifies the configuration for the Network attached storage (NAS_1) file system volume.
String status
The status of volume creation.
CREATING – The volume creation is in progress.
CREATE_FAILED – The volume creation has failed.
ACTIVE – The volume is active.
UPDATING – The volume is in the process of being updated.
UPDATE_FAILED – The update action failed.
UPDATED – The volume is successfully updated.
DELETING – The volume is in the process of being deleted.
DELETE_FAILED – The system failed to delete the volume.
DELETED – The volume is successfully deleted.
String statusReason
The error message when a failed state occurs.
String azMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLE for volumes. This places dataview in a single AZ.
String description
A description of the volume.
List<E> availabilityZoneIds
The identifier of the availability zones.
Date createdTimestamp
The timestamp at which the volume 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.
String environmentId
The identifier for the FinSpace environment.
String environmentId
A unique identifier for the kdb environment, from where you want to delete the dataview.
String databaseName
The name of the database whose dataview you want to delete.
String dataviewName
The name of the dataview that you want to delete.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String environmentId
A unique identifier for the kdb environment, from where you want to delete the dataview.
String scalingGroupName
A unique identifier for the kdb scaling group.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String name
The name of the FinSpace environment.
String environmentId
The identifier of the FinSpace environment.
String awsAccountId
The ID of the AWS account in which the FinSpace environment is created.
String status
The current status of creation of the FinSpace environment.
String environmentUrl
The sign-in URL for the web application of your FinSpace environment.
String description
The description of the FinSpace environment.
String environmentArn
The Amazon Resource Name (ARN) of your FinSpace environment.
String sageMakerStudioDomainUrl
The URL of the integrated FinSpace notebook environment in your web application.
String kmsKeyId
The KMS key id used to encrypt in the FinSpace environment.
String dedicatedServiceAccountId
The AWS account ID of the dedicated service account associated with your FinSpace environment.
String federationMode
The authentication mode for the environment.
FederationParameters federationParameters
Configuration information when authentication mode is FEDERATED.
String samlMetadataDocument
SAML 2.0 Metadata document from identity provider (IdP).
String samlMetadataURL
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
String applicationCallBackURL
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
String federationURN
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
String federationProviderName
Name of the identity provider (IdP).
Map<K,V> attributeMap
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.
String environmentId
The identifier of the FinSpace environment.
Environment environment
The name of the FinSpace environment.
String changesetId
A unique identifier for the changeset.
String databaseName
The name of the kdb database.
String environmentId
A unique identifier for the kdb environment.
List<E> changeRequests
A list of change request objects that are run in order.
Date createdTimestamp
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.
Date activeFromTimestamp
Beginning time from which the changeset is active. 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.
Date lastModifiedTimestamp
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.
String status
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.
ErrorInfo errorInfo
Provides details in the event of a failed flow, including the error type and the related error message.
String status
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.
String statusReason
The error message when a failed state occurs.
String clusterName
A unique name for the cluster.
String clusterType
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.
TickerplantLogConfiguration tickerplantLogConfiguration
List<E> volumes
A list of volumes attached to the cluster.
List<E> databases
A list of databases mounted on the cluster.
List<E> cacheStorageConfigurations
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.
AutoScalingConfiguration autoScalingConfiguration
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
String clusterDescription
A description of the cluster.
CapacityConfiguration capacityConfiguration
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
String releaseLabel
The version of FinSpace managed kdb to run.
VpcConfiguration vpcConfiguration
Configuration details about the network where the Privatelink endpoint of the cluster resides.
String initializationScript
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.
List<E> commandLineArguments
Defines key-value pairs to make them available inside the cluster.
CodeConfiguration code
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.
String executionRole
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.
Date lastModifiedTimestamp
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.
KxSavedownStorageConfiguration savedownStorageConfiguration
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.
String azMode
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.
String availabilityZoneId
The availability zone identifiers for the requested regions.
Date createdTimestamp
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.
KxScalingGroupConfiguration scalingGroupConfiguration
String userArn
The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
String environmentId
A unique identifier for the kdb environment.
String clusterName
A name of the kdb cluster.
String signedConnectionString
The signed connection string that you can use to connect to clusters.
String databaseName
The name of the kdb database for which the information is retrieved.
String databaseArn
The ARN identifier of the database.
String environmentId
A unique identifier for the kdb environment.
String description
A description of the database.
Date createdTimestamp
The timestamp at which the database is 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.
Date lastModifiedTimestamp
The last time that the database 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.
String lastCompletedChangesetId
A unique identifier for the changeset.
Long numBytes
The total number of bytes in the database.
Integer numChangesets
The total number of changesets in the database.
Integer numFiles
The total number of files in the database.
String databaseName
The name of the database where you created the dataview.
String dataviewName
A unique identifier for the dataview.
String azMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLE for volumes. This places dataview in a single AZ.
String availabilityZoneId
The identifier of the availability zones.
String changesetId
A unique identifier of the changeset that you want to use to ingest data.
List<E> segmentConfigurations
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
List<E> activeVersions
The current active changeset versions of the database on the given dataview.
String description
A description of the dataview.
Boolean autoUpdate
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.
Boolean readWrite
Returns True if the dataview is created as writeable and False otherwise.
String environmentId
A unique identifier for the kdb environment, from where you want to retrieve the dataview details.
Date createdTimestamp
The timestamp at which the dataview 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.
Date lastModifiedTimestamp
The last time that the dataview 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.
String status
The status of dataview creation.
CREATING – The dataview creation is in progress.
UPDATING – The dataview is in the process of being updated.
ACTIVE – The dataview is active.
String statusReason
The error message when a failed state occurs.
String environmentId
A unique identifier for the kdb environment.
String name
The name of the kdb environment.
String environmentId
A unique identifier for the kdb environment.
String awsAccountId
The unique identifier of the AWS account that is used to create the kdb environment.
String status
The status of the kdb environment.
String tgwStatus
The status of the network configuration.
String dnsStatus
The status of DNS configuration.
String errorMessage
Specifies the error message that appears if a flow fails.
String description
A description for the kdb environment.
String environmentArn
The ARN identifier of the environment.
String kmsKeyId
The KMS key ID to encrypt your data in the FinSpace environment.
String dedicatedServiceAccountId
A unique identifier for the AWS environment infrastructure account.
TransitGatewayConfiguration transitGatewayConfiguration
List<E> customDNSConfiguration
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
Date creationTimestamp
The timestamp at which the kdb environment was created in FinSpace.
Date updateTimestamp
The timestamp at which the kdb environment was updated.
List<E> availabilityZoneIds
The identifier of the availability zones where subnets for the environment are created.
String certificateAuthorityArn
The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.
String scalingGroupName
A unique identifier for the kdb scaling group.
String scalingGroupArn
The ARN identifier for the scaling group.
String hostType
The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
It can have one of the following values:
kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
List<E> clusters
The list of Managed kdb clusters that are currently active in the given scaling group.
String availabilityZoneId
The identifier of the availability zones.
String status
The status of scaling group.
CREATING – The scaling group creation is in progress.
CREATE_FAILED – The scaling group creation has failed.
ACTIVE – The scaling group is active.
UPDATING – The scaling group is in the process of being updated.
UPDATE_FAILED – The update action failed.
DELETING – The scaling group is in the process of being deleted.
DELETE_FAILED – The system failed to delete the scaling group.
DELETED – The scaling group is successfully deleted.
String statusReason
The error message when a failed state occurs.
Date lastModifiedTimestamp
The last time that the scaling group 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.
Date createdTimestamp
The timestamp at which the scaling group 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.
String userName
A unique identifier for the user.
String userArn
The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
String environmentId
A unique identifier for the kdb environment.
String iamRole
The IAM role ARN that is associated with the user.
String environmentId
A unique identifier for the kdb environment, whose clusters can attach to the volume.
String volumeName
A unique identifier for the volume.
String volumeType
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
String volumeArn
The ARN identifier of the volume.
KxNAS1Configuration nas1Configuration
Specifies the configuration for the Network attached storage (NAS_1) file system volume.
String status
The status of volume creation.
CREATING – The volume creation is in progress.
CREATE_FAILED – The volume creation has failed.
ACTIVE – The volume is active.
UPDATING – The volume is in the process of being updated.
UPDATE_FAILED – The update action failed.
UPDATED – The volume is successfully updated.
DELETING – The volume is in the process of being deleted.
DELETE_FAILED – The system failed to delete the volume.
DELETED – The volume is successfully deleted.
String statusReason
The error message when a failed state occurs.
Date createdTimestamp
The timestamp at which the volume 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.
String description
A description of the volume.
String azMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLE for volumes. This places dataview in a single AZ.
List<E> availabilityZoneIds
The identifier of the availability zones.
Date lastModifiedTimestamp
The last time that the volume 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.
List<E> attachedClusters
A list of cluster identifiers that a volume is attached to.
String clusterName
A unique name for the attached cluster.
String clusterType
Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.
String clusterStatus
The status of the attached cluster.
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.
String type
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.
Integer size
The size of cache in Gigabytes.
String changesetId
A unique identifier for the changeset.
Date createdTimestamp
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.
Date activeFromTimestamp
Beginning time from which the changeset is active. 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.
Date lastModifiedTimestamp
The timestamp at which the changeset 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.
String status
Status of the changeset.
Pending – Changeset creation is pending.
Processing – Changeset creation is running.
Failed – Changeset creation has failed.
Complete – Changeset creation has succeeded.
String status
The status of a cluster.
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.
String statusReason
The error message when a failed state occurs.
String clusterName
A unique name for the cluster.
String clusterType
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.
String clusterDescription
A description of the cluster.
String releaseLabel
A version of the FinSpace managed kdb to run.
List<E> volumes
A list of volumes attached to the cluster.
String initializationScript
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.
String executionRole
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.
String azMode
The number of availability zones assigned per cluster. This can be one of the following:
SINGLE – Assigns one availability zone per cluster.
MULTI – Assigns all the availability zones per cluster.
String availabilityZoneId
The availability zone identifiers for the requested regions.
Date lastModifiedTimestamp
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.
Date createdTimestamp
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.
String deploymentStrategy
The type of deployment that you want on a cluster.
ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.
NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for
GP type cluster. This option is quicker as it reduces the turn around time to update configuration
on a cluster.
With this deployment mode, you cannot update the initializationScript and
commandLineArguments parameters.
FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.
String cacheType
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.
List<E> dbPaths
Specifies the portions of database that will be loaded into the cache for access.
String dataviewName
The name of the dataview to be used for caching historical data on disk.
String databaseName
The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
List<E> cacheConfigurations
Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
String changesetId
A unique identifier of the changeset that is associated with the cluster.
String dataviewName
The name of the dataview to be used for caching historical data on disk.
KxDataviewConfiguration dataviewConfiguration
The configuration of the dataview to be used with specified cluster.
String databaseName
The name of the kdb database.
Date createdTimestamp
The timestamp at which the database 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.
Date lastModifiedTimestamp
The last time that the database 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.
String changesetId
A unique identifier for the changeset.
List<E> segmentConfigurations
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
List<E> attachedClusters
The list of clusters that are currently using this dataview.
Date createdTimestamp
The timestamp at which the dataview version was active. 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.
String versionId
A unique identifier of the active version.
String dataviewName
The unique identifier of the dataview.
String dataviewVersionId
The version of the dataview corresponding to a given changeset.
String changesetId
A unique identifier for the changeset.
List<E> segmentConfigurations
The db path and volume configuration for the segmented database.
String environmentId
A unique identifier for the kdb environment.
String databaseName
A unique identifier of the database.
String dataviewName
A unique identifier of the dataview.
String azMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLE for volumes. This places dataview in a single AZ.
String availabilityZoneId
The identifier of the availability zones.
String changesetId
A unique identifier for the changeset.
List<E> segmentConfigurations
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
List<E> activeVersions
The active changeset versions for the given dataview entry.
String status
The status of a given dataview entry.
String description
A description for the dataview list entry.
Boolean autoUpdate
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.
Boolean readWrite
Returns True if the dataview is created as writeable and False otherwise.
Date createdTimestamp
The timestamp at which the dataview list entry 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.
Date lastModifiedTimestamp
The last time that the dataview list 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.
String statusReason
The error message when a failed state occurs.
List<E> dbPaths
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.
String volumeName
The name of the volume where you want to add data.
Boolean onDemand
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.
String deploymentStrategy
The type of deployment that you want on a cluster.
ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.
NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for
HDB type cluster. This option is quicker as it reduces the turn around time to update configuration
on a cluster.
With this deployment mode, you cannot update the initializationScript and
commandLineArguments parameters.
String name
The name of the kdb environment.
String environmentId
A unique identifier for the kdb environment.
String awsAccountId
The unique identifier of the AWS account in which you create the kdb environment.
String status
The status of the environment creation.
CREATE_REQUESTED – Environment creation has been requested.
CREATING – Environment is in the process of being created.
FAILED_CREATION – Environment creation has failed.
CREATED – Environment is successfully created and is currently active.
DELETE REQUESTED – Environment deletion has been requested.
DELETING – Environment is in the process of being deleted.
RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.
DELETED – Environment has been deleted.
FAILED_DELETION – Environment deletion has failed.
String tgwStatus
The status of the network configuration.
String dnsStatus
The status of DNS configuration.
String errorMessage
Specifies the error message that appears if a flow fails.
String description
A description of the kdb environment.
String environmentArn
The Amazon Resource Name (ARN) of your kdb environment.
String kmsKeyId
The unique identifier of the KMS key.
String dedicatedServiceAccountId
A unique identifier for the AWS environment infrastructure account.
TransitGatewayConfiguration transitGatewayConfiguration
Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
List<E> customDNSConfiguration
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
Date creationTimestamp
The timestamp at which the kdb environment 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.
Date updateTimestamp
The timestamp at which the kdb environment was modified 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.
List<E> availabilityZoneIds
The identifier of the availability zones where subnets for the environment are created.
String certificateAuthorityArn
The Amazon Resource Name (ARN) of the certificate authority:
String nodeId
A unique identifier for the node.
String availabilityZoneId
The identifier of the availability zones where subnets for the environment are created.
Date launchTime
The time when a particular node is started. 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.
String type
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.
Integer size
The size of temporary storage in gibibytes.
String volumeName
The name of the kdb volume that you want to use as writeable save-down storage for clusters.
String scalingGroupName
A unique identifier for the kdb scaling group.
String hostType
The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
You can add one of the following values:
kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
List<E> clusters
The list of clusters currently active in a given scaling group.
String availabilityZoneId
The identifier of the availability zones.
String status
The status of scaling groups.
String statusReason
The error message when a failed state occurs.
Date lastModifiedTimestamp
The last time that the scaling group 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.
Date createdTimestamp
The timestamp at which the scaling group 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.
String scalingGroupName
A unique identifier for the kdb scaling group.
Integer memoryLimit
An optional hard limit on the amount of memory a kdb cluster can use.
Integer memoryReservation
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.
Integer nodeCount
The number of kdb cluster nodes.
Double cpu
The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.
String userArn
The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
String userName
A unique identifier for the user.
String iamRole
The IAM role ARN that is associated with the user.
Date createTimestamp
The timestamp at which the kdb user was created.
Date updateTimestamp
The timestamp at which the kdb user was updated.
String volumeName
A unique identifier for the volume.
String volumeType
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
String status
The status of volume.
CREATING – The volume creation is in progress.
CREATE_FAILED – The volume creation has failed.
ACTIVE – The volume is active.
UPDATING – The volume is in the process of being updated.
UPDATE_FAILED – The update action failed.
UPDATED – The volume is successfully updated.
DELETING – The volume is in the process of being deleted.
DELETE_FAILED – The system failed to delete the volume.
DELETED – The volume is successfully deleted.
String description
A description of the volume.
String statusReason
The error message when a failed state occurs.
String azMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLE for volumes. This places dataview in a single AZ.
List<E> availabilityZoneIds
The identifier of the availability zones.
Date createdTimestamp
The timestamp at which the volume 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.
Date lastModifiedTimestamp
The last time that the volume 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.
String nextToken
A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To
get the next set of pages, pass in the nextTokennextToken value from the response object of the
previous page call.
Integer maxResults
The maximum number of results to return in this request.
String environmentId
A unique identifier for the kdb environment.
String databaseName
The name of the kdb database.
String nextToken
A token that indicates where a results page should begin.
Integer maxResults
The maximum number of results to return in this request.
String environmentId
A unique identifier for the kdb environment.
String clusterName
A unique name for the cluster.
String nextToken
A token that indicates where a results page should begin.
Integer maxResults
The maximum number of results to return in this request.
String environmentId
A unique identifier for the kdb environment.
String clusterType
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.
Integer maxResults
The maximum number of results to return in this request.
String nextToken
A token that indicates where a results page should begin.
String environmentId
A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.
String databaseName
The name of the database where the dataviews were created.
String nextToken
A token that indicates where a results page should begin.
Integer maxResults
The maximum number of results to return in this request.
String environmentId
A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.
Integer maxResults
The maximum number of results to return in this request.
String nextToken
A token that indicates where a results page should begin.
String environmentId
A unique identifier for the kdb environment, whose clusters can attach to the volume.
Integer maxResults
The maximum number of results to return in this request.
String nextToken
A token that indicates where a results page should begin.
String volumeType
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
String resourceArn
The Amazon Resource Name of the resource.
Integer ruleNumber
The rule number for the entry. For example 100. All the network ACL entries are processed in ascending order by rule number.
String protocol
The protocol number. A value of -1 means all the protocols.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
PortRange portRange
The range of ports the rule applies to.
IcmpTypeCode icmpTypeCode
Defines the ICMP protocol that consists of the ICMP type and code.
String cidrBlock
The IPv4 network range to allow or deny, in CIDR notation. For example, 172.16.0.0/24. We modify the
specified CIDR block to its canonical form. For example, if you specify 100.68.0.18/18, we modify it
to 100.68.0.0/18.
String transitGatewayID
The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
String routableCIDRSpace
The routing CIDR on behalf of kdb environment. It could be any "/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.
List<E> attachmentNetworkAclConfiguration
The rules that define how you manage the outbound traffic from kdb network to your internal network.
String environmentId
The identifier of the FinSpace environment.
String name
The name of the environment.
String description
The description of the environment.
String federationMode
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.
FederationParameters federationParameters
Environment environment
Returns the FinSpace environment object.
String environmentId
A unique identifier of the kdb environment.
String clusterName
The name of the cluster.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
CodeConfiguration code
String initializationScript
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.
You cannot update this parameter for a NO_RESTART deployment.
List<E> commandLineArguments
Specifies the key-value pairs to make them available inside the cluster.
You cannot update this parameter for a NO_RESTART deployment.
KxClusterCodeDeploymentConfiguration deploymentConfiguration
The configuration that allows you to choose how you want to update the code on a cluster.
String environmentId
The unique identifier of a kdb environment.
String clusterName
A unique name for the cluster that you want to modify.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
List<E> databases
The structure of databases mounted on the cluster.
KxDeploymentConfiguration deploymentConfiguration
The configuration that allows you to choose how you want to update the databases on a cluster.
String environmentId
A unique identifier for the kdb environment.
String databaseName
The name of the kdb database.
String description
A description of the database.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String databaseName
The name of the kdb database.
String environmentId
A unique identifier for the kdb environment.
String description
A description of the database.
Date lastModifiedTimestamp
The last time that the database 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.
String environmentId
A unique identifier for the kdb environment, where you want to update the dataview.
String databaseName
The name of the database.
String dataviewName
The name of the dataview that you want to update.
String description
The description for a dataview.
String changesetId
A unique identifier for the changeset.
List<E> segmentConfigurations
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String environmentId
A unique identifier for the kdb environment, where you want to update the dataview.
String databaseName
The name of the database.
String dataviewName
The name of the database under which the dataview was created.
String azMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLE for volumes. This places dataview in a single AZ.
String availabilityZoneId
The identifier of the availability zones.
String changesetId
A unique identifier for the changeset.
List<E> segmentConfigurations
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
List<E> activeVersions
The current active changeset versions of the database on the given dataview.
String status
The status of dataview creation.
CREATING – The dataview creation is in progress.
UPDATING – The dataview is in the process of being updated.
ACTIVE – The dataview is active.
Boolean autoUpdate
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.
Boolean readWrite
Returns True if the dataview is created as writeable and False otherwise.
String description
A description of the dataview.
Date createdTimestamp
The timestamp at which the dataview 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.
Date lastModifiedTimestamp
The last time that the dataview 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.
String environmentId
A unique identifier for the kdb environment.
TransitGatewayConfiguration transitGatewayConfiguration
Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
List<E> customDNSConfiguration
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String name
The name of the kdb environment.
String environmentId
A unique identifier for the kdb environment.
String awsAccountId
The unique identifier of the AWS account that is used to create the kdb environment.
String status
The status of the kdb environment.
String tgwStatus
The status of the network configuration.
String dnsStatus
The status of DNS configuration.
String errorMessage
Specifies the error message that appears if a flow fails.
String description
The description of the environment.
String environmentArn
The ARN identifier of the environment.
String kmsKeyId
The KMS key ID to encrypt your data in the FinSpace environment.
String dedicatedServiceAccountId
A unique identifier for the AWS environment infrastructure account.
TransitGatewayConfiguration transitGatewayConfiguration
List<E> customDNSConfiguration
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
Date creationTimestamp
The timestamp at which the kdb environment was created in FinSpace.
Date updateTimestamp
The timestamp at which the kdb environment was updated.
List<E> availabilityZoneIds
The identifier of the availability zones where subnets for the environment are created.
String name
The name of the kdb environment.
String environmentId
A unique identifier for the kdb environment.
String awsAccountId
The unique identifier of the AWS account that is used to create the kdb environment.
String status
The status of the kdb environment.
String tgwStatus
The status of the network configuration.
String dnsStatus
The status of DNS configuration.
String errorMessage
Specifies the error message that appears if a flow fails.
String description
The description of the environment.
String environmentArn
The ARN identifier of the environment.
String kmsKeyId
The KMS key ID to encrypt your data in the FinSpace environment.
String dedicatedServiceAccountId
A unique identifier for the AWS environment infrastructure account.
TransitGatewayConfiguration transitGatewayConfiguration
List<E> customDNSConfiguration
A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
Date creationTimestamp
The timestamp at which the kdb environment was created in FinSpace.
Date updateTimestamp
The timestamp at which the kdb environment was updated.
List<E> availabilityZoneIds
The identifier of the availability zones where subnets for the environment are created.
String environmentId
A unique identifier for the kdb environment.
String userName
A unique identifier for the user.
String iamRole
The IAM role ARN that is associated with the user.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
String userName
A unique identifier for the user.
String userArn
The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
String environmentId
A unique identifier for the kdb environment.
String iamRole
The IAM role ARN that is associated with the user.
String environmentId
A unique identifier for the kdb environment where you created the storage volume.
String volumeName
A unique identifier for the volume.
String description
A description of the volume.
String clientToken
A token that ensures idempotency. This token expires in 10 minutes.
KxNAS1Configuration nas1Configuration
Specifies the configuration for the Network attached storage (NAS_1) file system volume.
String environmentId
A unique identifier for the kdb environment where you want to update the volume.
String volumeName
A unique identifier for the volume that you want to update.
String volumeType
The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
String volumeArn
The ARN identifier of the volume.
KxNAS1Configuration nas1Configuration
Specifies the configuration for the Network attached storage (NAS_1) file system volume.
String status
The status of the volume.
CREATING – The volume creation is in progress.
CREATE_FAILED – The volume creation has failed.
ACTIVE – The volume is active.
UPDATING – The volume is in the process of being updated.
UPDATE_FAILED – The update action failed.
UPDATED – The volume is successfully updated.
DELETING – The volume is in the process of being deleted.
DELETE_FAILED – The system failed to delete the volume.
DELETED – The volume is successfully deleted.
String description
The description for the volume.
String statusReason
The error message when a failed state occurs.
Date createdTimestamp
The timestamp at which the volume 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.
String azMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLE for volumes. This places dataview in a single AZ.
List<E> availabilityZoneIds
The identifier of the availability zones.
Date lastModifiedTimestamp
The last time that the volume 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.
List<E> attachedClusters
Specifies the clusters that a volume is attached to.
String vpcId
The identifier of the VPC endpoint.
List<E> securityGroupIds
The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
List<E> subnetIds
The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
String ipAddressType
The IP address type for cluster network configuration parameters. The following type is available:
IP_V4 – IP address version 4
Copyright © 2024. All rights reserved.