CreateKxClusterRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.finspace.model.CreateKxClusterRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateKxClusterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateKxClusterRequest()

Constructors
Constructor and Description
`CreateKxClusterRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateKxClusterRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`CreateKxClusterRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`CreateKxClusterRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`AutoScalingConfiguration`	`getAutoScalingConfiguration()` The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
`String`	`getAvailabilityZoneId()` The availability zone identifiers for the requested regions.
`String`	`getAzMode()` The number of availability zones you want to assign per cluster.
`List<KxCacheStorageConfiguration>`	`getCacheStorageConfigurations()` The configurations for a read only cache storage associated with a cluster.
`CapacityConfiguration`	`getCapacityConfiguration()` A structure for the metadata of a cluster.
`String`	`getClientToken()` A token that ensures idempotency.
`String`	`getClusterDescription()` A description of the cluster.
`String`	`getClusterName()` A unique name for the cluster that you want to create.
`String`	`getClusterType()` Specifies the type of KDB database that is being created.
`CodeConfiguration`	`getCode()` The details of the custom code that you want to use inside a cluster when analyzing a data.
`List<KxCommandLineArgument>`	`getCommandLineArguments()` Defines the key-value pairs to make them available inside the cluster.
`List<KxDatabaseConfiguration>`	`getDatabases()` A list of databases that will be available for querying.
`String`	`getEnvironmentId()` A unique identifier for the kdb environment.
`String`	`getExecutionRole()` An IAM role that defines a set of permissions associated with a cluster.
`String`	`getInitializationScript()` Specifies a Q program that will be run at launch of a cluster.
`String`	`getReleaseLabel()` The version of FinSpace managed kdb to run.
`KxSavedownStorageConfiguration`	`getSavedownStorageConfiguration()` The size and type of the temporary storage that is used to hold data during the savedown process.
`KxScalingGroupConfiguration`	`getScalingGroupConfiguration()` The structure that stores the configuration details of a scaling group.
`Map<String,String>`	`getTags()` A list of key-value pairs to label the cluster.
`TickerplantLogConfiguration`	`getTickerplantLogConfiguration()` A configuration to store Tickerplant logs.
`VpcConfiguration`	`getVpcConfiguration()` Configuration details about the network where the Privatelink endpoint of the cluster resides.
`int`	`hashCode()`
`void`	`setAutoScalingConfiguration(AutoScalingConfiguration autoScalingConfiguration)` The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
`void`	`setAvailabilityZoneId(String availabilityZoneId)` The availability zone identifiers for the requested regions.
`void`	`setAzMode(String azMode)` The number of availability zones you want to assign per cluster.
`void`	`setCacheStorageConfigurations(Collection<KxCacheStorageConfiguration> cacheStorageConfigurations)` The configurations for a read only cache storage associated with a cluster.
`void`	`setCapacityConfiguration(CapacityConfiguration capacityConfiguration)` A structure for the metadata of a cluster.
`void`	`setClientToken(String clientToken)` A token that ensures idempotency.
`void`	`setClusterDescription(String clusterDescription)` A description of the cluster.
`void`	`setClusterName(String clusterName)` A unique name for the cluster that you want to create.
`void`	`setClusterType(String clusterType)` Specifies the type of KDB database that is being created.
`void`	`setCode(CodeConfiguration code)` The details of the custom code that you want to use inside a cluster when analyzing a data.
`void`	`setCommandLineArguments(Collection<KxCommandLineArgument> commandLineArguments)` Defines the key-value pairs to make them available inside the cluster.
`void`	`setDatabases(Collection<KxDatabaseConfiguration> databases)` A list of databases that will be available for querying.
`void`	`setEnvironmentId(String environmentId)` A unique identifier for the kdb environment.
`void`	`setExecutionRole(String executionRole)` An IAM role that defines a set of permissions associated with a cluster.
`void`	`setInitializationScript(String initializationScript)` Specifies a Q program that will be run at launch of a cluster.
`void`	`setReleaseLabel(String releaseLabel)` The version of FinSpace managed kdb to run.
`void`	`setSavedownStorageConfiguration(KxSavedownStorageConfiguration savedownStorageConfiguration)` The size and type of the temporary storage that is used to hold data during the savedown process.
`void`	`setScalingGroupConfiguration(KxScalingGroupConfiguration scalingGroupConfiguration)` The structure that stores the configuration details of a scaling group.
`void`	`setTags(Map<String,String> tags)` A list of key-value pairs to label the cluster.
`void`	`setTickerplantLogConfiguration(TickerplantLogConfiguration tickerplantLogConfiguration)` A configuration to store Tickerplant logs.
`void`	`setVpcConfiguration(VpcConfiguration vpcConfiguration)` Configuration details about the network where the Privatelink endpoint of the cluster resides.
`String`	`toString()` Returns a string representation of this object.
`CreateKxClusterRequest`	`withAutoScalingConfiguration(AutoScalingConfiguration autoScalingConfiguration)` The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
`CreateKxClusterRequest`	`withAvailabilityZoneId(String availabilityZoneId)` The availability zone identifiers for the requested regions.
`CreateKxClusterRequest`	`withAzMode(KxAzMode azMode)` The number of availability zones you want to assign per cluster.
`CreateKxClusterRequest`	`withAzMode(String azMode)` The number of availability zones you want to assign per cluster.
`CreateKxClusterRequest`	`withCacheStorageConfigurations(Collection<KxCacheStorageConfiguration> cacheStorageConfigurations)` The configurations for a read only cache storage associated with a cluster.
`CreateKxClusterRequest`	`withCacheStorageConfigurations(KxCacheStorageConfiguration... cacheStorageConfigurations)` The configurations for a read only cache storage associated with a cluster.
`CreateKxClusterRequest`	`withCapacityConfiguration(CapacityConfiguration capacityConfiguration)` A structure for the metadata of a cluster.
`CreateKxClusterRequest`	`withClientToken(String clientToken)` A token that ensures idempotency.
`CreateKxClusterRequest`	`withClusterDescription(String clusterDescription)` A description of the cluster.
`CreateKxClusterRequest`	`withClusterName(String clusterName)` A unique name for the cluster that you want to create.
`CreateKxClusterRequest`	`withClusterType(KxClusterType clusterType)` Specifies the type of KDB database that is being created.
`CreateKxClusterRequest`	`withClusterType(String clusterType)` Specifies the type of KDB database that is being created.
`CreateKxClusterRequest`	`withCode(CodeConfiguration code)` The details of the custom code that you want to use inside a cluster when analyzing a data.
`CreateKxClusterRequest`	`withCommandLineArguments(Collection<KxCommandLineArgument> commandLineArguments)` Defines the key-value pairs to make them available inside the cluster.
`CreateKxClusterRequest`	`withCommandLineArguments(KxCommandLineArgument... commandLineArguments)` Defines the key-value pairs to make them available inside the cluster.
`CreateKxClusterRequest`	`withDatabases(Collection<KxDatabaseConfiguration> databases)` A list of databases that will be available for querying.
`CreateKxClusterRequest`	`withDatabases(KxDatabaseConfiguration... databases)` A list of databases that will be available for querying.
`CreateKxClusterRequest`	`withEnvironmentId(String environmentId)` A unique identifier for the kdb environment.
`CreateKxClusterRequest`	`withExecutionRole(String executionRole)` An IAM role that defines a set of permissions associated with a cluster.
`CreateKxClusterRequest`	`withInitializationScript(String initializationScript)` Specifies a Q program that will be run at launch of a cluster.
`CreateKxClusterRequest`	`withReleaseLabel(String releaseLabel)` The version of FinSpace managed kdb to run.
`CreateKxClusterRequest`	`withSavedownStorageConfiguration(KxSavedownStorageConfiguration savedownStorageConfiguration)` The size and type of the temporary storage that is used to hold data during the savedown process.
`CreateKxClusterRequest`	`withScalingGroupConfiguration(KxScalingGroupConfiguration scalingGroupConfiguration)` The structure that stores the configuration details of a scaling group.
`CreateKxClusterRequest`	`withTags(Map<String,String> tags)` A list of key-value pairs to label the cluster.
`CreateKxClusterRequest`	`withTickerplantLogConfiguration(TickerplantLogConfiguration tickerplantLogConfiguration)` A configuration to store Tickerplant logs.
`CreateKxClusterRequest`	`withVpcConfiguration(VpcConfiguration vpcConfiguration)` Configuration details about the network where the Privatelink endpoint of the cluster resides.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateKxClusterRequest
```
public CreateKxClusterRequest()
```
- Method Detail
  - setClientToken
```
public void setClientToken(String clientToken)
```
    A token that ensures idempotency. This token expires in 10 minutes.
    
    Parameters:
    
    clientToken - A token that ensures idempotency. This token expires in 10 minutes.
  - getClientToken
```
public String getClientToken()
```
    A token that ensures idempotency. This token expires in 10 minutes.
    
    Returns:
    
    A token that ensures idempotency. This token expires in 10 minutes.
  - withClientToken
```
public CreateKxClusterRequest withClientToken(String clientToken)
```
    A token that ensures idempotency. This token expires in 10 minutes.
    
    Parameters:
    
    clientToken - A token that ensures idempotency. This token expires in 10 minutes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnvironmentId
```
public void setEnvironmentId(String environmentId)
```
    A unique identifier for the kdb environment.
    
    Parameters:
    
    environmentId - A unique identifier for the kdb environment.
  - getEnvironmentId
```
public String getEnvironmentId()
```
    A unique identifier for the kdb environment.
    
    Returns:
    
    A unique identifier for the kdb environment.
  - withEnvironmentId
```
public CreateKxClusterRequest withEnvironmentId(String environmentId)
```
    A unique identifier for the kdb environment.
    
    Parameters:
    
    environmentId - A unique identifier for the kdb environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterName
```
public void setClusterName(String clusterName)
```
    A unique name for the cluster that you want to create.
    
    Parameters:
    
    clusterName - A unique name for the cluster that you want to create.
  - getClusterName
```
public String getClusterName()
```
    A unique name for the cluster that you want to create.
    
    Returns:
    
    A unique name for the cluster that you want to create.
  - withClusterName
```
public CreateKxClusterRequest withClusterName(String clusterName)
```
    A unique name for the cluster that you want to create.
    
    Parameters:
    
    clusterName - A unique name for the cluster that you want to create.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterType
```
public void setClusterType(String clusterType)
```
    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.
    Parameters:
    clusterType - 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.
    See Also:
    
    KxClusterType
  - getClusterType
```
public String getClusterType()
```
    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:
    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.
    See Also:
    
    KxClusterType
  - withClusterType
```
public CreateKxClusterRequest withClusterType(String clusterType)
```
    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.
    Parameters:
    clusterType - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxClusterType
  - withClusterType
```
public CreateKxClusterRequest withClusterType(KxClusterType clusterType)
```
    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.
    Parameters:
    clusterType - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxClusterType
  - setTickerplantLogConfiguration
```
public void setTickerplantLogConfiguration(TickerplantLogConfiguration 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.
    
    Parameters:
    
    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.
  - getTickerplantLogConfiguration
```
public TickerplantLogConfiguration getTickerplantLogConfiguration()
```
    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:
    
    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.
  - withTickerplantLogConfiguration
```
public CreateKxClusterRequest withTickerplantLogConfiguration(TickerplantLogConfiguration 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDatabases
```
public List<KxDatabaseConfiguration> getDatabases()
```
    A list of databases that will be available for querying.
    
    Returns:
    
    A list of databases that will be available for querying.
  - setDatabases
```
public void setDatabases(Collection<KxDatabaseConfiguration> databases)
```
    A list of databases that will be available for querying.
    
    Parameters:
    
    databases - A list of databases that will be available for querying.
  - withDatabases
```
public CreateKxClusterRequest withDatabases(KxDatabaseConfiguration... databases)
```
    A list of databases that will be available for querying.
    
    NOTE: This method appends the values to the existing list (if any). Use setDatabases(java.util.Collection) or withDatabases(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    databases - A list of databases that will be available for querying.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDatabases
```
public CreateKxClusterRequest withDatabases(Collection<KxDatabaseConfiguration> databases)
```
    A list of databases that will be available for querying.
    
    Parameters:
    
    databases - A list of databases that will be available for querying.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCacheStorageConfigurations
```
public List<KxCacheStorageConfiguration> getCacheStorageConfigurations()
```
    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:
    
    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.
  - setCacheStorageConfigurations
```
public void setCacheStorageConfigurations(Collection<KxCacheStorageConfiguration> cacheStorageConfigurations)
```
    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.
    
    Parameters:
    
    cacheStorageConfigurations - 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.
  - withCacheStorageConfigurations
```
public CreateKxClusterRequest withCacheStorageConfigurations(KxCacheStorageConfiguration... cacheStorageConfigurations)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setCacheStorageConfigurations(java.util.Collection) or withCacheStorageConfigurations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    cacheStorageConfigurations - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCacheStorageConfigurations
```
public CreateKxClusterRequest withCacheStorageConfigurations(Collection<KxCacheStorageConfiguration> cacheStorageConfigurations)
```
    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.
    
    Parameters:
    
    cacheStorageConfigurations - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutoScalingConfiguration
```
public void setAutoScalingConfiguration(AutoScalingConfiguration autoScalingConfiguration)
```
    The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
    
    Parameters:
    
    autoScalingConfiguration - The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
  - getAutoScalingConfiguration
```
public AutoScalingConfiguration getAutoScalingConfiguration()
```
    The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
    
    Returns:
    
    The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
  - withAutoScalingConfiguration
```
public CreateKxClusterRequest withAutoScalingConfiguration(AutoScalingConfiguration autoScalingConfiguration)
```
    The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
    
    Parameters:
    
    autoScalingConfiguration - The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterDescription
```
public void setClusterDescription(String clusterDescription)
```
    A description of the cluster.
    
    Parameters:
    
    clusterDescription - A description of the cluster.
  - getClusterDescription
```
public String getClusterDescription()
```
    A description of the cluster.
    
    Returns:
    
    A description of the cluster.
  - withClusterDescription
```
public CreateKxClusterRequest withClusterDescription(String clusterDescription)
```
    A description of the cluster.
    
    Parameters:
    
    clusterDescription - A description of the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCapacityConfiguration
```
public void setCapacityConfiguration(CapacityConfiguration capacityConfiguration)
```
    A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
    
    Parameters:
    
    capacityConfiguration - A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
  - getCapacityConfiguration
```
public CapacityConfiguration getCapacityConfiguration()
```
    A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
    
    Returns:
    
    A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
  - withCapacityConfiguration
```
public CreateKxClusterRequest withCapacityConfiguration(CapacityConfiguration capacityConfiguration)
```
    A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
    
    Parameters:
    
    capacityConfiguration - A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReleaseLabel
```
public void setReleaseLabel(String releaseLabel)
```
    The version of FinSpace managed kdb to run.
    
    Parameters:
    
    releaseLabel - The version of FinSpace managed kdb to run.
  - getReleaseLabel
```
public String getReleaseLabel()
```
    The version of FinSpace managed kdb to run.
    
    Returns:
    
    The version of FinSpace managed kdb to run.
  - withReleaseLabel
```
public CreateKxClusterRequest withReleaseLabel(String releaseLabel)
```
    The version of FinSpace managed kdb to run.
    
    Parameters:
    
    releaseLabel - The version of FinSpace managed kdb to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfiguration
```
public void setVpcConfiguration(VpcConfiguration vpcConfiguration)
```
    Configuration details about the network where the Privatelink endpoint of the cluster resides.
    
    Parameters:
    
    vpcConfiguration - Configuration details about the network where the Privatelink endpoint of the cluster resides.
  - getVpcConfiguration
```
public VpcConfiguration getVpcConfiguration()
```
    Configuration details about the network where the Privatelink endpoint of the cluster resides.
    
    Returns:
    
    Configuration details about the network where the Privatelink endpoint of the cluster resides.
  - withVpcConfiguration
```
public CreateKxClusterRequest withVpcConfiguration(VpcConfiguration vpcConfiguration)
```
    Configuration details about the network where the Privatelink endpoint of the cluster resides.
    
    Parameters:
    
    vpcConfiguration - Configuration details about the network where the Privatelink endpoint of the cluster resides.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInitializationScript
```
public void setInitializationScript(String initializationScript)
```
    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.
    
    Parameters:
    
    initializationScript - 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.
  - getInitializationScript
```
public String getInitializationScript()
```
    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:
    
    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.
  - withInitializationScript
```
public CreateKxClusterRequest withInitializationScript(String initializationScript)
```
    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.
    
    Parameters:
    
    initializationScript - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCommandLineArguments
```
public List<KxCommandLineArgument> getCommandLineArguments()
```
    Defines the key-value pairs to make them available inside the cluster.
    
    Returns:
    
    Defines the key-value pairs to make them available inside the cluster.
  - setCommandLineArguments
```
public void setCommandLineArguments(Collection<KxCommandLineArgument> commandLineArguments)
```
    Defines the key-value pairs to make them available inside the cluster.
    
    Parameters:
    
    commandLineArguments - Defines the key-value pairs to make them available inside the cluster.
  - withCommandLineArguments
```
public CreateKxClusterRequest withCommandLineArguments(KxCommandLineArgument... commandLineArguments)
```
    Defines the key-value pairs to make them available inside the cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setCommandLineArguments(java.util.Collection) or withCommandLineArguments(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    commandLineArguments - Defines the key-value pairs to make them available inside the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCommandLineArguments
```
public CreateKxClusterRequest withCommandLineArguments(Collection<KxCommandLineArgument> commandLineArguments)
```
    Defines the key-value pairs to make them available inside the cluster.
    
    Parameters:
    
    commandLineArguments - Defines the key-value pairs to make them available inside the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCode
```
public void setCode(CodeConfiguration code)
```
    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.
    
    Parameters:
    
    code - 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.
  - getCode
```
public CodeConfiguration getCode()
```
    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:
    
    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.
  - withCode
```
public CreateKxClusterRequest withCode(CodeConfiguration code)
```
    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.
    
    Parameters:
    
    code - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionRole
```
public void setExecutionRole(String executionRole)
```
    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.
    
    Parameters:
    
    executionRole - 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.
  - getExecutionRole
```
public String getExecutionRole()
```
    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:
    
    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.
  - withExecutionRole
```
public CreateKxClusterRequest withExecutionRole(String executionRole)
```
    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.
    
    Parameters:
    
    executionRole - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSavedownStorageConfiguration
```
public void setSavedownStorageConfiguration(KxSavedownStorageConfiguration savedownStorageConfiguration)
```
    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.
    
    Parameters:
    
    savedownStorageConfiguration - 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.
  - getSavedownStorageConfiguration
```
public KxSavedownStorageConfiguration getSavedownStorageConfiguration()
```
    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:
    
    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.
  - withSavedownStorageConfiguration
```
public CreateKxClusterRequest withSavedownStorageConfiguration(KxSavedownStorageConfiguration savedownStorageConfiguration)
```
    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.
    
    Parameters:
    
    savedownStorageConfiguration - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAzMode
```
public void setAzMode(String azMode)
```
    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.
    Parameters:
    azMode - 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.
    See Also:
    
    KxAzMode
  - getAzMode
```
public String getAzMode()
```
    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:
    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.
    See Also:
    
    KxAzMode
  - withAzMode
```
public CreateKxClusterRequest withAzMode(String azMode)
```
    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.
    Parameters:
    azMode - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxAzMode
  - withAzMode
```
public CreateKxClusterRequest withAzMode(KxAzMode azMode)
```
    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.
    Parameters:
    azMode - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxAzMode
  - setAvailabilityZoneId
```
public void setAvailabilityZoneId(String availabilityZoneId)
```
    The availability zone identifiers for the requested regions.
    
    Parameters:
    
    availabilityZoneId - The availability zone identifiers for the requested regions.
  - getAvailabilityZoneId
```
public String getAvailabilityZoneId()
```
    The availability zone identifiers for the requested regions.
    
    Returns:
    
    The availability zone identifiers for the requested regions.
  - withAvailabilityZoneId
```
public CreateKxClusterRequest withAvailabilityZoneId(String availabilityZoneId)
```
    The availability zone identifiers for the requested regions.
    
    Parameters:
    
    availabilityZoneId - The availability zone identifiers for the requested regions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
    
    Returns:
    
    A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
    
    Parameters:
    
    tags - A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
  - withTags
```
public CreateKxClusterRequest withTags(Map<String,String> tags)
```
    A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
    
    Parameters:
    
    tags - A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateKxClusterRequest addTagsEntry(String key,
                                           String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateKxClusterRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScalingGroupConfiguration
```
public void setScalingGroupConfiguration(KxScalingGroupConfiguration scalingGroupConfiguration)
```
    The structure that stores the configuration details of a scaling group.
    
    Parameters:
    
    scalingGroupConfiguration - The structure that stores the configuration details of a scaling group.
  - getScalingGroupConfiguration
```
public KxScalingGroupConfiguration getScalingGroupConfiguration()
```
    The structure that stores the configuration details of a scaling group.
    
    Returns:
    
    The structure that stores the configuration details of a scaling group.
  - withScalingGroupConfiguration
```
public CreateKxClusterRequest withScalingGroupConfiguration(KxScalingGroupConfiguration scalingGroupConfiguration)
```
    The structure that stores the configuration details of a scaling group.
    
    Parameters:
    
    scalingGroupConfiguration - The structure that stores the configuration details of a scaling group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateKxClusterRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.779

Class CreateKxClusterRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateKxClusterRequest

Method Detail

setClientToken

getClientToken

withClientToken

setEnvironmentId

getEnvironmentId

withEnvironmentId

setClusterName

getClusterName

withClusterName

setClusterType

getClusterType

withClusterType

withClusterType

setTickerplantLogConfiguration

getTickerplantLogConfiguration

withTickerplantLogConfiguration

getDatabases

setDatabases

withDatabases

withDatabases

getCacheStorageConfigurations

setCacheStorageConfigurations

withCacheStorageConfigurations

withCacheStorageConfigurations

setAutoScalingConfiguration

getAutoScalingConfiguration

withAutoScalingConfiguration

setClusterDescription

getClusterDescription

withClusterDescription

setCapacityConfiguration

getCapacityConfiguration

withCapacityConfiguration

setReleaseLabel

getReleaseLabel

withReleaseLabel

setVpcConfiguration

getVpcConfiguration

withVpcConfiguration

setInitializationScript

getInitializationScript

withInitializationScript

getCommandLineArguments

setCommandLineArguments

withCommandLineArguments

withCommandLineArguments

setCode

getCode

withCode

setExecutionRole

getExecutionRole

withExecutionRole

setSavedownStorageConfiguration

getSavedownStorageConfiguration

withSavedownStorageConfiguration

setAzMode

getAzMode

withAzMode

withAzMode

setAvailabilityZoneId

getAvailabilityZoneId

withAvailabilityZoneId

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setScalingGroupConfiguration

getScalingGroupConfiguration