Type Alias CreateInstanceRequest

CreateInstanceRequest: {
    backupSameRegion: boolean;
    disableBackup: boolean;
    engine: string;
    initEndpoints?: DocumentDB.v1beta1.EndpointSpec[];
    initSettings?: DocumentDB.v1beta1.InstanceSetting[];
    isHaCluster: boolean;
    name?: string;
    nodeType: string;
    organizationId?: string;
    password: string;
    projectId?: string;
    region?: Region;
    tags?: string[];
    userName: string;
    volumeSize: number;
    volumeType?: DocumentDB.v1beta1.VolumeType;
}

Type declaration

  • backupSameRegion: boolean

    Defines whether to or not to store logical backups in the same region as the Database Instance.

  • disableBackup: boolean

    Defines whether or not backups are disabled.

  • engine: string

    Database engine of the Database Instance.

  • OptionalinitEndpoints?: DocumentDB.v1beta1.EndpointSpec[]

    One or multiple EndpointSpec used to expose your Database Instance. A load_balancer public endpoint is systematically created.

  • OptionalinitSettings?: DocumentDB.v1beta1.InstanceSetting[]

    List of engine settings to be set upon Database Instance initialization.

  • isHaCluster: boolean

    Defines whether or not High-Availability is enabled.

  • Optionalname?: string

    Name of the Database Instance.

  • nodeType: string

    Type of node to use for the Database Instance.

  • OptionalorganizationId?: string

    Deprecated

    Please use project_id instead.

    One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId' could be set.

  • password: string

    Password of the user.

  • OptionalprojectId?: string

    The Project ID on which the Database Instance will be created.

    One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId' could be set.

  • Optionalregion?: Region

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

  • Optionaltags?: string[]

    Tags to apply to the Database Instance.

  • userName: string

    Username created when the Database Instance is created.

  • volumeSize: number

    Volume size when volume_type is not lssd.

  • OptionalvolumeType?: DocumentDB.v1beta1.VolumeType

    Type of volume where data is stored (lssd, bssd, ...).

Settings