PoolPropertiesForPatchUpdate interface
Properties of a HorizonDB pool for update operations.
Properties
| compute |
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. |
| high |
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. |
| node |
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. |
| parameter |
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. |
| scheduled |
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?: PoolComputeModelForPatchUpdate
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?: PoolHighAvailabilityPatch
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?: PoolParameterGroupReferenceForPatchUpdate
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?: ScheduledMaintenancePropertiesForPatchUpdate