Class: Aws::Finspace::Types::KxCluster

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

Overview

The details of a kdb cluster.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone_id ⇒ String

The availability zone identifiers for the requested regions.

Returns:

  • (String) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#az_mode ⇒ String

The number of availability zones assigned 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) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_description ⇒ String

A description of the cluster.

Returns:

  • (String) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

A unique name for the cluster.

Returns:

  • (String) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  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) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#created_timestamp ⇒ Time

The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Returns:

  • (Time) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  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) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  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) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_timestamp ⇒ Time

The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Returns:

  • (Time) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#release_label ⇒ String

A version of the FinSpace managed kdb to run.

Returns:

  • (String) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of a cluster.

  • PENDING – The cluster is pending creation.

  • CREATING –The cluster creation process is in progress.

  • CREATE_FAILED– The cluster creation process has failed.

  • RUNNING – The cluster creation process is running.

  • UPDATING – The cluster is in the process of being updated.

  • DELETING – The cluster is in the process of being deleted.

  • DELETED – The cluster has been deleted.

  • DELETE_FAILED – The cluster failed to delete.

Returns:

  • (String) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The error message when a failed state occurs.

Returns:

  • (String) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#volumes ⇒ Array<Types::Volume>

A list of volumes attached to the cluster.

Returns:



3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/aws-sdk-finspace/types.rb', line 3191

class KxCluster < Struct.new(
  :status,
  :status_reason,
  :cluster_name,
  :cluster_type,
  :cluster_description,
  :release_label,
  :volumes,
  :initialization_script,
  :execution_role,
  :az_mode,
  :availability_zone_id,
  :last_modified_timestamp,
  :created_timestamp)
  SENSITIVE = []
  include Aws::Structure
end