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

stackit.getOpensearchInstance

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

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

    Example Usage

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

    Using getOpensearchInstance

    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 getOpensearchInstance(args: GetOpensearchInstanceArgs, opts?: InvokeOptions): Promise<GetOpensearchInstanceResult>
function getOpensearchInstanceOutput(args: GetOpensearchInstanceOutputArgs, opts?: InvokeOptions): Output<GetOpensearchInstanceResult>
    def get_opensearch_instance(instance_id: Optional[str] = None,
                            project_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetOpensearchInstanceResult
def get_opensearch_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                            project_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetOpensearchInstanceResult]
    func LookupOpensearchInstance(ctx *Context, args *LookupOpensearchInstanceArgs, opts ...InvokeOption) (*LookupOpensearchInstanceResult, error)
func LookupOpensearchInstanceOutput(ctx *Context, args *LookupOpensearchInstanceOutputArgs, opts ...InvokeOption) LookupOpensearchInstanceResultOutput

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

    public static class GetOpensearchInstance 
{
    public static Task<GetOpensearchInstanceResult> InvokeAsync(GetOpensearchInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetOpensearchInstanceResult> Invoke(GetOpensearchInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOpensearchInstanceResult> getOpensearchInstance(GetOpensearchInstanceArgs args, InvokeOptions options)
public static Output<GetOpensearchInstanceResult> getOpensearchInstance(GetOpensearchInstanceArgs args, InvokeOptions options)

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

    The following arguments are supported:

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

    getOpensearchInstance Result

    The following output properties are available:

    CfGuid string
    CfOrganizationGuid string
    CfSpaceGuid string
    DashboardUrl string
    Id string
    ImageUrl string
    InstanceId string
    ID of the OpenSearch instance.
    Name string
    Instance name.
    Parameters GetOpensearchInstanceParameters
    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 OpenSearch instance.
    Name string
    Instance name.
    Parameters GetOpensearchInstanceParameters
    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 OpenSearch instance.
    name String
    Instance name.
    parameters GetOpensearchInstanceParameters
    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 OpenSearch instance.
    name string
    Instance name.
    parameters GetOpensearchInstanceParameters
    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 OpenSearch instance.
    name str
    Instance name.
    parameters GetOpensearchInstanceParameters
    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 OpenSearch 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

    GetOpensearchInstanceParameters

    EnableMonitoring bool
    Enable monitoring.
    Graphite string
    If set, monitoring with Graphite will be enabled. Expects the host and port where the Graphite metrics should be sent to (host:port).
    JavaGarbageCollector string
    The garbage collector to use for OpenSearch.
    JavaHeapspace int
    The amount of memory (in MB) allocated as heap by the JVM for OpenSearch.
    JavaMaxmetaspace int
    The amount of memory (in MB) used by the JVM to store metadata for OpenSearch.
    MaxDiskThreshold int
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    MetricsFrequency int
    The frequency in seconds at which metrics are emitted (in seconds).
    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.
    MonitoringInstanceId string
    The ID of the STACKIT monitoring instance.
    Plugins List<string>
    List of plugins to install. Must be a supported plugin name. The plugins repository-s3 and repository-azure are enabled by default and cannot be disabled.
    SgwAcl string
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    Syslogs List<string>
    List of syslog servers to send logs to.
    TlsCiphers List<string>
    List of TLS ciphers to use.
    TlsProtocols string
    The TLS protocol to use.
    EnableMonitoring bool
    Enable monitoring.
    Graphite string
    If set, monitoring with Graphite will be enabled. Expects the host and port where the Graphite metrics should be sent to (host:port).
    JavaGarbageCollector string
    The garbage collector to use for OpenSearch.
    JavaHeapspace int
    The amount of memory (in MB) allocated as heap by the JVM for OpenSearch.
    JavaMaxmetaspace int
    The amount of memory (in MB) used by the JVM to store metadata for OpenSearch.
    MaxDiskThreshold int
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    MetricsFrequency int
    The frequency in seconds at which metrics are emitted (in seconds).
    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.
    MonitoringInstanceId string
    The ID of the STACKIT monitoring instance.
    Plugins []string
    List of plugins to install. Must be a supported plugin name. The plugins repository-s3 and repository-azure are enabled by default and cannot be disabled.
    SgwAcl string
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    Syslogs []string
    List of syslog servers to send logs to.
    TlsCiphers []string
    List of TLS ciphers to use.
    TlsProtocols string
    The TLS protocol to use.
    enableMonitoring Boolean
    Enable monitoring.
    graphite String
    If set, monitoring with Graphite will be enabled. Expects the host and port where the Graphite metrics should be sent to (host:port).
    javaGarbageCollector String
    The garbage collector to use for OpenSearch.
    javaHeapspace Integer
    The amount of memory (in MB) allocated as heap by the JVM for OpenSearch.
    javaMaxmetaspace Integer
    The amount of memory (in MB) used by the JVM to store metadata for OpenSearch.
    maxDiskThreshold Integer
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    metricsFrequency Integer
    The frequency in seconds at which metrics are emitted (in seconds).
    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.
    monitoringInstanceId String
    The ID of the STACKIT monitoring instance.
    plugins List<String>
    List of plugins to install. Must be a supported plugin name. The plugins repository-s3 and repository-azure are enabled by default and cannot be disabled.
    sgwAcl String
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    syslogs List<String>
    List of syslog servers to send logs to.
    tlsCiphers List<String>
    List of TLS ciphers to use.
    tlsProtocols String
    The TLS protocol to use.
    enableMonitoring boolean
    Enable monitoring.
    graphite string
    If set, monitoring with Graphite will be enabled. Expects the host and port where the Graphite metrics should be sent to (host:port).
    javaGarbageCollector string
    The garbage collector to use for OpenSearch.
    javaHeapspace number
    The amount of memory (in MB) allocated as heap by the JVM for OpenSearch.
    javaMaxmetaspace number
    The amount of memory (in MB) used by the JVM to store metadata for OpenSearch.
    maxDiskThreshold number
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    metricsFrequency number
    The frequency in seconds at which metrics are emitted (in seconds).
    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.
    monitoringInstanceId string
    The ID of the STACKIT monitoring instance.
    plugins string[]
    List of plugins to install. Must be a supported plugin name. The plugins repository-s3 and repository-azure are enabled by default and cannot be disabled.
    sgwAcl string
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    syslogs string[]
    List of syslog servers to send logs to.
    tlsCiphers string[]
    List of TLS ciphers to use.
    tlsProtocols string
    The TLS protocol to use.
    enable_monitoring bool
    Enable monitoring.
    graphite str
    If set, monitoring with Graphite will be enabled. Expects the host and port where the Graphite metrics should be sent to (host:port).
    java_garbage_collector str
    The garbage collector to use for OpenSearch.
    java_heapspace int
    The amount of memory (in MB) allocated as heap by the JVM for OpenSearch.
    java_maxmetaspace int
    The amount of memory (in MB) used by the JVM to store metadata for OpenSearch.
    max_disk_threshold int
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    metrics_frequency int
    The frequency in seconds at which metrics are emitted (in seconds).
    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.
    monitoring_instance_id str
    The ID of the STACKIT monitoring instance.
    plugins Sequence[str]
    List of plugins to install. Must be a supported plugin name. The plugins repository-s3 and repository-azure are enabled by default and cannot be disabled.
    sgw_acl str
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    syslogs Sequence[str]
    List of syslog servers to send logs to.
    tls_ciphers Sequence[str]
    List of TLS ciphers to use.
    tls_protocols str
    The TLS protocol to use.
    enableMonitoring Boolean
    Enable monitoring.
    graphite String
    If set, monitoring with Graphite will be enabled. Expects the host and port where the Graphite metrics should be sent to (host:port).
    javaGarbageCollector String
    The garbage collector to use for OpenSearch.
    javaHeapspace Number
    The amount of memory (in MB) allocated as heap by the JVM for OpenSearch.
    javaMaxmetaspace Number
    The amount of memory (in MB) used by the JVM to store metadata for OpenSearch.
    maxDiskThreshold Number
    The maximum disk threshold in MB. If the disk usage exceeds this threshold, the instance will be stopped.
    metricsFrequency Number
    The frequency in seconds at which metrics are emitted (in seconds).
    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.
    monitoringInstanceId String
    The ID of the STACKIT monitoring instance.
    plugins List<String>
    List of plugins to install. Must be a supported plugin name. The plugins repository-s3 and repository-azure are enabled by default and cannot be disabled.
    sgwAcl String
    Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
    syslogs List<String>
    List of syslog servers to send logs to.
    tlsCiphers List<String>
    List of TLS ciphers to use.
    tlsProtocols String
    The 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.