aws.finspace.KxCluster
Explore with Pulumi AI
Resource for managing an AWS FinSpace Kx Cluster.
Example Usage
Basic Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.finspace.KxCluster;
import com.pulumi.aws.finspace.KxClusterArgs;
import com.pulumi.aws.finspace.inputs.KxClusterCapacityConfigurationArgs;
import com.pulumi.aws.finspace.inputs.KxClusterVpcConfigurationArgs;
import com.pulumi.aws.finspace.inputs.KxClusterCacheStorageConfigurationArgs;
import com.pulumi.aws.finspace.inputs.KxClusterDatabaseArgs;
import com.pulumi.aws.finspace.inputs.KxClusterCodeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new KxCluster("example", KxClusterArgs.builder()
.name("my-tf-kx-cluster")
.environmentId(exampleAwsFinspaceKxEnvironment.id())
.type("HDB")
.releaseLabel("1.0")
.azMode("SINGLE")
.availabilityZoneId("use1-az2")
.capacityConfiguration(KxClusterCapacityConfigurationArgs.builder()
.nodeType("kx.s.2xlarge")
.nodeCount(2)
.build())
.vpcConfiguration(KxClusterVpcConfigurationArgs.builder()
.vpcId(test.id())
.securityGroupIds(exampleAwsSecurityGroup.id())
.subnetIds(exampleAwsSubnet.id())
.ipAddressType("IP_V4")
.build())
.cacheStorageConfigurations(KxClusterCacheStorageConfigurationArgs.builder()
.type("CACHE_1000")
.size(1200)
.build())
.databases(KxClusterDatabaseArgs.builder()
.databaseName(exampleAwsFinspaceKxDatabase.name())
.cacheConfiguration(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build())
.code(KxClusterCodeArgs.builder()
.s3Bucket(testAwsS3Bucket.id())
.s3Key(object.key())
.build())
.build());
}
}
resources:
example:
type: aws:finspace:KxCluster
properties:
name: my-tf-kx-cluster
environmentId: ${exampleAwsFinspaceKxEnvironment.id}
type: HDB
releaseLabel: '1.0'
azMode: SINGLE
availabilityZoneId: use1-az2
capacityConfiguration:
nodeType: kx.s.2xlarge
nodeCount: 2
vpcConfiguration:
vpcId: ${test.id}
securityGroupIds:
- ${exampleAwsSecurityGroup.id}
subnetIds:
- ${exampleAwsSubnet.id}
ipAddressType: IP_V4
cacheStorageConfigurations:
- type: CACHE_1000
size: 1200
databases:
- databaseName: ${exampleAwsFinspaceKxDatabase.name}
cacheConfiguration:
- cacheType: CACHE_1000
dbPaths: /
code:
s3Bucket: ${testAwsS3Bucket.id}
s3Key: ${object.key}
Create KxCluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KxCluster(name: string, args: KxClusterArgs, opts?: CustomResourceOptions);
@overload
def KxCluster(resource_name: str,
args: KxClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KxCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
environment_id: Optional[str] = None,
vpc_configuration: Optional[KxClusterVpcConfigurationArgs] = None,
az_mode: Optional[str] = None,
type: Optional[str] = None,
release_label: Optional[str] = None,
execution_role: Optional[str] = None,
name: Optional[str] = None,
databases: Optional[Sequence[KxClusterDatabaseArgs]] = None,
description: Optional[str] = None,
code: Optional[KxClusterCodeArgs] = None,
auto_scaling_configuration: Optional[KxClusterAutoScalingConfigurationArgs] = None,
initialization_script: Optional[str] = None,
command_line_arguments: Optional[Mapping[str, str]] = None,
capacity_configuration: Optional[KxClusterCapacityConfigurationArgs] = None,
savedown_storage_configuration: Optional[KxClusterSavedownStorageConfigurationArgs] = None,
scaling_group_configuration: Optional[KxClusterScalingGroupConfigurationArgs] = None,
tags: Optional[Mapping[str, str]] = None,
tickerplant_log_configurations: Optional[Sequence[KxClusterTickerplantLogConfigurationArgs]] = None,
cache_storage_configurations: Optional[Sequence[KxClusterCacheStorageConfigurationArgs]] = None,
availability_zone_id: Optional[str] = None)
func NewKxCluster(ctx *Context, name string, args KxClusterArgs, opts ...ResourceOption) (*KxCluster, error)
public KxCluster(string name, KxClusterArgs args, CustomResourceOptions? opts = null)
public KxCluster(String name, KxClusterArgs args)
public KxCluster(String name, KxClusterArgs args, CustomResourceOptions options)
type: aws:finspace:KxCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var kxClusterResource = new Aws.FinSpace.KxCluster("kxClusterResource", new()
{
EnvironmentId = "string",
VpcConfiguration = new Aws.FinSpace.Inputs.KxClusterVpcConfigurationArgs
{
IpAddressType = "string",
SecurityGroupIds = new[]
{
"string",
},
SubnetIds = new[]
{
"string",
},
VpcId = "string",
},
AzMode = "string",
Type = "string",
ReleaseLabel = "string",
ExecutionRole = "string",
Name = "string",
Databases = new[]
{
new Aws.FinSpace.Inputs.KxClusterDatabaseArgs
{
DatabaseName = "string",
CacheConfigurations = new[]
{
new Aws.FinSpace.Inputs.KxClusterDatabaseCacheConfigurationArgs
{
CacheType = "string",
DbPaths = new[]
{
"string",
},
},
},
ChangesetId = "string",
DataviewName = "string",
},
},
Description = "string",
Code = new Aws.FinSpace.Inputs.KxClusterCodeArgs
{
S3Bucket = "string",
S3Key = "string",
S3ObjectVersion = "string",
},
AutoScalingConfiguration = new Aws.FinSpace.Inputs.KxClusterAutoScalingConfigurationArgs
{
AutoScalingMetric = "string",
MaxNodeCount = 0,
MetricTarget = 0,
MinNodeCount = 0,
ScaleInCooldownSeconds = 0,
ScaleOutCooldownSeconds = 0,
},
InitializationScript = "string",
CommandLineArguments =
{
{ "string", "string" },
},
CapacityConfiguration = new Aws.FinSpace.Inputs.KxClusterCapacityConfigurationArgs
{
NodeCount = 0,
NodeType = "string",
},
SavedownStorageConfiguration = new Aws.FinSpace.Inputs.KxClusterSavedownStorageConfigurationArgs
{
Size = 0,
Type = "string",
VolumeName = "string",
},
ScalingGroupConfiguration = new Aws.FinSpace.Inputs.KxClusterScalingGroupConfigurationArgs
{
MemoryReservation = 0,
NodeCount = 0,
ScalingGroupName = "string",
Cpu = 0,
MemoryLimit = 0,
},
Tags =
{
{ "string", "string" },
},
TickerplantLogConfigurations = new[]
{
new Aws.FinSpace.Inputs.KxClusterTickerplantLogConfigurationArgs
{
TickerplantLogVolumes = new[]
{
"string",
},
},
},
CacheStorageConfigurations = new[]
{
new Aws.FinSpace.Inputs.KxClusterCacheStorageConfigurationArgs
{
Size = 0,
Type = "string",
},
},
AvailabilityZoneId = "string",
});
example, err := finspace.NewKxCluster(ctx, "kxClusterResource", &finspace.KxClusterArgs{
EnvironmentId: pulumi.String("string"),
VpcConfiguration: &finspace.KxClusterVpcConfigurationArgs{
IpAddressType: pulumi.String("string"),
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
SubnetIds: pulumi.StringArray{
pulumi.String("string"),
},
VpcId: pulumi.String("string"),
},
AzMode: pulumi.String("string"),
Type: pulumi.String("string"),
ReleaseLabel: pulumi.String("string"),
ExecutionRole: pulumi.String("string"),
Name: pulumi.String("string"),
Databases: finspace.KxClusterDatabaseArray{
&finspace.KxClusterDatabaseArgs{
DatabaseName: pulumi.String("string"),
CacheConfigurations: finspace.KxClusterDatabaseCacheConfigurationArray{
&finspace.KxClusterDatabaseCacheConfigurationArgs{
CacheType: pulumi.String("string"),
DbPaths: pulumi.StringArray{
pulumi.String("string"),
},
},
},
ChangesetId: pulumi.String("string"),
DataviewName: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
Code: &finspace.KxClusterCodeArgs{
S3Bucket: pulumi.String("string"),
S3Key: pulumi.String("string"),
S3ObjectVersion: pulumi.String("string"),
},
AutoScalingConfiguration: &finspace.KxClusterAutoScalingConfigurationArgs{
AutoScalingMetric: pulumi.String("string"),
MaxNodeCount: pulumi.Int(0),
MetricTarget: pulumi.Float64(0),
MinNodeCount: pulumi.Int(0),
ScaleInCooldownSeconds: pulumi.Float64(0),
ScaleOutCooldownSeconds: pulumi.Float64(0),
},
InitializationScript: pulumi.String("string"),
CommandLineArguments: pulumi.StringMap{
"string": pulumi.String("string"),
},
CapacityConfiguration: &finspace.KxClusterCapacityConfigurationArgs{
NodeCount: pulumi.Int(0),
NodeType: pulumi.String("string"),
},
SavedownStorageConfiguration: &finspace.KxClusterSavedownStorageConfigurationArgs{
Size: pulumi.Int(0),
Type: pulumi.String("string"),
VolumeName: pulumi.String("string"),
},
ScalingGroupConfiguration: &finspace.KxClusterScalingGroupConfigurationArgs{
MemoryReservation: pulumi.Int(0),
NodeCount: pulumi.Int(0),
ScalingGroupName: pulumi.String("string"),
Cpu: pulumi.Float64(0),
MemoryLimit: pulumi.Int(0),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TickerplantLogConfigurations: finspace.KxClusterTickerplantLogConfigurationArray{
&finspace.KxClusterTickerplantLogConfigurationArgs{
TickerplantLogVolumes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
CacheStorageConfigurations: finspace.KxClusterCacheStorageConfigurationArray{
&finspace.KxClusterCacheStorageConfigurationArgs{
Size: pulumi.Int(0),
Type: pulumi.String("string"),
},
},
AvailabilityZoneId: pulumi.String("string"),
})
var kxClusterResource = new KxCluster("kxClusterResource", KxClusterArgs.builder()
.environmentId("string")
.vpcConfiguration(KxClusterVpcConfigurationArgs.builder()
.ipAddressType("string")
.securityGroupIds("string")
.subnetIds("string")
.vpcId("string")
.build())
.azMode("string")
.type("string")
.releaseLabel("string")
.executionRole("string")
.name("string")
.databases(KxClusterDatabaseArgs.builder()
.databaseName("string")
.cacheConfigurations(KxClusterDatabaseCacheConfigurationArgs.builder()
.cacheType("string")
.dbPaths("string")
.build())
.changesetId("string")
.dataviewName("string")
.build())
.description("string")
.code(KxClusterCodeArgs.builder()
.s3Bucket("string")
.s3Key("string")
.s3ObjectVersion("string")
.build())
.autoScalingConfiguration(KxClusterAutoScalingConfigurationArgs.builder()
.autoScalingMetric("string")
.maxNodeCount(0)
.metricTarget(0)
.minNodeCount(0)
.scaleInCooldownSeconds(0)
.scaleOutCooldownSeconds(0)
.build())
.initializationScript("string")
.commandLineArguments(Map.of("string", "string"))
.capacityConfiguration(KxClusterCapacityConfigurationArgs.builder()
.nodeCount(0)
.nodeType("string")
.build())
.savedownStorageConfiguration(KxClusterSavedownStorageConfigurationArgs.builder()
.size(0)
.type("string")
.volumeName("string")
.build())
.scalingGroupConfiguration(KxClusterScalingGroupConfigurationArgs.builder()
.memoryReservation(0)
.nodeCount(0)
.scalingGroupName("string")
.cpu(0)
.memoryLimit(0)
.build())
.tags(Map.of("string", "string"))
.tickerplantLogConfigurations(KxClusterTickerplantLogConfigurationArgs.builder()
.tickerplantLogVolumes("string")
.build())
.cacheStorageConfigurations(KxClusterCacheStorageConfigurationArgs.builder()
.size(0)
.type("string")
.build())
.availabilityZoneId("string")
.build());
kx_cluster_resource = aws.finspace.KxCluster("kxClusterResource",
environment_id="string",
vpc_configuration={
"ip_address_type": "string",
"security_group_ids": ["string"],
"subnet_ids": ["string"],
"vpc_id": "string",
},
az_mode="string",
type="string",
release_label="string",
execution_role="string",
name="string",
databases=[{
"database_name": "string",
"cache_configurations": [{
"cache_type": "string",
"db_paths": ["string"],
}],
"changeset_id": "string",
"dataview_name": "string",
}],
description="string",
code={
"s3_bucket": "string",
"s3_key": "string",
"s3_object_version": "string",
},
auto_scaling_configuration={
"auto_scaling_metric": "string",
"max_node_count": 0,
"metric_target": 0,
"min_node_count": 0,
"scale_in_cooldown_seconds": 0,
"scale_out_cooldown_seconds": 0,
},
initialization_script="string",
command_line_arguments={
"string": "string",
},
capacity_configuration={
"node_count": 0,
"node_type": "string",
},
savedown_storage_configuration={
"size": 0,
"type": "string",
"volume_name": "string",
},
scaling_group_configuration={
"memory_reservation": 0,
"node_count": 0,
"scaling_group_name": "string",
"cpu": 0,
"memory_limit": 0,
},
tags={
"string": "string",
},
tickerplant_log_configurations=[{
"tickerplant_log_volumes": ["string"],
}],
cache_storage_configurations=[{
"size": 0,
"type": "string",
}],
availability_zone_id="string")
const kxClusterResource = new aws.finspace.KxCluster("kxClusterResource", {
environmentId: "string",
vpcConfiguration: {
ipAddressType: "string",
securityGroupIds: ["string"],
subnetIds: ["string"],
vpcId: "string",
},
azMode: "string",
type: "string",
releaseLabel: "string",
executionRole: "string",
name: "string",
databases: [{
databaseName: "string",
cacheConfigurations: [{
cacheType: "string",
dbPaths: ["string"],
}],
changesetId: "string",
dataviewName: "string",
}],
description: "string",
code: {
s3Bucket: "string",
s3Key: "string",
s3ObjectVersion: "string",
},
autoScalingConfiguration: {
autoScalingMetric: "string",
maxNodeCount: 0,
metricTarget: 0,
minNodeCount: 0,
scaleInCooldownSeconds: 0,
scaleOutCooldownSeconds: 0,
},
initializationScript: "string",
commandLineArguments: {
string: "string",
},
capacityConfiguration: {
nodeCount: 0,
nodeType: "string",
},
savedownStorageConfiguration: {
size: 0,
type: "string",
volumeName: "string",
},
scalingGroupConfiguration: {
memoryReservation: 0,
nodeCount: 0,
scalingGroupName: "string",
cpu: 0,
memoryLimit: 0,
},
tags: {
string: "string",
},
tickerplantLogConfigurations: [{
tickerplantLogVolumes: ["string"],
}],
cacheStorageConfigurations: [{
size: 0,
type: "string",
}],
availabilityZoneId: "string",
});
type: aws:finspace:KxCluster
properties:
autoScalingConfiguration:
autoScalingMetric: string
maxNodeCount: 0
metricTarget: 0
minNodeCount: 0
scaleInCooldownSeconds: 0
scaleOutCooldownSeconds: 0
availabilityZoneId: string
azMode: string
cacheStorageConfigurations:
- size: 0
type: string
capacityConfiguration:
nodeCount: 0
nodeType: string
code:
s3Bucket: string
s3Key: string
s3ObjectVersion: string
commandLineArguments:
string: string
databases:
- cacheConfigurations:
- cacheType: string
dbPaths:
- string
changesetId: string
databaseName: string
dataviewName: string
description: string
environmentId: string
executionRole: string
initializationScript: string
name: string
releaseLabel: string
savedownStorageConfiguration:
size: 0
type: string
volumeName: string
scalingGroupConfiguration:
cpu: 0
memoryLimit: 0
memoryReservation: 0
nodeCount: 0
scalingGroupName: string
tags:
string: string
tickerplantLogConfigurations:
- tickerplantLogVolumes:
- string
type: string
vpcConfiguration:
ipAddressType: string
securityGroupIds:
- string
subnetIds:
- string
vpcId: string
KxCluster Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The KxCluster resource accepts the following input properties:
- Az
Mode 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.
- Environment
Id string - Unique identifier for the KX environment.
- Release
Label 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.
- Vpc
Configuration KxCluster Vpc Configuration Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- Auto
Scaling KxConfiguration Cluster Auto Scaling Configuration - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- Availability
Zone stringId - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - Cache
Storage List<KxConfigurations Cluster Cache Storage Configuration> - 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 KxCluster Capacity Configuration - Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.
- Code
Kx
Cluster Code - 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 Dictionary<string, string>Arguments - List of key-value pairs to make available inside the cluster.
- Databases
List<Kx
Cluster Database> - KX database that will be available for querying. Defined below.
- Description string
- Description of the cluster.
- Execution
Role 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.
- Initialization
Script 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.
- Savedown
Storage KxConfiguration Cluster Savedown Storage Configuration - 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 KxConfiguration Cluster Scaling Group Configuration - The structure that stores the configuration details of a scaling group.
- 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. - Tickerplant
Log List<KxConfigurations Cluster Tickerplant Log Configuration> - 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 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.
- Environment
Id string - Unique identifier for the KX environment.
- Release
Label 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.
- Vpc
Configuration KxCluster Vpc Configuration Args Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- Auto
Scaling KxConfiguration Cluster Auto Scaling Configuration Args - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- Availability
Zone stringId - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - Cache
Storage []KxConfigurations Cluster Cache Storage Configuration Args - 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 KxCluster Capacity Configuration Args - Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.
- Code
Kx
Cluster Code Args - 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 map[string]stringArguments - List of key-value pairs to make available inside the cluster.
- Databases
[]Kx
Cluster Database Args - KX database that will be available for querying. Defined below.
- Description string
- Description of the cluster.
- Execution
Role 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.
- Initialization
Script 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.
- Savedown
Storage KxConfiguration Cluster Savedown Storage Configuration Args - 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 KxConfiguration Cluster Scaling Group Configuration Args - The structure that stores the configuration details of a scaling group.
- 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. - Tickerplant
Log []KxConfigurations Cluster Tickerplant Log Configuration Args - 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 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.
- environment
Id String - Unique identifier for the KX environment.
- release
Label 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.
- vpc
Configuration KxCluster Vpc Configuration Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- auto
Scaling KxConfiguration Cluster Auto Scaling Configuration - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- availability
Zone StringId - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - cache
Storage List<KxConfigurations Cluster Cache Storage Configuration> - 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 KxCluster Capacity Configuration - Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.
- code
Kx
Cluster Code - 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 Map<String,String>Arguments - List of key-value pairs to make available inside the cluster.
- databases
List<Kx
Cluster Database> - KX database that will be available for querying. Defined below.
- description String
- Description of the cluster.
- execution
Role 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.
- initialization
Script 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.
- savedown
Storage KxConfiguration Cluster Savedown Storage Configuration - 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 KxConfiguration Cluster Scaling Group Configuration - The structure that stores the configuration details of a scaling group.
- 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. - tickerplant
Log List<KxConfigurations Cluster Tickerplant Log Configuration> - 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 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.
- environment
Id string - Unique identifier for the KX environment.
- release
Label 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.
- vpc
Configuration KxCluster Vpc Configuration Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- auto
Scaling KxConfiguration Cluster Auto Scaling Configuration - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- availability
Zone stringId - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - cache
Storage KxConfigurations Cluster Cache Storage Configuration[] - 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 KxCluster Capacity Configuration - Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.
- code
Kx
Cluster Code - 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 {[key: string]: string}Arguments - List of key-value pairs to make available inside the cluster.
- databases
Kx
Cluster Database[] - KX database that will be available for querying. Defined below.
- description string
- Description of the cluster.
- execution
Role 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.
- initialization
Script 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.
- savedown
Storage KxConfiguration Cluster Savedown Storage Configuration - 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 KxConfiguration Cluster Scaling Group Configuration - The structure that stores the configuration details of a scaling group.
- {[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. - tickerplant
Log KxConfigurations Cluster Tickerplant Log Configuration[] - 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 KxCluster Vpc Configuration Args Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- auto_
scaling_ Kxconfiguration Cluster Auto Scaling Configuration Args - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- availability_
zone_ strid - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - cache_
storage_ Sequence[Kxconfigurations Cluster Cache Storage Configuration Args] - 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 KxCluster Capacity Configuration Args - Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.
- code
Kx
Cluster Code Args - 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_ Mapping[str, str]arguments - List of key-value pairs to make available inside the cluster.
- databases
Sequence[Kx
Cluster Database Args] - 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_ Kxconfiguration Cluster Savedown Storage Configuration Args - 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_ Kxconfiguration Cluster Scaling Group Configuration Args - The structure that stores the configuration details of a scaling group.
- 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_ Sequence[Kxconfigurations Cluster Tickerplant Log Configuration Args] - 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 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.
- environment
Id String - Unique identifier for the KX environment.
- release
Label 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.
- vpc
Configuration Property Map Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- auto
Scaling Property MapConfiguration - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- availability
Zone StringId - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - cache
Storage List<Property Map>Configurations - 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 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.
- command
Line Map<String>Arguments - 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.
- execution
Role 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.
- initialization
Script 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.
- savedown
Storage Property MapConfiguration - 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 Property MapConfiguration - The structure that stores the configuration details of a scaling group.
- 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. - tickerplant
Log List<Property Map>Configurations - 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the KxCluster resource produces the following output properties:
- Arn string
- Amazon Resource Name (ARN) identifier of the KX cluster.
- Created
Timestamp 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.
- Last
Modified stringTimestamp - 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
- Status
Reason string - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- Amazon Resource Name (ARN) identifier of the KX cluster.
- Created
Timestamp 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.
- Last
Modified stringTimestamp - 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
- Status
Reason string - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- Amazon Resource Name (ARN) identifier of the KX cluster.
- created
Timestamp 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.
- last
Modified StringTimestamp - 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
- status
Reason String - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- Amazon Resource Name (ARN) identifier of the KX cluster.
- created
Timestamp 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.
- last
Modified stringTimestamp - 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
- status
Reason string - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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_ strtimestamp - 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 - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- Amazon Resource Name (ARN) identifier of the KX cluster.
- created
Timestamp 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.
- last
Modified StringTimestamp - 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
- status
Reason String - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing KxCluster Resource
Get an existing KxCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: KxClusterState, opts?: CustomResourceOptions): KxCluster
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
auto_scaling_configuration: Optional[KxClusterAutoScalingConfigurationArgs] = None,
availability_zone_id: Optional[str] = None,
az_mode: Optional[str] = None,
cache_storage_configurations: Optional[Sequence[KxClusterCacheStorageConfigurationArgs]] = None,
capacity_configuration: Optional[KxClusterCapacityConfigurationArgs] = None,
code: Optional[KxClusterCodeArgs] = None,
command_line_arguments: Optional[Mapping[str, str]] = None,
created_timestamp: Optional[str] = None,
databases: Optional[Sequence[KxClusterDatabaseArgs]] = None,
description: Optional[str] = None,
environment_id: Optional[str] = None,
execution_role: Optional[str] = None,
initialization_script: Optional[str] = None,
last_modified_timestamp: Optional[str] = None,
name: Optional[str] = None,
release_label: Optional[str] = None,
savedown_storage_configuration: Optional[KxClusterSavedownStorageConfigurationArgs] = None,
scaling_group_configuration: Optional[KxClusterScalingGroupConfigurationArgs] = None,
status: Optional[str] = None,
status_reason: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
tickerplant_log_configurations: Optional[Sequence[KxClusterTickerplantLogConfigurationArgs]] = None,
type: Optional[str] = None,
vpc_configuration: Optional[KxClusterVpcConfigurationArgs] = None) -> KxCluster
func GetKxCluster(ctx *Context, name string, id IDInput, state *KxClusterState, opts ...ResourceOption) (*KxCluster, error)
public static KxCluster Get(string name, Input<string> id, KxClusterState? state, CustomResourceOptions? opts = null)
public static KxCluster get(String name, Output<String> id, KxClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Arn string
- Amazon Resource Name (ARN) identifier of the KX cluster.
- Auto
Scaling KxConfiguration Cluster Auto Scaling Configuration - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- Availability
Zone stringId - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - Az
Mode 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.
- Cache
Storage List<KxConfigurations Cluster Cache Storage Configuration> - 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 KxCluster Capacity Configuration - Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.
- Code
Kx
Cluster Code - 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 Dictionary<string, string>Arguments - List of key-value pairs to make available inside the cluster.
- Created
Timestamp 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.
- Databases
List<Kx
Cluster Database> - KX database that will be available for querying. Defined below.
- Description string
- Description of the cluster.
- Environment
Id string - Unique identifier for the KX environment.
- Execution
Role 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.
- Initialization
Script 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.
- Last
Modified stringTimestamp - 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.
- Name string
- Unique name for the cluster that you want to create.
- Release
Label string - Version of FinSpace Managed kdb to run.
- Savedown
Storage KxConfiguration Cluster Savedown Storage Configuration - 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 KxConfiguration Cluster Scaling Group Configuration - The structure that stores the configuration details of a scaling group.
- Status string
- Status
Reason string - 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. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Tickerplant
Log List<KxConfigurations Cluster Tickerplant Log Configuration> - 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.
- 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.
- Vpc
Configuration KxCluster Vpc Configuration Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- Arn string
- Amazon Resource Name (ARN) identifier of the KX cluster.
- Auto
Scaling KxConfiguration Cluster Auto Scaling Configuration Args - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- Availability
Zone stringId - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - Az
Mode 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.
- Cache
Storage []KxConfigurations Cluster Cache Storage Configuration Args - 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 KxCluster Capacity Configuration Args - Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.
- Code
Kx
Cluster Code Args - 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 map[string]stringArguments - List of key-value pairs to make available inside the cluster.
- Created
Timestamp 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.
- Databases
[]Kx
Cluster Database Args - KX database that will be available for querying. Defined below.
- Description string
- Description of the cluster.
- Environment
Id string - Unique identifier for the KX environment.
- Execution
Role 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.
- Initialization
Script 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.
- Last
Modified stringTimestamp - 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.
- Name string
- Unique name for the cluster that you want to create.
- Release
Label string - Version of FinSpace Managed kdb to run.
- Savedown
Storage KxConfiguration Cluster Savedown Storage Configuration Args - 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 KxConfiguration Cluster Scaling Group Configuration Args - The structure that stores the configuration details of a scaling group.
- Status string
- Status
Reason string - 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. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Tickerplant
Log []KxConfigurations Cluster Tickerplant Log Configuration Args - 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.
- 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.
- Vpc
Configuration KxCluster Vpc Configuration Args Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- arn String
- Amazon Resource Name (ARN) identifier of the KX cluster.
- auto
Scaling KxConfiguration Cluster Auto Scaling Configuration - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- availability
Zone StringId - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - az
Mode 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.
- cache
Storage List<KxConfigurations Cluster Cache Storage Configuration> - 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 KxCluster Capacity Configuration - Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.
- code
Kx
Cluster Code - 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 Map<String,String>Arguments - List of key-value pairs to make available inside the cluster.
- created
Timestamp 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.
- databases
List<Kx
Cluster Database> - KX database that will be available for querying. Defined below.
- description String
- Description of the cluster.
- environment
Id String - Unique identifier for the KX environment.
- execution
Role 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.
- initialization
Script 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.
- last
Modified StringTimestamp - 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.
- name String
- Unique name for the cluster that you want to create.
- release
Label String - Version of FinSpace Managed kdb to run.
- savedown
Storage KxConfiguration Cluster Savedown Storage Configuration - 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 KxConfiguration Cluster Scaling Group Configuration - The structure that stores the configuration details of a scaling group.
- status String
- status
Reason String - 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. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - tickerplant
Log List<KxConfigurations Cluster Tickerplant Log Configuration> - 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.
- 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.
- vpc
Configuration KxCluster Vpc Configuration Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- arn string
- Amazon Resource Name (ARN) identifier of the KX cluster.
- auto
Scaling KxConfiguration Cluster Auto Scaling Configuration - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- availability
Zone stringId - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - az
Mode 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.
- cache
Storage KxConfigurations Cluster Cache Storage Configuration[] - 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 KxCluster Capacity Configuration - Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.
- code
Kx
Cluster Code - 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 {[key: string]: string}Arguments - List of key-value pairs to make available inside the cluster.
- created
Timestamp 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.
- databases
Kx
Cluster Database[] - KX database that will be available for querying. Defined below.
- description string
- Description of the cluster.
- environment
Id string - Unique identifier for the KX environment.
- execution
Role 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.
- initialization
Script 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.
- last
Modified stringTimestamp - 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.
- name string
- Unique name for the cluster that you want to create.
- release
Label string - Version of FinSpace Managed kdb to run.
- savedown
Storage KxConfiguration Cluster Savedown Storage Configuration - 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 KxConfiguration Cluster Scaling Group Configuration - The structure that stores the configuration details of a scaling group.
- status string
- status
Reason string - {[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. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - tickerplant
Log KxConfigurations Cluster Tickerplant Log Configuration[] - 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.
- 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.
- vpc
Configuration KxCluster Vpc Configuration Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- arn str
- Amazon Resource Name (ARN) identifier of the KX cluster.
- auto_
scaling_ Kxconfiguration Cluster Auto Scaling Configuration Args - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- availability_
zone_ strid - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - 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.
- cache_
storage_ Sequence[Kxconfigurations Cluster Cache Storage Configuration Args] - 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 KxCluster Capacity Configuration Args - Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.
- code
Kx
Cluster Code Args - 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_ Mapping[str, str]arguments - List of key-value pairs to make available inside the 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.
- databases
Sequence[Kx
Cluster Database Args] - KX database that will be available for querying. Defined below.
- description str
- Description of the cluster.
- environment_
id str - Unique identifier for the KX environment.
- 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.
- last_
modified_ strtimestamp - 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.
- name str
- Unique name for the cluster that you want to create.
- release_
label str - Version of FinSpace Managed kdb to run.
- savedown_
storage_ Kxconfiguration Cluster Savedown Storage Configuration Args - 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_ Kxconfiguration Cluster Scaling Group Configuration Args - The structure that stores the configuration details of a scaling group.
- status str
- status_
reason str - 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. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - tickerplant_
log_ Sequence[Kxconfigurations Cluster Tickerplant Log Configuration Args] - 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.
- 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 KxCluster Vpc Configuration Args Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
- arn String
- Amazon Resource Name (ARN) identifier of the KX cluster.
- auto
Scaling Property MapConfiguration - Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.
- availability
Zone StringId - The availability zone identifiers for the requested regions. Required when
az_mode
is set to SINGLE. - az
Mode 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.
- cache
Storage List<Property Map>Configurations - 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 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.
- command
Line Map<String>Arguments - List of key-value pairs to make available inside the cluster.
- created
Timestamp 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.
- databases List<Property Map>
- KX database that will be available for querying. Defined below.
- description String
- Description of the cluster.
- environment
Id String - Unique identifier for the KX environment.
- execution
Role 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.
- initialization
Script 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.
- last
Modified StringTimestamp - 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.
- name String
- Unique name for the cluster that you want to create.
- release
Label String - Version of FinSpace Managed kdb to run.
- savedown
Storage Property MapConfiguration - 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 Property MapConfiguration - The structure that stores the configuration details of a scaling group.
- status String
- status
Reason String - 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. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - tickerplant
Log List<Property Map>Configurations - 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.
- 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.
- vpc
Configuration Property Map Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration.
The following arguments are optional:
Supporting Types
KxClusterAutoScalingConfiguration, KxClusterAutoScalingConfigurationArgs
- Auto
Scaling stringMetric - 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 intCount - Highest number of nodes to scale. Cannot be greater than 5
- Metric
Target 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. - Min
Node intCount - 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, thenmin_node_count
must be at least 3. - Scale
In doubleCooldown Seconds - Duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
- Scale
Out doubleCooldown Seconds - Duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
- Auto
Scaling stringMetric - 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 intCount - Highest number of nodes to scale. Cannot be greater than 5
- Metric
Target 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. - Min
Node intCount - 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, thenmin_node_count
must be at least 3. - Scale
In float64Cooldown Seconds - Duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
- Scale
Out float64Cooldown Seconds - Duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
- auto
Scaling StringMetric - 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 IntegerCount - Highest number of nodes to scale. Cannot be greater than 5
- metric
Target 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. - min
Node IntegerCount - 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, thenmin_node_count
must be at least 3. - scale
In DoubleCooldown Seconds - Duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
- scale
Out DoubleCooldown Seconds - Duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
- auto
Scaling stringMetric - 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 numberCount - Highest number of nodes to scale. Cannot be greater than 5
- metric
Target 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. - min
Node numberCount - 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, thenmin_node_count
must be at least 3. - scale
In numberCooldown Seconds - Duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
- scale
Out numberCooldown Seconds - Duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
- auto_
scaling_ strmetric - 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_ intcount - 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_ intcount - 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, thenmin_node_count
must be at least 3. - scale_
in_ floatcooldown_ seconds - Duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
- scale_
out_ floatcooldown_ seconds - Duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
- auto
Scaling StringMetric - 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 NumberCount - Highest number of nodes to scale. Cannot be greater than 5
- metric
Target 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. - min
Node NumberCount - 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, thenmin_node_count
must be at least 3. - scale
In NumberCooldown Seconds - Duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
- scale
Out NumberCooldown Seconds - Duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
KxClusterCacheStorageConfiguration, KxClusterCacheStorageConfigurationArgs
- 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.
KxClusterCapacityConfiguration, KxClusterCapacityConfigurationArgs
- Node
Count int - Number of instances running in a cluster. Must be at least 1 and at most 5.
- Node
Type 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 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 Integer - Number of instances running in a cluster. Must be at least 1 and at most 5.
- node
Type 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 number - Number of instances running in a cluster. Must be at least 1 and at most 5.
- node
Type 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.
- node
Count Number - Number of instances running in a cluster. Must be at least 1 and at most 5.
- node
Type 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.
KxClusterCode, KxClusterCodeArgs
- 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.
- S3Object
Version 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.
- S3Object
Version 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.
- s3Object
Version 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.
- s3Object
Version string - Version of an S3 Object.
- s3_
bucket str - Unique name for the S3 bucket.
- s3_
key str - Full S3 path (excluding bucket) to the .zip file that contains the code to be loaded onto the cluster when it’s started.
- s3_
object_ strversion - 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.
- s3Object
Version String - Version of an S3 Object.
KxClusterDatabase, KxClusterDatabaseArgs
- Database
Name string - Name of the KX database.
- Cache
Configurations List<KxCluster Database Cache Configuration> - Configuration details for the disk cache to increase performance reading from a KX database mounted to the cluster. See cache_configurations.
- Changeset
Id string - A unique identifier of the changeset that is associated with the cluster.
- Dataview
Name string - The name of the dataview to be used for caching historical data on disk. You cannot update to a different dataview name once a cluster is created. Use
lifecycle
ignore_changes
for database to prevent any undesirable behaviors.
- Database
Name string - Name of the KX database.
- Cache
Configurations []KxCluster Database Cache Configuration - Configuration details for the disk cache to increase performance reading from a KX database mounted to the cluster. See cache_configurations.
- Changeset
Id string - A unique identifier of the changeset that is associated with the cluster.
- Dataview
Name string - The name of the dataview to be used for caching historical data on disk. You cannot update to a different dataview name once a cluster is created. Use
lifecycle
ignore_changes
for database to prevent any undesirable behaviors.
- database
Name String - Name of the KX database.
- cache
Configurations List<KxCluster Database Cache Configuration> - Configuration details for the disk cache to increase performance reading from a KX database mounted to the cluster. See cache_configurations.
- changeset
Id String - A unique identifier of the changeset that is associated with the cluster.
- dataview
Name String - The name of the dataview to be used for caching historical data on disk. You cannot update to a different dataview name once a cluster is created. Use
lifecycle
ignore_changes
for database to prevent any undesirable behaviors.
- database
Name string - Name of the KX database.
- cache
Configurations KxCluster Database Cache Configuration[] - Configuration details for the disk cache to increase performance reading from a KX database mounted to the cluster. See cache_configurations.
- changeset
Id string - A unique identifier of the changeset that is associated with the cluster.
- dataview
Name string - The name of the dataview to be used for caching historical data on disk. You cannot update to a different dataview name once a cluster is created. Use
lifecycle
ignore_changes
for database to prevent any undesirable behaviors.
- database_
name str - Name of the KX database.
- cache_
configurations Sequence[KxCluster Database Cache Configuration] - Configuration details for the disk cache to increase performance reading from a KX database mounted to the cluster. See cache_configurations.
- changeset_
id str - A unique identifier of the changeset that is associated with the cluster.
- dataview_
name str - The name of the dataview to be used for caching historical data on disk. You cannot update to a different dataview name once a cluster is created. Use
lifecycle
ignore_changes
for database to prevent any undesirable behaviors.
- database
Name String - Name of the KX database.
- cache
Configurations List<Property Map> - Configuration details for the disk cache to increase performance reading from a KX database mounted to the cluster. See cache_configurations.
- changeset
Id String - A unique identifier of the changeset that is associated with the cluster.
- dataview
Name String - The name of the dataview to be used for caching historical data on disk. You cannot update to a different dataview name once a cluster is created. Use
lifecycle
ignore_changes
for database to prevent any undesirable behaviors.
KxClusterDatabaseCacheConfiguration, KxClusterDatabaseCacheConfigurationArgs
- cache_
type str - Type of disk cache.
- db_
paths Sequence[str] - Paths within the database to cache.
KxClusterSavedownStorageConfiguration, KxClusterSavedownStorageConfigurationArgs
- Size int
- Size of temporary storage in gigabytes. Must be between 10 and 16000.
- Type string
- 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.
- Volume
Name string - The name of the kdb volume that you want to use as writeable save-down storage for clusters.
- Size int
- Size of temporary storage in gigabytes. Must be between 10 and 16000.
- Type string
- 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.
- Volume
Name string - The name of the kdb volume that you want to use as writeable save-down storage for clusters.
- size Integer
- Size of temporary storage in gigabytes. Must be between 10 and 16000.
- type String
- 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.
- volume
Name String - The name of the kdb volume that you want to use as writeable save-down storage for clusters.
- size number
- Size of temporary storage in gigabytes. Must be between 10 and 16000.
- type string
- 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.
- volume
Name string - The name of the kdb volume that you want to use as writeable save-down storage for clusters.
- size int
- Size of temporary storage in gigabytes. Must be between 10 and 16000.
- type str
- 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.
- volume_
name str - The name of the kdb volume that you want to use as writeable save-down storage for clusters.
- size Number
- Size of temporary storage in gigabytes. Must be between 10 and 16000.
- type String
- 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.
- volume
Name String - The name of the kdb volume that you want to use as writeable save-down storage for clusters.
KxClusterScalingGroupConfiguration, KxClusterScalingGroupConfigurationArgs
- Memory
Reservation int - 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.
- Node
Count int - The number of kdb cluster nodes.
- Scaling
Group stringName - A unique identifier for the kdb scaling group.
- Cpu double
- The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.
- Memory
Limit int - An optional hard limit on the amount of memory a kdb cluster can use.
- Memory
Reservation int - 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.
- Node
Count int - The number of kdb cluster nodes.
- Scaling
Group stringName - A unique identifier for the kdb scaling group.
- Cpu float64
- The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.
- Memory
Limit int - An optional hard limit on the amount of memory a kdb cluster can use.
- memory
Reservation Integer - A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group.
- node
Count Integer - The number of kdb cluster nodes.
- scaling
Group StringName - A unique identifier for the kdb scaling group.
- cpu Double
- The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.
- memory
Limit Integer - An optional hard limit on the amount of memory a kdb cluster can use.
- memory
Reservation number - 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.
- node
Count number - The number of kdb cluster nodes.
- scaling
Group stringName - A unique identifier for the kdb scaling group.
- cpu number
- The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.
- memory
Limit number - An optional hard limit on the amount of memory a kdb cluster can use.
- memory_
reservation int - 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.
- node_
count int - The number of kdb cluster nodes.
- scaling_
group_ strname - A unique identifier for the kdb scaling group.
- cpu float
- The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.
- memory_
limit int - An optional hard limit on the amount of memory a kdb cluster can use.
- memory
Reservation Number - 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.
- node
Count Number - The number of kdb cluster nodes.
- scaling
Group StringName - A unique identifier for the kdb scaling group.
- cpu Number
- The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.
- memory
Limit Number - An optional hard limit on the amount of memory a kdb cluster can use.
KxClusterTickerplantLogConfiguration, KxClusterTickerplantLogConfigurationArgs
- Tickerplant
Log List<string>Volumes
- Tickerplant
Log []stringVolumes
- tickerplant
Log List<String>Volumes
- tickerplant
Log string[]Volumes
- tickerplant_
log_ Sequence[str]volumes
- tickerplant
Log List<String>Volumes
KxClusterVpcConfiguration, KxClusterVpcConfigurationArgs
- Ip
Address stringType - IP address type for cluster network configuration parameters. The following type is available: IP_V4 - IP address version 4.
- Security
Group List<string>Ids - Unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
subnet_ids
- (Required) Identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
- Subnet
Ids List<string> - Vpc
Id string - Identifier of the VPC endpoint
- Ip
Address stringType - IP address type for cluster network configuration parameters. The following type is available: IP_V4 - IP address version 4.
- Security
Group []stringIds - Unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
subnet_ids
- (Required) Identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
- Subnet
Ids []string - Vpc
Id string - Identifier of the VPC endpoint
- ip
Address StringType - IP address type for cluster network configuration parameters. The following type is available: IP_V4 - IP address version 4.
- security
Group List<String>Ids - Unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
subnet_ids
- (Required) Identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
- subnet
Ids List<String> - vpc
Id String - Identifier of the VPC endpoint
- ip
Address stringType - IP address type for cluster network configuration parameters. The following type is available: IP_V4 - IP address version 4.
- security
Group string[]Ids - Unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
subnet_ids
- (Required) Identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
- subnet
Ids string[] - vpc
Id string - Identifier of the VPC endpoint
- ip_
address_ strtype - IP address type for cluster network configuration parameters. The following type is available: IP_V4 - IP address version 4.
- security_
group_ Sequence[str]ids - Unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
subnet_ids
- (Required) Identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
- subnet_
ids Sequence[str] - vpc_
id str - Identifier of the VPC endpoint
- ip
Address StringType - IP address type for cluster network configuration parameters. The following type is available: IP_V4 - IP address version 4.
- security
Group List<String>Ids - Unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
subnet_ids
- (Required) Identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
- subnet
Ids List<String> - vpc
Id String - Identifier of the VPC endpoint
Import
Using pulumi import
, import an AWS FinSpace Kx Cluster using the id
(environment ID and cluster name, comma-delimited). For example:
$ pulumi import aws:finspace/kxCluster:KxCluster example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-cluster
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.