Skip to content

GetKxScalingGroupResponse

Source code in docs_src/capo_finspace/types/get_kx_scaling_group_response.py
class GetKxScalingGroupResponse(TypedDict, closed=True):
    scaling_group_name: NotRequired[
        "capo_finspace.types.kx_scaling_group_name.KxScalingGroupName"
    ]
    """<p>A unique identifier for the kdb scaling group. </p>"""
    scaling_group_arn: NotRequired["capo_finspace.types.arn.arn"]
    """<p> The ARN identifier for the scaling group. </p>"""
    host_type: NotRequired["capo_finspace.types.kx_host_type.KxHostType"]
    """<p> The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.</p> <p>It can have one of the following values:</p> <ul> <li> <p> <code>kx.sg.large</code> – The host type with a configuration of 16 GiB memory and 2 vCPUs.</p> </li> <li> <p> <code>kx.sg.xlarge</code> – The host type with a configuration of 32 GiB memory and 4 vCPUs.</p> </li> <li> <p> <code>kx.sg.2xlarge</code> – The host type with a configuration of 64 GiB memory and 8 vCPUs.</p> </li> <li> <p> <code>kx.sg.4xlarge</code> – The host type with a configuration of 108 GiB memory and 16 vCPUs.</p> </li> <li> <p> <code>kx.sg.8xlarge</code> – The host type with a configuration of 216 GiB memory and 32 vCPUs.</p> </li> <li> <p> <code>kx.sg.16xlarge</code> – The host type with a configuration of 432 GiB memory and 64 vCPUs.</p> </li> <li> <p> <code>kx.sg.32xlarge</code> – The host type with a configuration of 864 GiB memory and 128 vCPUs.</p> </li> <li> <p> <code>kx.sg1.16xlarge</code> – The host type with a configuration of 1949 GiB memory and 64 vCPUs.</p> </li> <li> <p> <code>kx.sg1.24xlarge</code> – The host type with a configuration of 2948 GiB memory and 96 vCPUs.</p> </li> </ul>"""
    clusters: NotRequired["capo_finspace.types.kx_cluster_name_list.KxClusterNameList"]
    """<p> The list of Managed kdb clusters that are currently active in the given scaling group. </p>"""
    availability_zone_id: NotRequired[
        "capo_finspace.types.availability_zone_id.AvailabilityZoneId"
    ]
    """<p>The identifier of the availability zones.</p>"""
    status: NotRequired[
        "capo_finspace.types.kx_scaling_group_status.KxScalingGroupStatus"
    ]
    """<p>The status of scaling group.</p> <ul> <li> <p>CREATING – The scaling group creation is in progress.</p> </li> <li> <p>CREATE_FAILED – The scaling group creation has failed.</p> </li> <li> <p>ACTIVE – The scaling group is active.</p> </li> <li> <p>UPDATING – The scaling group is in the process of being updated.</p> </li> <li> <p>UPDATE_FAILED – The update action failed.</p> </li> <li> <p>DELETING – The scaling group is in the process of being deleted.</p> </li> <li> <p>DELETE_FAILED – The system failed to delete the scaling group.</p> </li> <li> <p>DELETED – The scaling group is successfully deleted.</p> </li> </ul>"""
    status_reason: NotRequired[
        "capo_finspace.types.kx_cluster_status_reason.KxClusterStatusReason"
    ]
    """<p> The error message when a failed state occurs. </p>"""
    last_modified_timestamp: NotRequired["capo_finspace.types.timestamp.Timestamp"]
    """<p> The last time that the scaling group was updated 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. </p>"""
    created_timestamp: NotRequired["capo_finspace.types.timestamp.Timestamp"]
    """<p> The timestamp at which the scaling group 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.</p>"""

availability_zone_id instance-attribute

availability_zone_id: NotRequired[AvailabilityZoneId]

The identifier of the availability zones.

clusters instance-attribute

clusters: NotRequired[KxClusterNameList]

The list of Managed kdb clusters that are currently active in the given scaling group.

created_timestamp instance-attribute

created_timestamp: NotRequired[Timestamp]

The timestamp at which the scaling group 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.

host_type instance-attribute

host_type: NotRequired[KxHostType]

The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

It can have one of the following values:

  • kx.sg.large – The host type with a configuration of 16 GiB memory and 2 vCPUs.

  • kx.sg.xlarge – The host type with a configuration of 32 GiB memory and 4 vCPUs.

  • kx.sg.2xlarge – The host type with a configuration of 64 GiB memory and 8 vCPUs.

  • kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.

  • kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.

  • kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.

  • kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.

  • kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.

  • kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.

last_modified_timestamp instance-attribute

last_modified_timestamp: NotRequired[Timestamp]

The last time that the scaling group was updated 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.

scaling_group_arn instance-attribute

scaling_group_arn: NotRequired[arn]

The ARN identifier for the scaling group.

scaling_group_name instance-attribute

scaling_group_name: NotRequired[KxScalingGroupName]

A unique identifier for the kdb scaling group.

status instance-attribute

status: NotRequired[KxScalingGroupStatus]

The status of scaling group.

  • CREATING – The scaling group creation is in progress.

  • CREATE_FAILED – The scaling group creation has failed.

  • ACTIVE – The scaling group is active.

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

  • UPDATE_FAILED – The update action failed.

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

  • DELETE_FAILED – The system failed to delete the scaling group.

  • DELETED – The scaling group is successfully deleted.

status_reason instance-attribute

status_reason: NotRequired[KxClusterStatusReason]

The error message when a failed state occurs.