1. Packages
  2. Upstash
  3. API Docs
  4. getRedisDatabase
Upstash v0.5.0 published on Wednesday, Aug 27, 2025 by Upstash
Schema (JSON)
upstash/pulumi-upstash

upstash.getRedisDatabase

upstash logo
Upstash v0.5.0 published on Wednesday, Aug 27, 2025 by Upstash
Schema (JSON)
upstash/pulumi-upstash

    Using getRedisDatabase

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRedisDatabase(args: GetRedisDatabaseArgs, opts?: InvokeOptions): Promise<GetRedisDatabaseResult>
function getRedisDatabaseOutput(args: GetRedisDatabaseOutputArgs, opts?: InvokeOptions): Output<GetRedisDatabaseResult>
    def get_redis_database(database_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRedisDatabaseResult
def get_redis_database_output(database_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRedisDatabaseResult]
    func LookupRedisDatabase(ctx *Context, args *LookupRedisDatabaseArgs, opts ...InvokeOption) (*LookupRedisDatabaseResult, error)
func LookupRedisDatabaseOutput(ctx *Context, args *LookupRedisDatabaseOutputArgs, opts ...InvokeOption) LookupRedisDatabaseResultOutput

    > Note: This function is named LookupRedisDatabase in the Go SDK.

    public static class GetRedisDatabase 
{
    public static Task<GetRedisDatabaseResult> InvokeAsync(GetRedisDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisDatabaseResult> Invoke(GetRedisDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRedisDatabaseResult> getRedisDatabase(GetRedisDatabaseArgs args, InvokeOptions options)
public static Output<GetRedisDatabaseResult> getRedisDatabase(GetRedisDatabaseArgs args, InvokeOptions options)

    fn::invoke:
  function: upstash:index/getRedisDatabase:getRedisDatabase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatabaseId string
    DatabaseId string
    databaseId String
    databaseId string
    databaseId String

    getRedisDatabase Result

    The following output properties are available:

    AutoScale bool
    Budget int
    Consistent bool

    Deprecated: Consistent option is deprecated.

    CreationTime int
    DatabaseId string
    DatabaseName string
    DatabaseType string
    DbDailyBandwidthLimit int
    DbDiskThreshold int
    DbMaxClients int
    DbMaxCommandsPerSecond int
    DbMaxEntrySize int
    DbMaxRequestSize int
    DbMemoryThreshold int
    Endpoint string
    Eviction bool
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAllowlists List<string>
    Multizone bool

    Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.

    Password string
    Port int
    PrimaryRegion string
    ProdPack bool
    ReadOnlyRestToken string
    ReadRegions List<string>
    Region string
    RestToken string
    State string
    Tls bool

    Deprecated: TLS option is deprecated. It's enabled by default for all databases.

    UserEmail string
    AutoScale bool
    Budget int
    Consistent bool

    Deprecated: Consistent option is deprecated.

    CreationTime int
    DatabaseId string
    DatabaseName string
    DatabaseType string
    DbDailyBandwidthLimit int
    DbDiskThreshold int
    DbMaxClients int
    DbMaxCommandsPerSecond int
    DbMaxEntrySize int
    DbMaxRequestSize int
    DbMemoryThreshold int
    Endpoint string
    Eviction bool
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAllowlists []string
    Multizone bool

    Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.

    Password string
    Port int
    PrimaryRegion string
    ProdPack bool
    ReadOnlyRestToken string
    ReadRegions []string
    Region string
    RestToken string
    State string
    Tls bool

    Deprecated: TLS option is deprecated. It's enabled by default for all databases.

    UserEmail string
    autoScale Boolean
    budget Integer
    consistent Boolean

    Deprecated: Consistent option is deprecated.

    creationTime Integer
    databaseId String
    databaseName String
    databaseType String
    dbDailyBandwidthLimit Integer
    dbDiskThreshold Integer
    dbMaxClients Integer
    dbMaxCommandsPerSecond Integer
    dbMaxEntrySize Integer
    dbMaxRequestSize Integer
    dbMemoryThreshold Integer
    endpoint String
    eviction Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    ipAllowlists List<String>
    multizone Boolean

    Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.

    password String
    port Integer
    primaryRegion String
    prodPack Boolean
    readOnlyRestToken String
    readRegions List<String>
    region String
    restToken String
    state String
    tls Boolean

    Deprecated: TLS option is deprecated. It's enabled by default for all databases.

    userEmail String
    autoScale boolean
    budget number
    consistent boolean

    Deprecated: Consistent option is deprecated.

    creationTime number
    databaseId string
    databaseName string
    databaseType string
    dbDailyBandwidthLimit number
    dbDiskThreshold number
    dbMaxClients number
    dbMaxCommandsPerSecond number
    dbMaxEntrySize number
    dbMaxRequestSize number
    dbMemoryThreshold number
    endpoint string
    eviction boolean
    id string
    The provider-assigned unique ID for this managed resource.
    ipAllowlists string[]
    multizone boolean

    Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.

    password string
    port number
    primaryRegion string
    prodPack boolean
    readOnlyRestToken string
    readRegions string[]
    region string
    restToken string
    state string
    tls boolean

    Deprecated: TLS option is deprecated. It's enabled by default for all databases.

    userEmail string
    auto_scale bool
    budget int
    consistent bool

    Deprecated: Consistent option is deprecated.

    creation_time int
    database_id str
    database_name str
    database_type str
    db_daily_bandwidth_limit int
    db_disk_threshold int
    db_max_clients int
    db_max_commands_per_second int
    db_max_entry_size int
    db_max_request_size int
    db_memory_threshold int
    endpoint str
    eviction bool
    id str
    The provider-assigned unique ID for this managed resource.
    ip_allowlists Sequence[str]
    multizone bool

    Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.

    password str
    port int
    primary_region str
    prod_pack bool
    read_only_rest_token str
    read_regions Sequence[str]
    region str
    rest_token str
    state str
    tls bool

    Deprecated: TLS option is deprecated. It's enabled by default for all databases.

    user_email str
    autoScale Boolean
    budget Number
    consistent Boolean

    Deprecated: Consistent option is deprecated.

    creationTime Number
    databaseId String
    databaseName String
    databaseType String
    dbDailyBandwidthLimit Number
    dbDiskThreshold Number
    dbMaxClients Number
    dbMaxCommandsPerSecond Number
    dbMaxEntrySize Number
    dbMaxRequestSize Number
    dbMemoryThreshold Number
    endpoint String
    eviction Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    ipAllowlists List<String>
    multizone Boolean

    Deprecated: Multizone option is deprecated. It is enabled by default for paid databases.

    password String
    port Number
    primaryRegion String
    prodPack Boolean
    readOnlyRestToken String
    readRegions List<String>
    region String
    restToken String
    state String
    tls Boolean

    Deprecated: TLS option is deprecated. It's enabled by default for all databases.

    userEmail String

    Package Details

    Repository
    upstash upstash/pulumi-upstash
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the upstash Terraform Provider.
    upstash logo
    Upstash v0.5.0 published on Wednesday, Aug 27, 2025 by Upstash
    Schema (JSON)
    upstash/pulumi-upstash
      Meet Neo: Your AI Platform Teammate