Type Alias UpgradeInstanceRequest

UpgradeInstanceRequest: {
    enableHa?: boolean;
    instanceId: string;
    majorUpgradeWorkflow?: DocumentDB.v1beta1.UpgradeInstanceRequestMajorUpgradeWorkflow;
    nodeType?: string;
    region?: Region;
    upgradableVersionId?: string;
    volumeSize?: number;
    volumeType?: DocumentDB.v1beta1.VolumeType;
}

Type declaration

  • OptionalenableHa?: boolean

    Defines whether or not High Availability should be enabled on the Database Instance.

    One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow' could be set.

  • instanceId: string

    UUID of the Database Instance you want to upgrade.

  • OptionalmajorUpgradeWorkflow?: DocumentDB.v1beta1.UpgradeInstanceRequestMajorUpgradeWorkflow

    Upgrade your database engine to a new major version including instance endpoints.

    One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow' could be set.

  • OptionalnodeType?: string

    Node type of the Database Instance you want to upgrade to.

    One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow' could be set.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • OptionalupgradableVersionId?: string

    This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade.

    One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow' could be set.

  • OptionalvolumeSize?: number

    Increase your Block volume size.

    One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow' could be set.

  • OptionalvolumeType?: DocumentDB.v1beta1.VolumeType

    Change your Database Instance storage type.

    One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow' could be set.

Settings