Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. stackit
  4. API Docs
  5. getValkeyInstance
Viewing docs for stackit v0.0.8
published on Friday, Oct 16, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

stackit.getValkeyInstance

stackit logo
Viewing docs for stackit v0.0.8
published on Friday, Oct 16, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

    Key Value Store(valkey) instance data source schema. Must have a region specified in the provider configuration.

    Example Usage

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

    Using getValkeyInstance

    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 getValkeyInstance(args: GetValkeyInstanceArgs, opts?: InvokeOptions): Promise<GetValkeyInstanceResult>
function getValkeyInstanceOutput(args: GetValkeyInstanceOutputArgs, opts?: InvokeOutputOptions): Output<GetValkeyInstanceResult>
    def get_valkey_instance(instance_id: Optional[str] = None,
                        project_id: Optional[str] = None,
                        region: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetValkeyInstanceResult
def get_valkey_instance_output(instance_id: pulumi.Input[Optional[str]] = None,
                        project_id: pulumi.Input[Optional[str]] = None,
                        region: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetValkeyInstanceResult]
    func LookupValkeyInstance(ctx *Context, args *LookupValkeyInstanceArgs, opts ...InvokeOption) (*LookupValkeyInstanceResult, error)
func LookupValkeyInstanceOutput(ctx *Context, args *LookupValkeyInstanceOutputArgs, opts ...InvokeOption) LookupValkeyInstanceResultOutput

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

    public static class GetValkeyInstance 
{
    public static Task<GetValkeyInstanceResult> InvokeAsync(GetValkeyInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetValkeyInstanceResult> Invoke(GetValkeyInstanceInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetValkeyInstanceResult> Invoke(GetValkeyInstanceInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetValkeyInstanceResult> getValkeyInstance(GetValkeyInstanceArgs args, InvokeOptions options)
public static Output<GetValkeyInstanceResult> getValkeyInstance(GetValkeyInstanceArgs args, InvokeOptions options)
public static Output<GetValkeyInstanceResult> getValkeyInstance(GetValkeyInstanceArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: stackit:index/getValkeyInstance:getValkeyInstance
  arguments:
    # arguments dictionary
    data "stackit_get_valkey_instance" "name" {
    # arguments
}

    The following arguments are supported:

    InstanceId string
    ID of the Valkey instance.
    ProjectId string
    STACKIT Project ID to which the instance is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    InstanceId string
    ID of the Valkey instance.
    ProjectId string
    STACKIT Project ID to which the instance is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    instance_id string
    ID of the Valkey instance.
    project_id string
    STACKIT Project ID to which the instance is associated.
    region string
    The resource region. If not defined, the provider region is used.
    instanceId String
    ID of the Valkey instance.
    projectId String
    STACKIT Project ID to which the instance is associated.
    region String
    The resource region. If not defined, the provider region is used.
    instanceId string
    ID of the Valkey instance.
    projectId string
    STACKIT Project ID to which the instance is associated.
    region string
    The resource region. If not defined, the provider region is used.
    instance_id str
    ID of the Valkey instance.
    project_id str
    STACKIT Project ID to which the instance is associated.
    region str
    The resource region. If not defined, the provider region is used.
    instanceId String
    ID of the Valkey instance.
    projectId String
    STACKIT Project ID to which the instance is associated.
    region String
    The resource region. If not defined, the provider region is used.

    getValkeyInstance Result

    The following output properties are available:

    CfGuid string
    CfOrganizationGuid string
    CfSpaceGuid string
    DashboardUrl string
    Id string
    Terraform's internal data source. identifier. It is structured as "projectId,region,instanceId".
    ImageUrl string
    InstanceId string
    ID of the Valkey instance.
    Name string
    Instance name.
    Parameters GetValkeyInstanceParameters
    PlanId string
    The selected plan ID.
    PlanName string
    The selected plan name.
    ProjectId string
    STACKIT Project ID to which the instance is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    Version string
    The service version.
    CfGuid string
    CfOrganizationGuid string
    CfSpaceGuid string
    DashboardUrl string
    Id string
    Terraform's internal data source. identifier. It is structured as "projectId,region,instanceId".
    ImageUrl string
    InstanceId string
    ID of the Valkey instance.
    Name string
    Instance name.
    Parameters GetValkeyInstanceParameters
    PlanId string
    The selected plan ID.
    PlanName string
    The selected plan name.
    ProjectId string
    STACKIT Project ID to which the instance is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    Version string
    The service version.
    cf_guid string
    cf_organization_guid string
    cf_space_guid string
    dashboard_url string
    id string
    Terraform's internal data source. identifier. It is structured as "projectId,region,instanceId".
    image_url string
    instance_id string
    ID of the Valkey instance.
    name string
    Instance name.
    parameters object
    plan_id string
    The selected plan ID.
    plan_name string
    The selected plan name.
    project_id string
    STACKIT Project ID to which the instance is associated.
    region string
    The resource region. If not defined, the provider region is used.
    version string
    The service version.
    cfGuid String
    cfOrganizationGuid String
    cfSpaceGuid String
    dashboardUrl String
    id String
    Terraform's internal data source. identifier. It is structured as "projectId,region,instanceId".
    imageUrl String
    instanceId String
    ID of the Valkey instance.
    name String
    Instance name.
    parameters GetValkeyInstanceParameters
    planId String
    The selected plan ID.
    planName String
    The selected plan name.
    projectId String
    STACKIT Project ID to which the instance is associated.
    region String
    The resource region. If not defined, the provider region is used.
    version String
    The service version.
    cfGuid string
    cfOrganizationGuid string
    cfSpaceGuid string
    dashboardUrl string
    id string
    Terraform's internal data source. identifier. It is structured as "projectId,region,instanceId".
    imageUrl string
    instanceId string
    ID of the Valkey instance.
    name string
    Instance name.
    parameters GetValkeyInstanceParameters
    planId string
    The selected plan ID.
    planName string
    The selected plan name.
    projectId string
    STACKIT Project ID to which the instance is associated.
    region string
    The resource region. If not defined, the provider region is used.
    version string
    The service version.
    cf_guid str
    cf_organization_guid str
    cf_space_guid str
    dashboard_url str
    id str
    Terraform's internal data source. identifier. It is structured as "projectId,region,instanceId".
    image_url str
    instance_id str
    ID of the Valkey instance.
    name str
    Instance name.
    parameters GetValkeyInstanceParameters
    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.
    region str
    The resource region. If not defined, the provider region is used.
    version str
    The service version.
    cfGuid String
    cfOrganizationGuid String
    cfSpaceGuid String
    dashboardUrl String
    id String
    Terraform's internal data source. identifier. It is structured as "projectId,region,instanceId".
    imageUrl String
    instanceId String
    ID of the Valkey 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.
    region String
    The resource region. If not defined, the provider region is used.
    version String
    The service version.

    Supporting Types

    GetValkeyInstanceParameters

    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.
    MinReplicasToWrite int
    The amount of connected replicas that are required for the primary to accept write operations. It can be set to 0 to disable it.
    MonitoringInstanceId string
    The ID of the STACKIT monitoring instance.
    NotifyKeyspaceEvents string
    The notify keyspace events.
    ReplBacklogSize string
    The replication backlog size for the cluster.
    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.
    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.
    MinReplicasToWrite int
    The amount of connected replicas that are required for the primary to accept write operations. It can be set to 0 to disable it.
    MonitoringInstanceId string
    The ID of the STACKIT monitoring instance.
    NotifyKeyspaceEvents string
    The notify keyspace events.
    ReplBacklogSize string
    The replication backlog size for the cluster.
    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.
    down_after_milliseconds number
    The number of milliseconds after which the instance is considered down.
    enable_monitoring bool
    Enable monitoring.
    failover_timeout number
    The failover timeout in milliseconds.
    graphite string
    Graphite server URL (host and port). If set, monitoring with Graphite will be enabled.
    lazyfree_lazy_eviction string
    The lazy eviction enablement (yes or no).
    lazyfree_lazy_expire string
    The lazy expire enablement (yes or no).
    lua_time_limit number
    The Lua time limit.
    max_disk_threshold 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.
    maxmemory_policy string
    The policy to handle the maximum memory (volatile-lru, noeviction, etc).
    maxmemory_samples number
    The maximum memory samples.
    metrics_frequency number
    The frequency in seconds at which metrics are emitted.
    metrics_prefix 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.
    min_replicas_max_lag number
    The minimum replicas maximum lag.
    min_replicas_to_write number
    The amount of connected replicas that are required for the primary to accept write operations. It can be set to 0 to disable it.
    monitoring_instance_id string
    The ID of the STACKIT monitoring instance.
    notify_keyspace_events string
    The notify keyspace events.
    repl_backlog_size string
    The replication backlog size for the cluster.
    sgw_acl 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.
    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.
    minReplicasToWrite Integer
    The amount of connected replicas that are required for the primary to accept write operations. It can be set to 0 to disable it.
    monitoringInstanceId String
    The ID of the STACKIT monitoring instance.
    notifyKeyspaceEvents String
    The notify keyspace events.
    replBacklogSize String
    The replication backlog size for the cluster.
    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.
    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.
    minReplicasToWrite number
    The amount of connected replicas that are required for the primary to accept write operations. It can be set to 0 to disable it.
    monitoringInstanceId string
    The ID of the STACKIT monitoring instance.
    notifyKeyspaceEvents string
    The notify keyspace events.
    replBacklogSize string
    The replication backlog size for the cluster.
    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.
    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.
    min_replicas_to_write int
    The amount of connected replicas that are required for the primary to accept write operations. It can be set to 0 to disable it.
    monitoring_instance_id str
    The ID of the STACKIT monitoring instance.
    notify_keyspace_events str
    The notify keyspace events.
    repl_backlog_size str
    The replication backlog size for the cluster.
    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.
    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.
    minReplicasToWrite Number
    The amount of connected replicas that are required for the primary to accept write operations. It can be set to 0 to disable it.
    monitoringInstanceId String
    The ID of the STACKIT monitoring instance.
    notifyKeyspaceEvents String
    The notify keyspace events.
    replBacklogSize String
    The replication backlog size for the cluster.
    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.

    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.8
    published on Friday, Oct 16, 2026 by stackitcloud
    Schema (JSON)
    stackitcloud/pulumi-stackit

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial