Databricks SDK for JavaScript
    Preparing search index...

    Interface DatabaseInstance

    A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.

    interface DatabaseInstance {
        capacity?: string;
        childInstanceRefs?: DatabaseInstanceRef[];
        creationTime?: Instant;
        creator?: string;
        customTags?: CustomTag[];
        effectiveCapacity?: string;
        effectiveCustomTags?: CustomTag[];
        effectiveEnablePgNativeLogin?: boolean;
        effectiveEnableReadableSecondaries?: boolean;
        effectiveNodeCount?: number;
        effectiveRetentionWindowInDays?: number;
        effectiveStopped?: boolean;
        effectiveUsagePolicyId?: string;
        enablePgNativeLogin?: boolean;
        enableReadableSecondaries?: boolean;
        name?: string;
        nodeCount?: number;
        parentInstanceRef?: DatabaseInstanceRef;
        pgVersion?: string;
        readOnlyDns?: string;
        readWriteDns?: string;
        retentionWindowInDays?: number;
        state?: DatabaseInstance_State;
        stopped?: boolean;
        uid?: string;
        usagePolicyId?: string;
    }
    Index

    Properties

    capacity? childInstanceRefs? creationTime? creator? customTags? effectiveCapacity? effectiveCustomTags? effectiveEnablePgNativeLogin? effectiveEnableReadableSecondaries? effectiveNodeCount? effectiveRetentionWindowInDays? effectiveStopped? effectiveUsagePolicyId? enablePgNativeLogin? enableReadableSecondaries? name? nodeCount? parentInstanceRef? pgVersion? readOnlyDns? readWriteDns? retentionWindowInDays? state? stopped? uid? usagePolicyId?

    Properties

    capacity?: string

    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8".

    childInstanceRefs?: DatabaseInstanceRef[]

    The refs of the child instances. This is only available if the instance is parent instance.

    creationTime?: Instant

    The timestamp when the instance was created.

    creator?: string

    The email of the creator of the instance.

    customTags?: CustomTag[]

    Custom tags associated with the instance. This field is only included on create and update responses.

    effectiveCapacity?: string

    Deprecated. The sku of the instance; this field will always match the value of capacity. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value.

    effectiveCustomTags?: CustomTag[]

    The recorded custom tags associated with the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value.

    effectiveEnablePgNativeLogin?: boolean

    Whether the instance has PG native password login enabled. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value.

    effectiveEnableReadableSecondaries?: boolean

    Whether secondaries serving read-only traffic are enabled. Defaults to false. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value.

    effectiveNodeCount?: number

    The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value.

    effectiveRetentionWindowInDays?: number

    The retention window for the instance. This is the time window in days for which the historical data is retained. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value.

    effectiveStopped?: boolean

    Whether the instance is stopped. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value.

    effectiveUsagePolicyId?: string

    The policy that is applied to the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value.

    enablePgNativeLogin?: boolean

    Whether to enable PG native password login on the instance. Defaults to false.

    enableReadableSecondaries?: boolean

    Whether to enable secondaries to serve read-only traffic. Defaults to false.

    name?: string

    The name of the instance. This is the unique identifier for the instance.

    nodeCount?: number

    The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries. This field is input only, see effective_node_count for the output.

    parentInstanceRef?: DatabaseInstanceRef

    The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance.

    pgVersion?: string

    The version of Postgres running on the instance.

    readOnlyDns?: string

    The DNS endpoint to connect to the instance for read only access. This is only available if enable_readable_secondaries is true.

    readWriteDns?: string

    The DNS endpoint to connect to the instance for read+write access.

    retentionWindowInDays?: number

    The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days.

    state?: DatabaseInstance_State

    The current state of the instance.

    stopped?: boolean

    Whether to stop the instance. An input only param, see effective_stopped for the output.

    uid?: string

    An immutable UUID identifier for the instance.

    usagePolicyId?: string

    The desired usage policy to associate with the instance.

    Settings

    Member Visibility

    On This Page

    Properties