aws.finspace.KxCluster

Coming soon!

Coming soon!

Coming soon!

Coming soon!

name string

The unique name of the resource.

args KxClusterArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args KxClusterArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args KxClusterArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args KxClusterArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args KxClusterArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

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.

EnvironmentId string

Unique identifier for the KX environment.

ReleaseLabel string

Version of FinSpace Managed kdb to run.

Type string

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

VpcConfiguration KxClusterVpcConfiguration

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

The following arguments are optional:

AutoScalingConfiguration KxClusterAutoScalingConfiguration

Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.

AvailabilityZoneId string

The availability zone identifiers for the requested regions. Required when az_mode is set to SINGLE.

CacheStorageConfigurations List<KxClusterCacheStorageConfiguration>

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. See cache_storage_configuration.

CapacityConfiguration KxClusterCapacityConfiguration

Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.

Code KxClusterCode

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

CommandLineArguments Dictionary<string, string>

List of key-value pairs to make available inside the cluster.

Databases List<KxClusterDatabase>

KX database that will be available for querying. Defined below.

Description string

Description of the cluster.

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.

InitializationScript string

Path to Q program that will be run at launch of a cluster. This 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.

Name string

Unique name for the cluster that you want to create.

SavedownStorageConfiguration KxClusterSavedownStorageConfiguration

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

ScalingGroupConfiguration KxClusterScalingGroupConfiguration

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

Tags Dictionary<string, string>

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TickerplantLogConfigurations List<KxClusterTickerplantLogConfiguration>

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.

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.

EnvironmentId string

Unique identifier for the KX environment.

ReleaseLabel string

Version of FinSpace Managed kdb to run.

Type string

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

VpcConfiguration KxClusterVpcConfigurationArgs

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

The following arguments are optional:

AutoScalingConfiguration KxClusterAutoScalingConfigurationArgs

Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.

AvailabilityZoneId string

The availability zone identifiers for the requested regions. Required when az_mode is set to SINGLE.

CacheStorageConfigurations []KxClusterCacheStorageConfigurationArgs

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. See cache_storage_configuration.

CapacityConfiguration KxClusterCapacityConfigurationArgs

Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.

Code KxClusterCodeArgs

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

CommandLineArguments map[string]string

List of key-value pairs to make available inside the cluster.

Databases []KxClusterDatabaseArgs

KX database that will be available for querying. Defined below.

Description string

Description of the cluster.

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.

InitializationScript string

Path to Q program that will be run at launch of a cluster. This 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.

Name string

Unique name for the cluster that you want to create.

SavedownStorageConfiguration KxClusterSavedownStorageConfigurationArgs

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

ScalingGroupConfiguration KxClusterScalingGroupConfigurationArgs

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

Tags map[string]string

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TickerplantLogConfigurations []KxClusterTickerplantLogConfigurationArgs

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.

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.

environmentId String

Unique identifier for the KX environment.

releaseLabel String

Version of FinSpace Managed kdb to run.

type String

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

vpcConfiguration KxClusterVpcConfiguration

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

The following arguments are optional:

autoScalingConfiguration KxClusterAutoScalingConfiguration

Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.

availabilityZoneId String

The availability zone identifiers for the requested regions. Required when az_mode is set to SINGLE.

cacheStorageConfigurations List<KxClusterCacheStorageConfiguration>

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. See cache_storage_configuration.

capacityConfiguration KxClusterCapacityConfiguration

Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.

code KxClusterCode

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

commandLineArguments Map<String,String>

List of key-value pairs to make available inside the cluster.

databases List<KxClusterDatabase>

KX database that will be available for querying. Defined below.

description String

Description of the cluster.

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.

initializationScript String

Path to Q program that will be run at launch of a cluster. This 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.

name String

Unique name for the cluster that you want to create.

savedownStorageConfiguration KxClusterSavedownStorageConfiguration

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

scalingGroupConfiguration KxClusterScalingGroupConfiguration

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

tags Map<String,String>

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tickerplantLogConfigurations List<KxClusterTickerplantLogConfiguration>

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.

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.

environmentId string

Unique identifier for the KX environment.

releaseLabel string

Version of FinSpace Managed kdb to run.

type string

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

vpcConfiguration KxClusterVpcConfiguration

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

The following arguments are optional:

autoScalingConfiguration KxClusterAutoScalingConfiguration

Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.

availabilityZoneId string

The availability zone identifiers for the requested regions. Required when az_mode is set to SINGLE.

cacheStorageConfigurations KxClusterCacheStorageConfiguration[]

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. See cache_storage_configuration.

capacityConfiguration KxClusterCapacityConfiguration

Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.

code KxClusterCode

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

commandLineArguments {[key: string]: string}

List of key-value pairs to make available inside the cluster.

databases KxClusterDatabase[]

KX database that will be available for querying. Defined below.

description string

Description of the cluster.

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.

initializationScript string

Path to Q program that will be run at launch of a cluster. This 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.

name string

Unique name for the cluster that you want to create.

savedownStorageConfiguration KxClusterSavedownStorageConfiguration

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

scalingGroupConfiguration KxClusterScalingGroupConfiguration

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

tags {[key: string]: string}

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tickerplantLogConfigurations KxClusterTickerplantLogConfiguration[]

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.

az_mode str

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.

environment_id str

Unique identifier for the KX environment.

release_label str

Version of FinSpace Managed kdb to run.

type str

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

vpc_configuration KxClusterVpcConfigurationArgs

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

The following arguments are optional:

auto_scaling_configuration KxClusterAutoScalingConfigurationArgs

Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.

availability_zone_id str

The availability zone identifiers for the requested regions. Required when az_mode is set to SINGLE.

cache_storage_configurations Sequence[KxClusterCacheStorageConfigurationArgs]

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. See cache_storage_configuration.

capacity_configuration KxClusterCapacityConfigurationArgs

Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.

code KxClusterCodeArgs

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

command_line_arguments Mapping[str, str]

List of key-value pairs to make available inside the cluster.

databases Sequence[KxClusterDatabaseArgs]

KX database that will be available for querying. Defined below.

description str

Description of the cluster.

execution_role str

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.

initialization_script str

Path to Q program that will be run at launch of a cluster. This 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.

name str

Unique name for the cluster that you want to create.

savedown_storage_configuration KxClusterSavedownStorageConfigurationArgs

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

scaling_group_configuration KxClusterScalingGroupConfigurationArgs

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

tags Mapping[str, str]

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tickerplant_log_configurations Sequence[KxClusterTickerplantLogConfigurationArgs]

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.

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.

environmentId String

Unique identifier for the KX environment.

releaseLabel String

Version of FinSpace Managed kdb to run.

type String

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

vpcConfiguration Property Map

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

The following arguments are optional:

autoScalingConfiguration Property Map

Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.

availabilityZoneId String

The availability zone identifiers for the requested regions. Required when az_mode is set to SINGLE.

cacheStorageConfigurations List<Property Map>

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. See cache_storage_configuration.

capacityConfiguration Property Map

Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.

code Property Map

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

commandLineArguments Map<String>

List of key-value pairs to make available inside the cluster.

databases List<Property Map>

KX database that will be available for querying. Defined below.

description String

Description of the cluster.

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.

initializationScript String

Path to Q program that will be run at launch of a cluster. This 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.

name String

Unique name for the cluster that you want to create.

savedownStorageConfiguration Property Map

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

scalingGroupConfiguration Property Map

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

tags Map<String>

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tickerplantLogConfigurations List<Property 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.

Arn string

Amazon Resource Name (ARN) identifier of the KX cluster.

CreatedTimestamp string

Timestamp at which the cluster is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

Id string

The provider-assigned unique ID for this managed resource.

LastModifiedTimestamp string

Last timestamp at which the cluster was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

Status string

StatusReason string

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string

Amazon Resource Name (ARN) identifier of the KX cluster.

CreatedTimestamp string

Timestamp at which the cluster is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

Id string

The provider-assigned unique ID for this managed resource.

LastModifiedTimestamp string

Last timestamp at which the cluster was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

Status string

StatusReason string

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String

Amazon Resource Name (ARN) identifier of the KX cluster.

createdTimestamp String

Timestamp at which the cluster is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

id String

The provider-assigned unique ID for this managed resource.

lastModifiedTimestamp String

Last timestamp at which the cluster was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

status String

statusReason String

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string

Amazon Resource Name (ARN) identifier of the KX cluster.

createdTimestamp string

Timestamp at which the cluster is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

id string

The provider-assigned unique ID for this managed resource.

lastModifiedTimestamp string

Last timestamp at which the cluster was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

status string

statusReason string

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str

Amazon Resource Name (ARN) identifier of the KX cluster.

created_timestamp str

Timestamp at which the cluster is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

id str

The provider-assigned unique ID for this managed resource.

last_modified_timestamp str

Last timestamp at which the cluster was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

status str

status_reason str

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String

Amazon Resource Name (ARN) identifier of the KX cluster.

createdTimestamp String

Timestamp at which the cluster is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

id String

The provider-assigned unique ID for this managed resource.

lastModifiedTimestamp String

Last timestamp at which the cluster was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.

status String

statusReason String

tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

AutoScalingMetric string

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

MaxNodeCount int

Highest number of nodes to scale. Cannot be greater than 5

MetricTarget double

Desired value of chosen auto_scaling_metric. When metric drops below this value, cluster will scale in. When metric goes above this value, cluster will scale out. Can be set between 0 and 100 percent.

MinNodeCount int

Lowest number of nodes to scale. Must be at least 1 and less than the max_node_count. If nodes in cluster belong to multiple availability zones, then min_node_count must be at least 3.

ScaleInCooldownSeconds double

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

ScaleOutCooldownSeconds double

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

AutoScalingMetric string

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

MaxNodeCount int

Highest number of nodes to scale. Cannot be greater than 5

MetricTarget float64

Desired value of chosen auto_scaling_metric. When metric drops below this value, cluster will scale in. When metric goes above this value, cluster will scale out. Can be set between 0 and 100 percent.

MinNodeCount int

Lowest number of nodes to scale. Must be at least 1 and less than the max_node_count. If nodes in cluster belong to multiple availability zones, then min_node_count must be at least 3.

ScaleInCooldownSeconds float64

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

ScaleOutCooldownSeconds float64

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

autoScalingMetric String

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

maxNodeCount Integer

Highest number of nodes to scale. Cannot be greater than 5

metricTarget Double

Desired value of chosen auto_scaling_metric. When metric drops below this value, cluster will scale in. When metric goes above this value, cluster will scale out. Can be set between 0 and 100 percent.

minNodeCount Integer

Lowest number of nodes to scale. Must be at least 1 and less than the max_node_count. If nodes in cluster belong to multiple availability zones, then min_node_count must be at least 3.

scaleInCooldownSeconds Double

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

scaleOutCooldownSeconds Double

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

autoScalingMetric string

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

maxNodeCount number

Highest number of nodes to scale. Cannot be greater than 5

metricTarget number

Desired value of chosen auto_scaling_metric. When metric drops below this value, cluster will scale in. When metric goes above this value, cluster will scale out. Can be set between 0 and 100 percent.

minNodeCount number

Lowest number of nodes to scale. Must be at least 1 and less than the max_node_count. If nodes in cluster belong to multiple availability zones, then min_node_count must be at least 3.

scaleInCooldownSeconds number

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

scaleOutCooldownSeconds number

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

auto_scaling_metric str

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

max_node_count int

Highest number of nodes to scale. Cannot be greater than 5

metric_target float

Desired value of chosen auto_scaling_metric. When metric drops below this value, cluster will scale in. When metric goes above this value, cluster will scale out. Can be set between 0 and 100 percent.

min_node_count int

Lowest number of nodes to scale. Must be at least 1 and less than the max_node_count. If nodes in cluster belong to multiple availability zones, then min_node_count must be at least 3.

scale_in_cooldown_seconds float

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

scale_out_cooldown_seconds float

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

autoScalingMetric String

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

maxNodeCount Number

Highest number of nodes to scale. Cannot be greater than 5

metricTarget Number

Desired value of chosen auto_scaling_metric. When metric drops below this value, cluster will scale in. When metric goes above this value, cluster will scale out. Can be set between 0 and 100 percent.

minNodeCount Number

Lowest number of nodes to scale. Must be at least 1 and less than the max_node_count. If nodes in cluster belong to multiple availability zones, then min_node_count must be at least 3.

scaleInCooldownSeconds Number

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

scaleOutCooldownSeconds Number

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

Size int

Type string

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

Size int

Type string

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

size Integer

type String

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

size number

type string

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

size int

type str

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

size Number

type String

Type of KDB database. The following types are available:

• HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster.
• RDB - 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.

NodeCount int

Number of instances running in a cluster. Must be at least 1 and at most 5.

NodeType string

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 int

Number of instances running in a cluster. Must be at least 1 and at most 5.

NodeType string

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

Number of instances running in a cluster. Must be at least 1 and at most 5.

nodeType String

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 number

Number of instances running in a cluster. Must be at least 1 and at most 5.

nodeType string

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.

node_count int

Number of instances running in a cluster. Must be at least 1 and at most 5.

node_type str

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 Number

Number of instances running in a cluster. Must be at least 1 and at most 5.

nodeType String

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.

S3Bucket string

Unique name for the S3 bucket.

S3Key string

Full S3 path (excluding bucket) to the .zip file that contains the code to be loaded onto the cluster when it’s started.

S3ObjectVersion string

Version of an S3 Object.

S3Bucket string

Unique name for the S3 bucket.

S3Key string

Full S3 path (excluding bucket) to the .zip file that contains the code to be loaded onto the cluster when it’s started.

S3ObjectVersion string

Version of an S3 Object.