Package com.pulumi.aws.finspace.inputs

Class KxClusterState

  • public final class KxClusterState
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        Amazon Resource Name (ARN) identifier of the KX cluster.

      • autoScalingConfiguration

        public java.util.Optional<com.pulumi.core.Output<KxClusterAutoScalingConfigurationArgs>> autoScalingConfiguration()
        Returns:
        Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See auto_scaling_configuration.

      • availabilityZoneId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZoneId()
        Returns:
        The availability zone identifiers for the requested regions. Required when `az_mode` is set to SINGLE.

      • azMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> azMode()
        Returns:
        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.

      • cacheStorageConfigurations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<KxClusterCacheStorageConfigurationArgs>>> cacheStorageConfigurations()
        Returns:
        Configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. See cache_storage_configuration.

      • capacityConfiguration

        public java.util.Optional<com.pulumi.core.Output<KxClusterCapacityConfigurationArgs>> capacityConfiguration()
        Returns:
        Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacity_configuration.

      • code

        public java.util.Optional<com.pulumi.core.Output<KxClusterCodeArgs>> code()
        Returns:
        Details of the custom code that you want to use inside a cluster when analyzing data. Consists of the S3 source bucket, location, object version, and the relative path from where the custom code is loaded into the cluster. See code.

      • commandLineArguments

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> commandLineArguments()
        Returns:
        List of key-value pairs to make available inside the cluster.

      • createdTimestamp

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> createdTimestamp()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.util.List<KxClusterDatabaseArgs>>> databases()
        Returns:
        KX database that will be available for querying. Defined below.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description of the cluster.

      • environmentId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> environmentId()
        Returns:
        Unique identifier for the KX environment.

      • executionRole

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> executionRole()
        Returns:
        An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

      • initializationScript

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> initializationScript()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> lastModifiedTimestamp()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Unique name for the cluster that you want to create.

      • releaseLabel

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> releaseLabel()
        Returns:
        Version of FinSpace Managed kdb to run.

      • savedownStorageConfiguration

        public java.util.Optional<com.pulumi.core.Output<KxClusterSavedownStorageConfigurationArgs>> savedownStorageConfiguration()
        Returns:
        Size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose `type` as RDB. All the data written to this storage space is lost when the cluster node is restarted. See savedown_storage_configuration.

      • scalingGroupConfiguration

        public java.util.Optional<com.pulumi.core.Output<KxClusterScalingGroupConfigurationArgs>> scalingGroupConfiguration()
        Returns:
        The structure that stores the configuration details of a scaling group.

      • status

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()

      • statusReason

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> statusReason()

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Deprecated.
        Please use `tags` instead.
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • tickerplantLogConfigurations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<KxClusterTickerplantLogConfigurationArgs>>> tickerplantLogConfigurations()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> type()
        Returns:
        Type of KDB database. The following types are available: * HDB - Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed KX databases mounted to the cluster. * RDB - Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the `savedownStorageConfiguration` parameter. * GATEWAY - A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage. * GP - A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only `SINGLE` AZ mode. * Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

      • vpcConfiguration

        public java.util.Optional<com.pulumi.core.Output<KxClusterVpcConfigurationArgs>> vpcConfiguration()
        Returns:
        Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpc_configuration. The following arguments are optional: