KxClusterState class

Input properties used for looking up and filtering KxCluster resources.

Constructors

KxClusterState({Input<String?>? arn, Input<KxClusterAutoScalingConfiguration?>? autoScalingConfiguration, Input<String?>? availabilityZoneId, Input<String?>? azMode, Input<List<KxClusterCacheStorageConfiguration>?>? cacheStorageConfigurations, Input<KxClusterCapacityConfiguration?>? capacityConfiguration, Input<KxClusterCode?>? code, Input<Map<String, String>?>? commandLineArguments, Input<String?>? createdTimestamp, Input<List<KxClusterDatabase>?>? databases, Input<String?>? description, Input<String?>? environmentId, Input<String?>? executionRole, Input<String?>? initializationScript, Input<String?>? lastModifiedTimestamp, Input<String?>? name, Input<String?>? region, Input<String?>? releaseLabel, Input<KxClusterSavedownStorageConfiguration?>? savedownStorageConfiguration, Input<KxClusterScalingGroupConfiguration?>? scalingGroupConfiguration, Input<String?>? status, Input<String?>? statusReason, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<List<KxClusterTickerplantLogConfiguration>?>? tickerplantLogConfigurations, Input<String?>? type, Input<KxClusterVpcConfiguration?>? vpcConfiguration})
Creates a new KxClusterState. arn ARN identifier of the KX cluster. autoScalingConfiguration Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See autoScalingConfiguration Block. availabilityZoneId Availability zone identifiers for the requested regions. Required when azMode is set to SINGLE. azMode Number of availability zones to assign per cluster. Valid values are SINGLE (assigns one availability zone per cluster) and MULTI (assigns all the availability zones per cluster). cacheStorageConfigurations 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 cacheStorageConfigurations Block. capacityConfiguration Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacityConfiguration Block. 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 Block. commandLineArguments List of key-value pairs to make available inside the cluster. createdTimestamp 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 database that will be available for querying. See database Block. description Description of the cluster. environmentId Unique identifier for the KX environment. executionRole IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster. initializationScript 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. lastModifiedTimestamp 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 Unique name for the cluster that you want to create. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. releaseLabel Version of FinSpace Managed kdb to run. savedownStorageConfiguration 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 savedownStorageConfiguration Block. scalingGroupConfiguration Structure that stores the configuration details of a scaling group. See scalingGroupConfiguration Block. status Status of the cluster. statusReason Reason for the cluster status. tags Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. tickerplantLogConfigurations 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. See tickerplantLogConfiguration Block. type Type of KDB database. Valid values are HDB (Historical Database), RDB (Realtime Database, which requires the savedownStorageConfiguration parameter), GATEWAY, GP (general purpose), and Tickerplant. vpcConfiguration Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpcConfiguration Block.
const
KxClusterState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN identifier of the KX cluster.
final
autoScalingConfiguration → Input<KxClusterAutoScalingConfiguration?>?
Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See autoScalingConfiguration Block.
final
availabilityZoneId → Input<String?>?
Availability zone identifiers for the requested regions. Required when azMode is set to SINGLE.
final
azMode → Input<String?>?
Number of availability zones to assign per cluster. Valid values are SINGLE (assigns one availability zone per cluster) and MULTI (assigns all the availability zones per cluster).
final
cacheStorageConfigurations → Input<List<KxClusterCacheStorageConfiguration>?>?
Configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. See cacheStorageConfigurations Block.
final
capacityConfiguration → Input<KxClusterCapacityConfiguration?>?
Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacityConfiguration Block.
final
code → Input<KxClusterCode?>?
Details of the custom code that you want to use inside a cluster when analyzing data. Consists of the S3 source bucket, location, object version, and the relative path from where the custom code is loaded into the cluster. See code Block.
final
commandLineArguments → Input<Map<String, String>?>?
List of key-value pairs to make available inside the cluster.
final
createdTimestamp → Input<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.
final
databases → Input<List<KxClusterDatabase>?>?
KX database that will be available for querying. See database Block.
final
description → Input<String?>?
Description of the cluster.
final
environmentId → Input<String?>?
Unique identifier for the KX environment.
final
executionRole → Input<String?>?
IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
final
hashCode → int
The hash code for this object.
no setterinherited
initializationScript → Input<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.
final
lastModifiedTimestamp → Input<String?>?
Last timestamp at which the cluster was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
final
name → Input<String?>?
Unique name for the cluster that you want to create.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
releaseLabel → Input<String?>?
Version of FinSpace Managed kdb to run.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
savedownStorageConfiguration → Input<KxClusterSavedownStorageConfiguration?>?
Size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose type as RDB. All the data written to this storage space is lost when the cluster node is restarted. See savedownStorageConfiguration Block.
final
scalingGroupConfiguration → Input<KxClusterScalingGroupConfiguration?>?
Structure that stores the configuration details of a scaling group. See scalingGroupConfiguration Block.
final
status → Input<String?>?
Status of the cluster.
final
statusReason → Input<String?>?
Reason for the cluster status.
final
tags → Input<Map<String, String>?>?
Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
tickerplantLogConfigurations → Input<List<KxClusterTickerplantLogConfiguration>?>?
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. See tickerplantLogConfiguration Block.
final
type → Input<String?>?
Type of KDB database. Valid values are HDB (Historical Database), RDB (Realtime Database, which requires the savedownStorageConfiguration parameter), GATEWAY, GP (general purpose), and Tickerplant.
final
vpcConfiguration → Input<KxClusterVpcConfiguration?>?
Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpcConfiguration Block.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited