KxCluster (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.finspace.model.KxCluster

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The details of a kdb cluster.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KxCluster()

Constructors
Constructor and Description
`KxCluster()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KxCluster`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAvailabilityZoneId()` The availability zone identifiers for the requested regions.
`String`	`getAzMode()` The number of availability zones assigned per cluster.
`String`	`getClusterDescription()` A description of the cluster.
`String`	`getClusterName()` A unique name for the cluster.
`String`	`getClusterType()` Specifies the type of KDB database that is being created.
`Date`	`getCreatedTimestamp()` The timestamp at which the cluster was created in FinSpace.
`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.
`Date`	`getLastModifiedTimestamp()` The last time that the cluster was modified.
`String`	`getReleaseLabel()` A version of the FinSpace managed kdb to run.
`String`	`getStatus()` The status of a cluster.
`String`	`getStatusReason()` The error message when a failed state occurs.
`List<Volume>`	`getVolumes()` A list of volumes attached to the cluster.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAvailabilityZoneId(String availabilityZoneId)` The availability zone identifiers for the requested regions.
`void`	`setAzMode(String azMode)` The number of availability zones assigned per cluster.
`void`	`setClusterDescription(String clusterDescription)` A description of the cluster.
`void`	`setClusterName(String clusterName)` A unique name for the cluster.
`void`	`setClusterType(String clusterType)` Specifies the type of KDB database that is being created.
`void`	`setCreatedTimestamp(Date createdTimestamp)` The timestamp at which the cluster was created in FinSpace.
`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`	`setLastModifiedTimestamp(Date lastModifiedTimestamp)` The last time that the cluster was modified.
`void`	`setReleaseLabel(String releaseLabel)` A version of the FinSpace managed kdb to run.
`void`	`setStatus(String status)` The status of a cluster.
`void`	`setStatusReason(String statusReason)` The error message when a failed state occurs.
`void`	`setVolumes(Collection<Volume> volumes)` A list of volumes attached to the cluster.
`String`	`toString()` Returns a string representation of this object.
`KxCluster`	`withAvailabilityZoneId(String availabilityZoneId)` The availability zone identifiers for the requested regions.
`KxCluster`	`withAzMode(KxAzMode azMode)` The number of availability zones assigned per cluster.
`KxCluster`	`withAzMode(String azMode)` The number of availability zones assigned per cluster.
`KxCluster`	`withClusterDescription(String clusterDescription)` A description of the cluster.
`KxCluster`	`withClusterName(String clusterName)` A unique name for the cluster.
`KxCluster`	`withClusterType(KxClusterType clusterType)` Specifies the type of KDB database that is being created.
`KxCluster`	`withClusterType(String clusterType)` Specifies the type of KDB database that is being created.
`KxCluster`	`withCreatedTimestamp(Date createdTimestamp)` The timestamp at which the cluster was created in FinSpace.
`KxCluster`	`withExecutionRole(String executionRole)` An IAM role that defines a set of permissions associated with a cluster.
`KxCluster`	`withInitializationScript(String initializationScript)` Specifies a Q program that will be run at launch of a cluster.
`KxCluster`	`withLastModifiedTimestamp(Date lastModifiedTimestamp)` The last time that the cluster was modified.
`KxCluster`	`withReleaseLabel(String releaseLabel)` A version of the FinSpace managed kdb to run.
`KxCluster`	`withStatus(KxClusterStatus status)` The status of a cluster.
`KxCluster`	`withStatus(String status)` The status of a cluster.
`KxCluster`	`withStatusReason(String statusReason)` The error message when a failed state occurs.
`KxCluster`	`withVolumes(Collection<Volume> volumes)` A list of volumes attached to the cluster.
`KxCluster`	`withVolumes(Volume... volumes)` A list of volumes attached to the cluster.

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

- Constructor Detail
  - KxCluster
```
public KxCluster()
```
- Method Detail
  - setStatus
```
public void setStatus(String status)
```
    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.
    Parameters:
    status - 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.
    See Also:
    
    KxClusterStatus
  - getStatus
```
public String getStatus()
```
    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:
    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.
    See Also:
    
    KxClusterStatus
  - withStatus
```
public KxCluster withStatus(String status)
```
    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.
    Parameters:
    status - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxClusterStatus
  - withStatus
```
public KxCluster withStatus(KxClusterStatus status)
```
    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.
    Parameters:
    status - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxClusterStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    The error message when a failed state occurs.
    
    Parameters:
    
    statusReason - The error message when a failed state occurs.
  - getStatusReason
```
public String getStatusReason()
```
    The error message when a failed state occurs.
    
    Returns:
    
    The error message when a failed state occurs.
  - withStatusReason
```
public KxCluster withStatusReason(String statusReason)
```
    The error message when a failed state occurs.
    
    Parameters:
    
    statusReason - The error message when a failed state occurs.
    
    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.
    
    Parameters:
    
    clusterName - A unique name for the cluster.
  - getClusterName
```
public String getClusterName()
```
    A unique name for the cluster.
    
    Returns:
    
    A unique name for the cluster.
  - withClusterName
```
public KxCluster withClusterName(String clusterName)
```
    A unique name for the cluster.
    
    Parameters:
    
    clusterName - A unique name for the cluster.
    
    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 KxCluster 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 KxCluster 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
  - 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 KxCluster 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.
  - setReleaseLabel
```
public void setReleaseLabel(String releaseLabel)
```
    A version of the FinSpace managed kdb to run.
    
    Parameters:
    
    releaseLabel - A version of the FinSpace managed kdb to run.
  - getReleaseLabel
```
public String getReleaseLabel()
```
    A version of the FinSpace managed kdb to run.
    
    Returns:
    
    A version of the FinSpace managed kdb to run.
  - withReleaseLabel
```
public KxCluster withReleaseLabel(String releaseLabel)
```
    A version of the FinSpace managed kdb to run.
    
    Parameters:
    
    releaseLabel - A version of the FinSpace managed kdb to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVolumes
```
public List<Volume> getVolumes()
```
    A list of volumes attached to the cluster.
    
    Returns:
    
    A list of volumes attached to the cluster.
  - setVolumes
```
public void setVolumes(Collection<Volume> volumes)
```
    A list of volumes attached to the cluster.
    
    Parameters:
    
    volumes - A list of volumes attached to the cluster.
  - withVolumes
```
public KxCluster withVolumes(Volume... volumes)
```
    A list of volumes attached to the cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setVolumes(java.util.Collection) or withVolumes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    volumes - A list of volumes attached to the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVolumes
```
public KxCluster withVolumes(Collection<Volume> volumes)
```
    A list of volumes attached to the cluster.
    
    Parameters:
    
    volumes - A list of volumes attached to the cluster.
    
    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 KxCluster 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.
  - 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 KxCluster 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.
  - setAzMode
```
public void setAzMode(String azMode)
```
    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.
    Parameters:
    azMode - 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.
    See Also:
    
    KxAzMode
  - getAzMode
```
public String getAzMode()
```
    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:
    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.
    See Also:
    
    KxAzMode
  - withAzMode
```
public KxCluster withAzMode(String azMode)
```
    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.
    Parameters:
    azMode - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxAzMode
  - withAzMode
```
public KxCluster withAzMode(KxAzMode azMode)
```
    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.
    Parameters:
    azMode - 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:
    
    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 KxCluster 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.
  - setLastModifiedTimestamp
```
public void setLastModifiedTimestamp(Date lastModifiedTimestamp)
```
    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.
    
    Parameters:
    
    lastModifiedTimestamp - 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.
  - getLastModifiedTimestamp
```
public Date getLastModifiedTimestamp()
```
    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:
    
    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.
  - withLastModifiedTimestamp
```
public KxCluster withLastModifiedTimestamp(Date lastModifiedTimestamp)
```
    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.
    
    Parameters:
    
    lastModifiedTimestamp - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedTimestamp
```
public void setCreatedTimestamp(Date createdTimestamp)
```
    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.
    
    Parameters:
    
    createdTimestamp - 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.
  - getCreatedTimestamp
```
public Date getCreatedTimestamp()
```
    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:
    
    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.
  - withCreatedTimestamp
```
public KxCluster withCreatedTimestamp(Date createdTimestamp)
```
    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.
    
    Parameters:
    
    createdTimestamp - 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:
    
    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 KxCluster clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class KxCluster

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KxCluster

Method Detail

setStatus

getStatus

withStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setClusterName

getClusterName

withClusterName

setClusterType

getClusterType

withClusterType

withClusterType

setClusterDescription

getClusterDescription

withClusterDescription

setReleaseLabel

getReleaseLabel

withReleaseLabel

getVolumes

setVolumes

withVolumes

withVolumes

setInitializationScript

getInitializationScript

withInitializationScript

setExecutionRole

getExecutionRole

withExecutionRole

setAzMode

getAzMode

withAzMode

withAzMode

setAvailabilityZoneId

getAvailabilityZoneId

withAvailabilityZoneId

setLastModifiedTimestamp

getLastModifiedTimestamp

withLastModifiedTimestamp

setCreatedTimestamp

getCreatedTimestamp

withCreatedTimestamp

toString

equals

hashCode

clone

marshall