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

stackit.OpensearchInstance

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

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

    Example Usage

    resource "stackit_opensearch_instance" "example" {
  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  name       = "example-instance"
  version    = "2"
  plan_name  = "stackit-opensearch-1.2.10-replica"
  parameters = {
    sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22"
  }
}

# Only use the import statement, if you want to import an existing opensearch instance
import {
  to = stackit_opensearch_instance.import-example
  id = "${var.project_id},${var.instance_id}"
}

    Create OpensearchInstance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OpensearchInstance(name: string, args: OpensearchInstanceArgs, opts?: CustomResourceOptions);
    @overload
def OpensearchInstance(resource_name: str,
                       args: OpensearchInstanceArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def OpensearchInstance(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       plan_name: Optional[str] = None,
                       project_id: Optional[str] = None,
                       version: Optional[str] = None,
                       name: Optional[str] = None,
                       parameters: Optional[OpensearchInstanceParametersArgs] = None)
    func NewOpensearchInstance(ctx *Context, name string, args OpensearchInstanceArgs, opts ...ResourceOption) (*OpensearchInstance, error)
    public OpensearchInstance(string name, OpensearchInstanceArgs args, CustomResourceOptions? opts = null)
    public OpensearchInstance(String name, OpensearchInstanceArgs args)
public OpensearchInstance(String name, OpensearchInstanceArgs args, CustomResourceOptions options)

    type: stackit:OpensearchInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OpensearchInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OpensearchInstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OpensearchInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OpensearchInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OpensearchInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var opensearchInstanceResource = new Stackit.OpensearchInstance("opensearchInstanceResource", new()
{
    PlanName = "string",
    ProjectId = "string",
    Version = "string",
    Name = "string",
    Parameters = new Stackit.Inputs.OpensearchInstanceParametersArgs
    {
        EnableMonitoring = false,
        Graphite = "string",
        JavaGarbageCollector = "string",
        JavaHeapspace = 0,
        JavaMaxmetaspace = 0,
        MaxDiskThreshold = 0,
        MetricsFrequency = 0,
        MetricsPrefix = "string",
        MonitoringInstanceId = "string",
        Plugins = new[]
        {
            "string",
        },
        SgwAcl = "string",
        Syslogs = new[]
        {
            "string",
        },
        TlsCiphers = new[]
        {
            "string",
        },
        TlsProtocols = new[]
        {
            "string",
        },
    },
});

    example, err := stackit.NewOpensearchInstance(ctx, "opensearchInstanceResource", &stackit.OpensearchInstanceArgs{
	PlanName:  pulumi.String("string"),
	ProjectId: pulumi.String("string"),
	Version:   pulumi.String("string"),
	Name:      pulumi.String("string"),
	Parameters: &stackit.OpensearchInstanceParametersArgs{
		EnableMonitoring:     pulumi.Bool(false),
		Graphite:             pulumi.String("string"),
		JavaGarbageCollector: pulumi.String("string"),
		JavaHeapspace:        pulumi.Int(0),
		JavaMaxmetaspace:     pulumi.Int(0),
		MaxDiskThreshold:     pulumi.Int(0),
		MetricsFrequency:     pulumi.Int(0),
		MetricsPrefix:        pulumi.String("string"),
		MonitoringInstanceId: pulumi.String("string"),
		Plugins: pulumi.StringArray{
			pulumi.String("string"),
		},
		SgwAcl: pulumi.String("string"),
		Syslogs: pulumi.StringArray{
			pulumi.String("string"),
		},
		TlsCiphers: pulumi.StringArray{
			pulumi.String("string"),
		},
		TlsProtocols: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    var opensearchInstanceResource = new OpensearchInstance("opensearchInstanceResource", OpensearchInstanceArgs.builder()
    .planName("string")
    .projectId("string")
    .version("string")
    .name("string")
    .parameters(OpensearchInstanceParametersArgs.builder()
        .enableMonitoring(false)
        .graphite("string")
        .javaGarbageCollector("string")
        .javaHeapspace(0)
        .javaMaxmetaspace(0)
        .maxDiskThreshold(0)
        .metricsFrequency(0)
        .metricsPrefix("string")
        .monitoringInstanceId("string")
        .plugins("string")
        .sgwAcl("string")
        .syslogs("string")
        .tlsCiphers("string")
        .tlsProtocols("string")
        .build())
    .build());

    opensearch_instance_resource = stackit.OpensearchInstance("opensearchInstanceResource",
    plan_name="string",
    project_id="string",
    version="string",
    name="string",
    parameters={
        "enable_monitoring": False,
        "graphite": "string",
        "java_garbage_collector": "string",
        "java_heapspace": 0,
        "java_maxmetaspace": 0,
        "max_disk_threshold": 0,
        "metrics_frequency": 0,
        "metrics_prefix": "string",
        "monitoring_instance_id": "string",
        "plugins": ["string"],
        "sgw_acl": "string",
        "syslogs": ["string"],
        "tls_ciphers": ["string"],
        "tls_protocols": ["string"],
    })

    const opensearchInstanceResource = new stackit.OpensearchInstance("opensearchInstanceResource", {
    planName: "string",
    projectId: "string",
    version: "string",
    name: "string",
    parameters: {
        enableMonitoring: false,
        graphite: "string",
        javaGarbageCollector: "string",
        javaHeapspace: 0,
        javaMaxmetaspace: 0,
        maxDiskThreshold: 0,
        metricsFrequency: 0,
        metricsPrefix: "string",
        monitoringInstanceId: "string",
        plugins: ["string"],
        sgwAcl: "string",
        syslogs: ["string"],
        tlsCiphers: ["string"],
        tlsProtocols: ["string"],
    },
});

    type: stackit:OpensearchInstance
properties:
    name: string
    parameters:
        enableMonitoring: false
        graphite: string
        javaGarbageCollector: string
        javaHeapspace: 0
        javaMaxmetaspace: 0
        maxDiskThreshold: 0
        metricsFrequency: 0
        metricsPrefix: string
        monitoringInstanceId: string
        plugins:
            - string
        sgwAcl: string
        syslogs:
            - string
        tlsCiphers:
            - string
        tlsProtocols:
            - string
    planName: string
    projectId: string
    version: string

    OpensearchInstance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OpensearchInstance resource accepts the following input properties:

    PlanName string
    The selected plan name.
    ProjectId string
    STACKIT project ID to which the instance is associated.
    Version string
    The service version.
    Name string
    Instance name.
    Parameters OpensearchInstanceParameters
    PlanName string
    The selected plan name.
    ProjectId string
    STACKIT project ID to which the instance is associated.
    Version string
    The service version.
    Name string
    Instance name.
    Parameters OpensearchInstanceParametersArgs
    planName String
    The selected plan name.
    projectId String
    STACKIT project ID to which the instance is associated.
    version String
    The service version.
    name String
    Instance name.
    parameters OpensearchInstanceParameters
    planName string
    The selected plan name.
    projectId string
    STACKIT project ID to which the instance is associated.
    version string
    The service version.
    name string
    Instance name.
    parameters OpensearchInstanceParameters
    plan_name str
    The selected plan name.
    project_id str
    STACKIT project ID to which the instance is associated.
    version str
    The service version.
    name str
    Instance name.
    parameters OpensearchInstanceParametersArgs
    planName String
    The selected plan name.
    projectId String
    STACKIT project ID to which the instance is associated.
    version String
    The service version.
    name String
    Instance name.
    parameters Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OpensearchInstance resource produces the following output properties:

    CfGuid string
    CfOrganizationGuid string
    CfSpaceGuid string
    DashboardUrl string
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageUrl string
    InstanceId string
    ID of the OpenSearch instance.
    PlanId string
    The selected plan ID.
    CfGuid string
    CfOrganizationGuid string
    CfSpaceGuid string
    DashboardUrl string
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageUrl string
    InstanceId string
    ID of the OpenSearch instance.
    PlanId string
    The selected plan ID.
    cfGuid String
    cfOrganizationGuid String
    cfSpaceGuid String
    dashboardUrl String
    id String
    The provider-assigned unique ID for this managed resource.
    imageUrl String
    instanceId String
    ID of the OpenSearch instance.
    planId String
    The selected plan ID.
    cfGuid string
    cfOrganizationGuid string
    cfSpaceGuid string
    dashboardUrl string
    id string
    The provider-assigned unique ID for this managed resource.
    imageUrl string
    instanceId string
    ID of the OpenSearch instance.
    planId string
    The selected plan ID.
    cf_guid str
    cf_organization_guid str
    cf_space_guid str
    dashboard_url str
    id str
    The provider-assigned unique ID for this managed resource.
    image_url str
    instance_id str
    ID of the OpenSearch instance.
    plan_id str
    The selected plan ID.
    cfGuid String
    cfOrganizationGuid String
    cfSpaceGuid String
    dashboardUrl String
    id String
    The provider-assigned unique ID for this managed resource.
    imageUrl String
    instanceId String
    ID of the OpenSearch instance.
    planId String
    The selected plan ID.

    Look up Existing OpensearchInstance Resource

    Get an existing OpensearchInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OpensearchInstanceState, opts?: CustomResourceOptions): OpensearchInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cf_guid: Optional[str] = None,
        cf_organization_guid: Optional[str] = None,
        cf_space_guid: Optional[str] = None,
        dashboard_url: Optional[str] = None,
        image_url: Optional[str] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[OpensearchInstanceParametersArgs] = None,
        plan_id: Optional[str] = None,
        plan_name: Optional[str] = None,
        project_id: Optional[str] = None,
        version: Optional[str] = None) -> OpensearchInstance
    func GetOpensearchInstance(ctx *Context, name string, id IDInput, state *OpensearchInstanceState, opts ...ResourceOption) (*OpensearchInstance, error)
    public static OpensearchInstance Get(string name, Input<string> id, OpensearchInstanceState? state, CustomResourceOptions? opts = null)
    public static OpensearchInstance get(String name, Output<String> id, OpensearchInstanceState state, CustomResourceOptions options)
    resources:  _:    type: stackit:OpensearchInstance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CfGuid string
    CfOrganizationGuid string
    CfSpaceGuid string
    DashboardUrl string
    ImageUrl string
    InstanceId string
    ID of the OpenSearch instance.
    Name string
    Instance name.
    Parameters OpensearchInstanceParameters
    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
    ImageUrl string
    InstanceId string
    ID of the OpenSearch instance.
    Name string
    Instance name.
    Parameters OpensearchInstanceParametersArgs
    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
    imageUrl String
    instanceId String
    ID of the OpenSearch instance.
    name String
    Instance name.
    parameters OpensearchInstanceParameters
    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
    imageUrl string
    instanceId string
    ID of the OpenSearch instance.
    name string
    Instance name.
    parameters OpensearchInstanceParameters
    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
    image_url str
    instance_id str
    ID of the OpenSearch instance.
    name str
    Instance name.
    parameters OpensearchInstanceParametersArgs
    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
    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

    OpensearchInstanceParameters, OpensearchInstanceParametersArgs

    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 List<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 List<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 Sequence[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 List<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.