AwsOpensearchMaintenanceArgs

interface AwsOpensearchMaintenanceArgs {
autoTuneState?: 'ENABLED' | 'DISABLED';
offPeakWindowEnabled?: boolean;
offPeakWindowStartHourUtc?: number;
rollbackOnDisable?: 'NO_ROLLBACK' | 'DEFAULT_ROLLBACK';
useOffPeakWindow?: boolean;
}

Maintenance and Auto-Tune controls for OpenSearch domain operations.

Example

CODE

const maintenance: AwsOpensearchMaintenanceArgs = {
  offPeakWindowEnabled: true,
  offPeakWindowStartHourUtc: 22,
  autoTuneState: 'ENABLED',
  rollbackOnDisable: 'NO_ROLLBACK',
  useOffPeakWindow: true,
};

Properties

`autoTuneState: 'ENABLED' | 'DISABLED'`

Auto-Tune desired state. Defaults to ENABLED.

`offPeakWindowEnabled: boolean`

Enables the off-peak update window. Defaults to true.

`offPeakWindowStartHourUtc: number`

Start hour in UTC for the off-peak window. Must be an integer between 0 and 23. Defaults to 21.

`rollbackOnDisable: 'NO_ROLLBACK' | 'DEFAULT_ROLLBACK'`

Rollback behaviour when Auto-Tune is disabled. Defaults to NO_ROLLBACK.

`useOffPeakWindow: boolean`

Schedules Auto-Tune changes during off-peak windows. Defaults to true.