Class: Aws::Finspace::Types::CreateKxClusterRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-finspace/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_configuration ⇒ Types::AutoScalingConfiguration

The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_id ⇒ String

The availability zone identifiers for the requested regions.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cache_storage_configurations ⇒ Array<Types::KxCacheStorageConfiguration>

The 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.

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_configuration ⇒ Types::CapacityConfiguration

A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token that ensures idempotency. This token expires in 10 minutes.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_description ⇒ String

A description of the cluster.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

A unique name for the cluster that you want to create.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_type ⇒ String

Specifies the type of KDB database that is being created. The following types are available:

  • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

  • RDB – A 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.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#code ⇒ Types::CodeConfiguration

The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#command_line_arguments ⇒ Array<Types::KxCommandLineArgument>

Defines the key-value pairs to make them available inside the cluster.

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#databases ⇒ Array<Types::KxDatabaseConfiguration>

A list of databases that will be available for querying.

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

A unique identifier for the kdb environment.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#initialization_script ⇒ String

Specifies a Q program that will be run at launch of a cluster. It 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`.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#release_label ⇒ String

The version of FinSpace managed kdb to run.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#savedown_storage_configuration ⇒ Types::KxSavedownStorageConfiguration

The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose ‘clusterType` as RDB. All the data written to this storage space is lost when the cluster node is restarted.

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_group_configuration ⇒ Types::KxScalingGroupConfiguration

The structure that stores the configuration details of a scaling group.

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.

Returns:

  • (Hash<String,String>) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tickerplant_log_configuration ⇒ Types::TickerplantLogConfiguration

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`.

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configuration ⇒ Types::VpcConfiguration

Configuration details about the network where the Privatelink endpoint of the cluster resides.

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/aws-sdk-finspace/types.rb', line 569

class CreateKxClusterRequest < Struct.new(
  :client_token,
  :environment_id,
  :cluster_name,
  :cluster_type,
  :tickerplant_log_configuration,
  :databases,
  :cache_storage_configurations,
  :auto_scaling_configuration,
  :cluster_description,
  :capacity_configuration,
  :release_label,
  :vpc_configuration,
  :initialization_script,
  :command_line_arguments,
  :code,
  :execution_role,
  :savedown_storage_configuration,
  :az_mode,
  :availability_zone_id,
  :tags,
  :scaling_group_configuration)
  SENSITIVE = []
  include Aws::Structure
end