Resource: aws_finspace_kx_cluster

Terraform resource for managing an AWS FinSpace Kx Cluster.

Example Usage

Basic Usage

resource "aws_finspace_kx_cluster" "example" {
  name                 = "my-tf-kx-cluster"
  environment_id       = aws_finspace_kx_environment.example.id
  type                 = "HDB"
  release_label        = "1.0"
  az_mode              = "SINGLE"
  availability_zone_id = "use1-az2"

  capacity_configuration {
    node_type  = "kx.s.2xlarge"
    node_count = 2
  }

  vpc_configuration {
    vpc_id             = aws_vpc.test.id
    security_group_ids = [aws_security_group.example.id]
    subnet_ids         = [aws_subnet.example.id]
    ip_address_type    = "IP_V4"
  }

  cache_storage_configurations {
    type = "CACHE_1000"
    size = 1200
  }

  database {
    database_name = aws_finspace_kx_database.example.name
    cache_configuration {
      cache_type = "CACHE_1000"
      db_paths   = "/"
    }
  }

  code {
    s3_bucket = aws_s3_bucket.test.id
    s3_key    = aws_s3_object.object.key
  }

  # Depending on the amount of data cached, create/update timeouts 
  # may need to be increased up to a potential maximum of 18 hours.
  timeouts {
    create = "18h"
    update = "18h"
  }
}

Argument Reference

The following arguments are required:

The following arguments are optional:

auto_scaling_configuration

The auto_scaling_configuration block supports the following arguments:

capacity_configuration

The capacity_configuration block supports the following arguments:

cache_storage_configuration

The cache_storage_configuration block supports the following arguments:

Please note that create/update timeouts may have to be adjusted from the default 4 hours depending upon the volume of data being cached, as noted in the example configuration.

code

The code block supports the following arguments:

database

The database block supports the following arguments:

cache_configurations

The cache_configuration block supports the following arguments:

savedown_storage_configuration

The savedown_storage_configuration block supports the following arguments:

vpc_configuration

The vpc_configuration block supports the following arguments:

scaling_group_configuration

The scaling_group_configuration block supports the following arguments:

tickerplant_log_configuration

The tickerplant_log_configuration block supports the following arguments:

Attribute Reference

This resource exports the following attributes in addition to the arguments above:

Timeouts

Configuration options:

Import

In Terraform v1.5.0 and later, use an import block to import an AWS FinSpace Kx Cluster using the id (environment ID and cluster name, comma-delimited). For example:

import {
  to = aws_finspace_kx_cluster.example
  id = "n3ceo7wqxoxcti5tujqwzs,my-tf-kx-cluster"
}

Using terraform import, import an AWS FinSpace Kx Cluster using the id (environment ID and cluster name, comma-delimited). For example:

% terraform import aws_finspace_kx_cluster.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-cluster