KxCluster class

Resource for managing an AWS FinSpace Kx Cluster.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.finspace.KxCluster("example", {
    capacityConfiguration: {
        nodeType: "kx.s.2xlarge",
        nodeCount: 2,
    },
    vpcConfiguration: {
        vpcId: test.id,
        securityGroupIds: [exampleAwsSecurityGroup.id],
        subnetIds: [exampleAwsSubnet.id],
        ipAddressType: "IP_V4",
    },
    code: {
        s3Bucket: testAwsS3Bucket.id,
        s3Key: object.key,
    },
    cacheStorageConfigurations: [{
        type: "CACHE_1000",
        size: 1200,
    }],
    databases: [{
        cacheConfiguration: [{
            cacheType: "CACHE_1000",
            dbPaths: "/",
        }],
        databaseName: exampleAwsFinspaceKxDatabase.name,
    }],
    name: "my-tf-kx-cluster",
    environmentId: exampleAwsFinspaceKxEnvironment.id,
    type: "HDB",
    releaseLabel: "1.0",
    azMode: "SINGLE",
    availabilityZoneId: "use1-az2",
}, {
    customTimeouts: {
        create: "18h",
        update: "18h",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.finspace.KxCluster("example",
    capacity_configuration={
        "node_type": "kx.s.2xlarge",
        "node_count": 2,
    },
    vpc_configuration={
        "vpc_id": test["id"],
        "security_group_ids": [example_aws_security_group["id"]],
        "subnet_ids": [example_aws_subnet["id"]],
        "ip_address_type": "IP_V4",
    },
    code={
        "s3_bucket": test_aws_s3_bucket["id"],
        "s3_key": object["key"],
    },
    cache_storage_configurations=[{
        "type": "CACHE_1000",
        "size": 1200,
    }],
    databases=[{
        "cache_configuration": [{
            "cacheType": "CACHE_1000",
            "dbPaths": "/",
        }],
        "database_name": example_aws_finspace_kx_database["name"],
    }],
    name="my-tf-kx-cluster",
    environment_id=example_aws_finspace_kx_environment["id"],
    type="HDB",
    release_label="1.0",
    az_mode="SINGLE",
    availability_zone_id="use1-az2",
    opts = pulumi.ResourceOptions(custom_timeouts=pulumi.CustomTimeouts(create="18h", update="18h")))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.FinSpace.KxCluster("example", new()
    {
        CapacityConfiguration = new Aws.FinSpace.Inputs.KxClusterCapacityConfigurationArgs
        {
            NodeType = "kx.s.2xlarge",
            NodeCount = 2,
        },
        VpcConfiguration = new Aws.FinSpace.Inputs.KxClusterVpcConfigurationArgs
        {
            VpcId = test.Id,
            SecurityGroupIds = new[]
            {
                exampleAwsSecurityGroup.Id,
            },
            SubnetIds = new[]
            {
                exampleAwsSubnet.Id,
            },
            IpAddressType = "IP_V4",
        },
        Code = new Aws.FinSpace.Inputs.KxClusterCodeArgs
        {
            S3Bucket = testAwsS3Bucket.Id,
            S3Key = @object.Key,
        },
        CacheStorageConfigurations = new[]
        {
            new Aws.FinSpace.Inputs.KxClusterCacheStorageConfigurationArgs
            {
                Type = "CACHE_1000",
                Size = 1200,
            },
        },
        Databases = new[]
        {
            new Aws.FinSpace.Inputs.KxClusterDatabaseArgs
            {
                CacheConfiguration = new[]
                {

                    {
                        { "cacheType", "CACHE_1000" },
                        { "dbPaths", "/" },
                    },
                },
                DatabaseName = exampleAwsFinspaceKxDatabase.Name,
            },
        },
        Name = "my-tf-kx-cluster",
        EnvironmentId = exampleAwsFinspaceKxEnvironment.Id,
        Type = "HDB",
        ReleaseLabel = "1.0",
        AzMode = "SINGLE",
        AvailabilityZoneId = "use1-az2",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/finspace"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := finspace.NewKxCluster(ctx, "example", &finspace.KxClusterArgs{
			CapacityConfiguration: &finspace.KxClusterCapacityConfigurationArgs{
				NodeType:  pulumi.String("kx.s.2xlarge"),
				NodeCount: pulumi.Int(2),
			},
			VpcConfiguration: &finspace.KxClusterVpcConfigurationArgs{
				VpcId: pulumi.Any(test.Id),
				SecurityGroupIds: pulumi.StringArray{
					exampleAwsSecurityGroup.Id,
				},
				SubnetIds: pulumi.StringArray{
					exampleAwsSubnet.Id,
				},
				IpAddressType: pulumi.String("IP_V4"),
			},
			Code: &finspace.KxClusterCodeArgs{
				S3Bucket: pulumi.Any(testAwsS3Bucket.Id),
				S3Key:    pulumi.Any(object.Key),
			},
			CacheStorageConfigurations: finspace.KxClusterCacheStorageConfigurationArray{
				&finspace.KxClusterCacheStorageConfigurationArgs{
					Type: pulumi.String("CACHE_1000"),
					Size: pulumi.Int(1200),
				},
			},
			Databases: finspace.KxClusterDatabaseArray{
				&finspace.KxClusterDatabaseArgs{
					CacheConfiguration: []map[string]string{
						{
							"cacheType": "CACHE_1000",
							"dbPaths":   "/",
						},
					},
					DatabaseName: pulumi.Any(exampleAwsFinspaceKxDatabase.Name),
				},
			},
			Name:               pulumi.String("my-tf-kx-cluster"),
			EnvironmentId:      pulumi.Any(exampleAwsFinspaceKxEnvironment.Id),
			Type:               pulumi.String("HDB"),
			ReleaseLabel:       pulumi.String("1.0"),
			AzMode:             pulumi.String("SINGLE"),
			AvailabilityZoneId: pulumi.String("use1-az2"),
		}, pulumi.Timeouts(&pulumi.CustomTimeouts{Create: "18h", Update: "18h"}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_finspace_kxcluster" "example" {
  timeouts {
    create = "18h"
    update = "18h"
  }
  capacity_configuration = {
    node_type  = "kx.s.2xlarge"
    node_count = 2
  }
  vpc_configuration = {
    vpc_id             = test.id
    security_group_ids = [exampleAwsSecurityGroup.id]
    subnet_ids         = [exampleAwsSubnet.id]
    ip_address_type    = "IP_V4"
  }
  code = {
    s3_bucket = testAwsS3Bucket.id
    s3_key    = object.key
  }
  cache_storage_configurations {
    type = "CACHE_1000"
    size = 1200
  }
  databases {
    cache_configuration = [{
      "cacheType" = "CACHE_1000"
      "dbPaths"   = "/"
    }]
    database_name = exampleAwsFinspaceKxDatabase.name
  }
  name                 = "my-tf-kx-cluster"
  environment_id       = exampleAwsFinspaceKxEnvironment.id
  type                 = "HDB"
  release_label        = "1.0"
  az_mode              = "SINGLE"
  availability_zone_id = "use1-az2"
}
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.KxClusterCodeArgs;
import com.pulumi.aws.finspace.inputs.KxClusterCacheStorageConfigurationArgs;
import com.pulumi.aws.finspace.inputs.KxClusterDatabaseArgs;
import com.pulumi.resources.CustomResourceOptions;
import com.pulumi.resources.CustomTimeouts;
import java.util.ArrayList;
import java.util.Arrays;
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()
            .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())
            .code(KxClusterCodeArgs.builder()
                .s3Bucket(testAwsS3Bucket.id())
                .s3Key(object.key())
                .build())
            .cacheStorageConfigurations(KxClusterCacheStorageConfigurationArgs.builder()
                .type("CACHE_1000")
                .size(1200)
                .build())
            .databases(KxClusterDatabaseArgs.builder()
                .cacheConfiguration(Arrays.asList(Map.ofEntries(
                    Map.entry("cacheType", "CACHE_1000"),
                    Map.entry("dbPaths", "/")
                )))
                .databaseName(exampleAwsFinspaceKxDatabase.name())
                .build())
            .name("my-tf-kx-cluster")
            .environmentId(exampleAwsFinspaceKxEnvironment.id())
            .type("HDB")
            .releaseLabel("1.0")
            .azMode("SINGLE")
            .availabilityZoneId("use1-az2")
            .build(), CustomResourceOptions.builder()
                .customTimeouts(CustomTimeouts.builder()
                    .create(CustomTimeouts.parseTimeoutString("18h"))
                    .update(CustomTimeouts.parseTimeoutString("18h"))
                .build())
                .build());

    }
}
resources:
  example:
    type: aws:finspace:KxCluster
    properties:
      capacityConfiguration:
        nodeType: kx.s.2xlarge
        nodeCount: 2
      vpcConfiguration:
        vpcId: ${test.id}
        securityGroupIds:
          - ${exampleAwsSecurityGroup.id}
        subnetIds:
          - ${exampleAwsSubnet.id}
        ipAddressType: IP_V4
      code:
        s3Bucket: ${testAwsS3Bucket.id}
        s3Key: ${object.key}
      cacheStorageConfigurations:
        - type: CACHE_1000
          size: 1200
      databases:
        - cacheConfiguration:
            - cacheType: CACHE_1000
              dbPaths: /
          databaseName: ${exampleAwsFinspaceKxDatabase.name}
      name: my-tf-kx-cluster
      environmentId: ${exampleAwsFinspaceKxEnvironment.id}
      type: HDB
      releaseLabel: '1.0'
      azMode: SINGLE
      availabilityZoneId: use1-az2
    options:
      customTimeouts:
        create: 18h
        update: 18h

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

Constructors

KxCluster(String name, {KxClusterArgs? args, CustomResourceOptions? options})
Creates a new KxCluster. name The Pulumi resource name. args Arguments used to configure this KxCluster. The set of arguments for KxCluster. options Resource options controlling this resource's behavior.
KxCluster.reference(String urn)
Creates a typed reference to an existing KxCluster resource.

Properties

arn ↔ Output<String>
ARN identifier of the KX cluster.
latefinal
autoScalingConfiguration ↔ Output<KxClusterAutoScalingConfiguration?>
Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See autoScalingConfiguration Block.
latefinal
availabilityZoneId ↔ Output<String?>
Availability zone identifiers for the requested regions. Required when azMode is set to SINGLE.
latefinal
azMode ↔ Output<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).
latefinal
cacheStorageConfigurations ↔ Output<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.
latefinal
capacityConfiguration ↔ Output<KxClusterCapacityConfiguration?>
Structure for the metadata of a cluster. Includes information like the CPUs needed, memory of instances, and number of instances. See capacityConfiguration Block.
latefinal
childResources → Set<Resource>
finalinherited
code ↔ Output<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.
latefinal
commandLineArguments ↔ Output<Map<String, String>?>
List of key-value pairs to make available inside the cluster.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdTimestamp ↔ Output<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.
latefinal
databases ↔ Output<List<KxClusterDatabase>?>
KX database that will be available for querying. See database Block.
latefinal
description ↔ Output<String?>
Description of the cluster.
latefinal
environmentId ↔ Output<String>
Unique identifier for the KX environment.
latefinal
executionRole ↔ Output<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.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
initializationScript ↔ Output<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.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
lastModifiedTimestamp ↔ Output<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.
latefinal
name ↔ Output<String>
Unique name for the cluster that you want to create.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
releaseLabel ↔ Output<String>
Version of FinSpace Managed kdb to run.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
savedownStorageConfiguration ↔ Output<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.
latefinal
scalingGroupConfiguration ↔ Output<KxClusterScalingGroupConfiguration?>
Structure that stores the configuration details of a scaling group. See scalingGroupConfiguration Block.
latefinal
status ↔ Output<String>
Status of the cluster.
latefinal
statusReason ↔ Output<String>
Reason for the cluster status.
latefinal
tags ↔ Output<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.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
tickerplantLogConfigurations ↔ Output<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.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<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.
latefinal
urn ↔ Output<String>
latefinalinherited
vpcConfiguration ↔ Output<KxClusterVpcConfiguration>
Configuration details about the network where the Privatelink endpoint of the cluster resides. See vpcConfiguration Block.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

get(String name, Input<String> id, {KxClusterState? state, CustomResourceOptions? options}) → KxCluster
Gets an existing KxCluster resource's state with the given name and id.