PoolPropertiesForPatchUpdateUpdate interface

Properties of a HorizonDB pool for update operations.

Properties

computeModel

The compute model properties to update. Omitted properties preserve their current values. To change the compute model type, supply the complete target compute model, including type, computeProcessor, computeGeneration, and all properties required by the target type.

highAvailability

The high-availability configuration to update. Omission preserves the current mode. The service recursively merges omitted PATCH properties with the existing resource before validating the effective nodeCount and mode together.

nodeCount

The number of nodes to allocate and assign to the pool. Allowed values are 1 through 16. Omission preserves the current configured value. To deallocate runtime compute without changing the configured node count, stop the pool.

parameterGroup

The corresponding default or a customer-created parameter group to associate with the existing pool. Customers can switch in either direction between these group types. Omission preserves the current association.

scheduledMaintenance

The scheduled maintenance configuration to update for the pool. When supplied, the complete configuration for the selected maintenance management type is required. Omission preserves the current configuration.

Property Details

computeModel

The compute model properties to update. Omitted properties preserve their current values. To change the compute model type, supply the complete target compute model, including type, computeProcessor, computeGeneration, and all properties required by the target type.

computeModel?: PoolComputeModelForPatchUpdateUpdate

Property Value

highAvailability

The high-availability configuration to update. Omission preserves the current mode. The service recursively merges omitted PATCH properties with the existing resource before validating the effective nodeCount and mode together.

highAvailability?: PoolHighAvailabilityPatchUpdate

Property Value

nodeCount

The number of nodes to allocate and assign to the pool. Allowed values are 1 through 16. Omission preserves the current configured value. To deallocate runtime compute without changing the configured node count, stop the pool.

nodeCount?: number

Property Value

number

parameterGroup

The corresponding default or a customer-created parameter group to associate with the existing pool. Customers can switch in either direction between these group types. Omission preserves the current association.

parameterGroup?: PoolParameterGroupReferenceForPatchUpdateUpdate

Property Value

scheduledMaintenance

The scheduled maintenance configuration to update for the pool. When supplied, the complete configuration for the selected maintenance management type is required. Omission preserves the current configuration.

scheduledMaintenance?: ScheduledMaintenancePropertiesForPatchUpdateUpdate

Property Value