1. Packages
  2. stackit
  3. API Docs
  4. getRedisInstance
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

stackit.getRedisInstance

stackit logo
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

    Redis instance data source schema. Must have a region specified in the provider configuration.

    Example Usage

    data "stackit_redis_instance" "example" {
  project_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  instance_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

    Using getRedisInstance

    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 getRedisInstance(args: GetRedisInstanceArgs, opts?: InvokeOptions): Promise<GetRedisInstanceResult>
function getRedisInstanceOutput(args: GetRedisInstanceOutputArgs, opts?: InvokeOptions): Output<GetRedisInstanceResult>
    def get_redis_instance(instance_id: Optional[str] = None,
                       project_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRedisInstanceResult
def get_redis_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                       project_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRedisInstanceResult]
    func LookupRedisInstance(ctx *Context, args *LookupRedisInstanceArgs, opts ...InvokeOption) (*LookupRedisInstanceResult, error)
func LookupRedisInstanceOutput(ctx *Context, args *LookupRedisInstanceOutputArgs, opts ...InvokeOption) LookupRedisInstanceResultOutput

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

    public static class GetRedisInstance 
{
    public static Task<GetRedisInstanceResult> InvokeAsync(GetRedisInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisInstanceResult> Invoke(GetRedisInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRedisInstanceResult> getRedisInstance(GetRedisInstanceArgs args, InvokeOptions options)
public static Output<GetRedisInstanceResult> getRedisInstance(GetRedisInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: stackit:index/getRedisInstance:getRedisInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    ID of the Redis instance.
    ProjectId string
    STACKIT Project ID to which the instance is associated.
    InstanceId string
    ID of the Redis instance.
    ProjectId string
    STACKIT Project ID to which the instance is associated.
    instanceId String
    ID of the Redis instance.
    projectId String
    STACKIT Project ID to which the instance is associated.
    instanceId string
    ID of the Redis instance.
    projectId string
    STACKIT Project ID to which the instance is associated.
    instance_id str
    ID of the Redis instance.
    project_id str
    STACKIT Project ID to which the instance is associated.
    instanceId String
    ID of the Redis instance.
    projectId String
    STACKIT Project ID to which the instance is associated.

    getRedisInstance Result

    The following output properties are available:

    CfGuid string
    CfOrganizationGuid string
    CfSpaceGuid string
    DashboardUrl string
    Id string
    ImageUrl string
    InstanceId string
    ID of the Redis instance.
    Name string
    Instance name.
    Parameters GetRedisInstanceParameters
    PlanId string
    The selected plan ID.
    PlanName string
    The selected plan name.
    ProjectId string
    STACKIT Project ID to which the instance is associated.
    Version string
    The service version.
    CfGuid string
    CfOrganizationGuid string
    CfSpaceGuid string
    DashboardUrl string
    Id string
    ImageUrl string
    InstanceId string
    ID of the Redis instance.
    Name string
    Instance name.
    Parameters GetRedisInstanceParameters
    PlanId string
    The selected plan ID.
    PlanName string
    The selected plan name.
    ProjectId string
    STACKIT Project ID to which the instance is associated.
    Version string
    The service version.
    cfGuid String
    cfOrganizationGuid String
    cfSpaceGuid String
    dashboardUrl String
    id String
    imageUrl String
    instanceId String
    ID of the Redis instance.
    name String
    Instance name.
    parameters GetRedisInstanceParameters
    planId String
    The selected plan ID.
    planName String
    The selected plan name.
    projectId String
    STACKIT Project ID to which the instance is associated.
    version String
    The service version.
    cfGuid string
    cfOrganizationGuid string
    cfSpaceGuid string
    dashboardUrl string
    id string
    imageUrl string
    instanceId string
    ID of the Redis instance.
    name string
    Instance name.
    parameters GetRedisInstanceParameters
    planId string
    The selected plan ID.
    planName string
    The selected plan name.
    projectId string
    STACKIT Project ID to which the instance is associated.
    version string
    The service version.
    cf_guid str
    cf_organization_guid str
    cf_space_guid str
    dashboard_url str
    id str
    image_url str
    instance_id str
    ID of the Redis instance.
    name str
    Instance name.
    parameters GetRedisInstanceParameters
    plan_id str
    The selected plan ID.
    plan_name str
    The selected plan name.
    project_id str
    STACKIT Project ID to which the instance is associated.
    version str
    The service version.
    cfGuid String
    cfOrganizationGuid String
    cfSpaceGuid String
    dashboardUrl String
    id String
    imageUrl String
    instanceId String
    ID of the Redis instance.
    name String
    Instance name.
    parameters Property Map
    planId String
    The selected plan ID.
    planName String
    The selected plan name.
    projectId String
    STACKIT Project ID to which the instance is associated.
    version String
    The service version.

    Supporting Types

    GetRedisInstanceParameters

    DownAfterMilliseconds int
    The number of milliseconds after which the instance is considered down.
    EnableMonitoring bool
    Enable monitoring.
    FailoverTimeout int
    The failover timeout in milliseconds.
    Graphite string
    Graphite server URL (host and port). If set, monitoring with Graphite will be enabled.
    LazyfreeLazyEviction string
    The lazy eviction enablement (yes or no).
    LazyfreeLazyExpire string
    The lazy expire enablement (yes or no).
    LuaTimeLimit int
    The Lua time limit.
    MaxDiskThreshold int
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    Maxclients int
    The maximum number of clients.
    MaxmemoryPolicy string
    The policy to handle the maximum memory (volatile-lru, noeviction, etc).
    MaxmemorySamples int
    The maximum memory samples.
    MetricsFrequency int
    The frequency in seconds at which metrics are emitted.
    MetricsPrefix string
    The prefix for the metrics. Could be useful when using Graphite monitoring to prefix the metrics with a certain value, like an API key
    MinReplicasMaxLag int
    The minimum replicas maximum lag.
    MonitoringInstanceId string
    The ID of the STACKIT monitoring instance.
    NotifyKeyspaceEvents string
    The notify keyspace events.
    SgwAcl string
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    Snapshot string
    The snapshot configuration.
    Syslogs List<string>
    List of syslog servers to send logs to.
    TlsCiphers List<string>
    List of TLS ciphers to use.
    TlsCiphersuites string
    TLS cipher suites to use.
    TlsProtocols string
    TLS protocol to use.
    DownAfterMilliseconds int
    The number of milliseconds after which the instance is considered down.
    EnableMonitoring bool
    Enable monitoring.
    FailoverTimeout int
    The failover timeout in milliseconds.
    Graphite string
    Graphite server URL (host and port). If set, monitoring with Graphite will be enabled.
    LazyfreeLazyEviction string
    The lazy eviction enablement (yes or no).
    LazyfreeLazyExpire string
    The lazy expire enablement (yes or no).
    LuaTimeLimit int
    The Lua time limit.
    MaxDiskThreshold int
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    Maxclients int
    The maximum number of clients.
    MaxmemoryPolicy string
    The policy to handle the maximum memory (volatile-lru, noeviction, etc).
    MaxmemorySamples int
    The maximum memory samples.
    MetricsFrequency int
    The frequency in seconds at which metrics are emitted.
    MetricsPrefix string
    The prefix for the metrics. Could be useful when using Graphite monitoring to prefix the metrics with a certain value, like an API key
    MinReplicasMaxLag int
    The minimum replicas maximum lag.
    MonitoringInstanceId string
    The ID of the STACKIT monitoring instance.
    NotifyKeyspaceEvents string
    The notify keyspace events.
    SgwAcl string
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    Snapshot string
    The snapshot configuration.
    Syslogs []string
    List of syslog servers to send logs to.
    TlsCiphers []string
    List of TLS ciphers to use.
    TlsCiphersuites string
    TLS cipher suites to use.
    TlsProtocols string
    TLS protocol to use.
    downAfterMilliseconds Integer
    The number of milliseconds after which the instance is considered down.
    enableMonitoring Boolean
    Enable monitoring.
    failoverTimeout Integer
    The failover timeout in milliseconds.
    graphite String
    Graphite server URL (host and port). If set, monitoring with Graphite will be enabled.
    lazyfreeLazyEviction String
    The lazy eviction enablement (yes or no).
    lazyfreeLazyExpire String
    The lazy expire enablement (yes or no).
    luaTimeLimit Integer
    The Lua time limit.
    maxDiskThreshold Integer
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    maxclients Integer
    The maximum number of clients.
    maxmemoryPolicy String
    The policy to handle the maximum memory (volatile-lru, noeviction, etc).
    maxmemorySamples Integer
    The maximum memory samples.
    metricsFrequency Integer
    The frequency in seconds at which metrics are emitted.
    metricsPrefix String
    The prefix for the metrics. Could be useful when using Graphite monitoring to prefix the metrics with a certain value, like an API key
    minReplicasMaxLag Integer
    The minimum replicas maximum lag.
    monitoringInstanceId String
    The ID of the STACKIT monitoring instance.
    notifyKeyspaceEvents String
    The notify keyspace events.
    sgwAcl String
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    snapshot String
    The snapshot configuration.
    syslogs List<String>
    List of syslog servers to send logs to.
    tlsCiphers List<String>
    List of TLS ciphers to use.
    tlsCiphersuites String
    TLS cipher suites to use.
    tlsProtocols String
    TLS protocol to use.
    downAfterMilliseconds number
    The number of milliseconds after which the instance is considered down.
    enableMonitoring boolean
    Enable monitoring.
    failoverTimeout number
    The failover timeout in milliseconds.
    graphite string
    Graphite server URL (host and port). If set, monitoring with Graphite will be enabled.
    lazyfreeLazyEviction string
    The lazy eviction enablement (yes or no).
    lazyfreeLazyExpire string
    The lazy expire enablement (yes or no).
    luaTimeLimit number
    The Lua time limit.
    maxDiskThreshold number
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    maxclients number
    The maximum number of clients.
    maxmemoryPolicy string
    The policy to handle the maximum memory (volatile-lru, noeviction, etc).
    maxmemorySamples number
    The maximum memory samples.
    metricsFrequency number
    The frequency in seconds at which metrics are emitted.
    metricsPrefix string
    The prefix for the metrics. Could be useful when using Graphite monitoring to prefix the metrics with a certain value, like an API key
    minReplicasMaxLag number
    The minimum replicas maximum lag.
    monitoringInstanceId string
    The ID of the STACKIT monitoring instance.
    notifyKeyspaceEvents string
    The notify keyspace events.
    sgwAcl string
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    snapshot string
    The snapshot configuration.
    syslogs string[]
    List of syslog servers to send logs to.
    tlsCiphers string[]
    List of TLS ciphers to use.
    tlsCiphersuites string
    TLS cipher suites to use.
    tlsProtocols string
    TLS protocol to use.
    down_after_milliseconds int
    The number of milliseconds after which the instance is considered down.
    enable_monitoring bool
    Enable monitoring.
    failover_timeout int
    The failover timeout in milliseconds.
    graphite str
    Graphite server URL (host and port). If set, monitoring with Graphite will be enabled.
    lazyfree_lazy_eviction str
    The lazy eviction enablement (yes or no).
    lazyfree_lazy_expire str
    The lazy expire enablement (yes or no).
    lua_time_limit int
    The Lua time limit.
    max_disk_threshold int
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    maxclients int
    The maximum number of clients.
    maxmemory_policy str
    The policy to handle the maximum memory (volatile-lru, noeviction, etc).
    maxmemory_samples int
    The maximum memory samples.
    metrics_frequency int
    The frequency in seconds at which metrics are emitted.
    metrics_prefix str
    The prefix for the metrics. Could be useful when using Graphite monitoring to prefix the metrics with a certain value, like an API key
    min_replicas_max_lag int
    The minimum replicas maximum lag.
    monitoring_instance_id str
    The ID of the STACKIT monitoring instance.
    notify_keyspace_events str
    The notify keyspace events.
    sgw_acl str
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    snapshot str
    The snapshot configuration.
    syslogs Sequence[str]
    List of syslog servers to send logs to.
    tls_ciphers Sequence[str]
    List of TLS ciphers to use.
    tls_ciphersuites str
    TLS cipher suites to use.
    tls_protocols str
    TLS protocol to use.
    downAfterMilliseconds Number
    The number of milliseconds after which the instance is considered down.
    enableMonitoring Boolean
    Enable monitoring.
    failoverTimeout Number
    The failover timeout in milliseconds.
    graphite String
    Graphite server URL (host and port). If set, monitoring with Graphite will be enabled.
    lazyfreeLazyEviction String
    The lazy eviction enablement (yes or no).
    lazyfreeLazyExpire String
    The lazy expire enablement (yes or no).
    luaTimeLimit Number
    The Lua time limit.
    maxDiskThreshold Number
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    maxclients Number
    The maximum number of clients.
    maxmemoryPolicy String
    The policy to handle the maximum memory (volatile-lru, noeviction, etc).
    maxmemorySamples Number
    The maximum memory samples.
    metricsFrequency Number
    The frequency in seconds at which metrics are emitted.
    metricsPrefix String
    The prefix for the metrics. Could be useful when using Graphite monitoring to prefix the metrics with a certain value, like an API key
    minReplicasMaxLag Number
    The minimum replicas maximum lag.
    monitoringInstanceId String
    The ID of the STACKIT monitoring instance.
    notifyKeyspaceEvents String
    The notify keyspace events.
    sgwAcl String
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    snapshot String
    The snapshot configuration.
    syslogs List<String>
    List of syslog servers to send logs to.
    tlsCiphers List<String>
    List of TLS ciphers to use.
    tlsCiphersuites String
    TLS cipher suites to use.
    tlsProtocols String
    TLS protocol to use.

    Package Details

    Repository
    stackit stackitcloud/pulumi-stackit
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the stackit Terraform Provider.
    stackit logo
    Viewing docs for stackit v0.0.4
    published on Friday, Feb 20, 2026 by stackitcloud
    Schema (JSON)
    stackitcloud/pulumi-stackit
      Try Pulumi Cloud free. Your team will thank you.