UpCloud v0.2.0, Apr 16 25

UpCloud v0.2.0 published on Wednesday, Apr 16, 2025 by UpCloudLtd

upcloud.getManagedDatabaseOpensearchIndices

Explore with Pulumi AI

UpCloud v0.2.0 published on Wednesday, Apr 16, 2025 by UpCloudLtd

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as upcloud from "@pulumi/upcloud";
import * as upcloud from "@upcloud/pulumi-upcloud";

// Use data source to gather a list of the indices for a Managed OpenSearch Database
// Create a Managed OpenSearch resource
const exampleManagedDatabaseOpensearch = new upcloud.ManagedDatabaseOpensearch("example", {
    name: "opensearch-example",
    title: "opensearch-example",
    plan: "1x2xCPU-4GB-80GB-1D",
    zone: "fi-hel1",
    properties: {
        automaticUtilityNetworkIpFilter: false,
        publicAccess: false,
    },
});
// Read the available indices of the newly created service
const example = upcloud.getManagedDatabaseOpensearchIndicesOutput({
    service: exampleManagedDatabaseOpensearch.id,
});

import pulumi
import pulumi_upcloud as upcloud

# Use data source to gather a list of the indices for a Managed OpenSearch Database
# Create a Managed OpenSearch resource
example_managed_database_opensearch = upcloud.ManagedDatabaseOpensearch("example",
    name="opensearch-example",
    title="opensearch-example",
    plan="1x2xCPU-4GB-80GB-1D",
    zone="fi-hel1",
    properties={
        "automatic_utility_network_ip_filter": False,
        "public_access": False,
    })
# Read the available indices of the newly created service
example = upcloud.get_managed_database_opensearch_indices_output(service=example_managed_database_opensearch.id)

package main

import (
	"github.com/UpCloudLtd/pulumi-upcloud/sdk/go/upcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Use data source to gather a list of the indices for a Managed OpenSearch Database
		// Create a Managed OpenSearch resource
		exampleManagedDatabaseOpensearch, err := upcloud.NewManagedDatabaseOpensearch(ctx, "example", &upcloud.ManagedDatabaseOpensearchArgs{
			Name:  pulumi.String("opensearch-example"),
			Title: pulumi.String("opensearch-example"),
			Plan:  pulumi.String("1x2xCPU-4GB-80GB-1D"),
			Zone:  pulumi.String("fi-hel1"),
			Properties: &upcloud.ManagedDatabaseOpensearchPropertiesArgs{
				AutomaticUtilityNetworkIpFilter: pulumi.Bool(false),
				PublicAccess:                    pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		// Read the available indices of the newly created service
		_ = upcloud.GetManagedDatabaseOpensearchIndicesOutput(ctx, upcloud.GetManagedDatabaseOpensearchIndicesOutputArgs{
			Service: exampleManagedDatabaseOpensearch.ID(),
		}, nil)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using UpCloud = Pulumi.UpCloud;
using UpCloud = UpCloud.Pulumi.UpCloud;

return await Deployment.RunAsync(() => 
{
    // Use data source to gather a list of the indices for a Managed OpenSearch Database
    // Create a Managed OpenSearch resource
    var exampleManagedDatabaseOpensearch = new UpCloud.ManagedDatabaseOpensearch("example", new()
    {
        Name = "opensearch-example",
        Title = "opensearch-example",
        Plan = "1x2xCPU-4GB-80GB-1D",
        Zone = "fi-hel1",
        Properties = new UpCloud.Inputs.ManagedDatabaseOpensearchPropertiesArgs
        {
            AutomaticUtilityNetworkIpFilter = false,
            PublicAccess = false,
        },
    });

    // Read the available indices of the newly created service
    var example = UpCloud.GetManagedDatabaseOpensearchIndices.Invoke(new()
    {
        Service = exampleManagedDatabaseOpensearch.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.upcloud.ManagedDatabaseOpensearch;
import com.pulumi.upcloud.ManagedDatabaseOpensearchArgs;
import com.pulumi.upcloud.inputs.ManagedDatabaseOpensearchPropertiesArgs;
import com.pulumi.upcloud.UpcloudFunctions;
import com.pulumi.upcloud.inputs.GetManagedDatabaseOpensearchIndicesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Use data source to gather a list of the indices for a Managed OpenSearch Database
        // Create a Managed OpenSearch resource
        var exampleManagedDatabaseOpensearch = new ManagedDatabaseOpensearch("exampleManagedDatabaseOpensearch", ManagedDatabaseOpensearchArgs.builder()
            .name("opensearch-example")
            .title("opensearch-example")
            .plan("1x2xCPU-4GB-80GB-1D")
            .zone("fi-hel1")
            .properties(ManagedDatabaseOpensearchPropertiesArgs.builder()
                .automaticUtilityNetworkIpFilter(false)
                .publicAccess(false)
                .build())
            .build());

        // Read the available indices of the newly created service
        final var example = UpcloudFunctions.getManagedDatabaseOpensearchIndices(GetManagedDatabaseOpensearchIndicesArgs.builder()
            .service(exampleManagedDatabaseOpensearch.id())
            .build());

    }
}

resources:
  # Use data source to gather a list of the indices for a Managed OpenSearch Database

  # Create a Managed OpenSearch resource
  exampleManagedDatabaseOpensearch:
    type: upcloud:ManagedDatabaseOpensearch
    name: example
    properties:
      name: opensearch-example
      title: opensearch-example
      plan: 1x2xCPU-4GB-80GB-1D
      zone: fi-hel1
      properties:
        automaticUtilityNetworkIpFilter: false
        publicAccess: false
variables:
  # Read the available indices of the newly created service
  example:
    fn::invoke:
      function: upcloud:getManagedDatabaseOpensearchIndices
      arguments:
        service: ${exampleManagedDatabaseOpensearch.id}

Using getManagedDatabaseOpensearchIndices

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.

TypeScript
Python
Go
C#
Java
YAML

function getManagedDatabaseOpensearchIndices(args: GetManagedDatabaseOpensearchIndicesArgs, opts?: InvokeOptions): Promise<GetManagedDatabaseOpensearchIndicesResult>
function getManagedDatabaseOpensearchIndicesOutput(args: GetManagedDatabaseOpensearchIndicesOutputArgs, opts?: InvokeOptions): Output<GetManagedDatabaseOpensearchIndicesResult>

def get_managed_database_opensearch_indices(indices: Optional[Sequence[GetManagedDatabaseOpensearchIndicesIndex]] = None,
                                            service: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetManagedDatabaseOpensearchIndicesResult
def get_managed_database_opensearch_indices_output(indices: Optional[pulumi.Input[Sequence[pulumi.Input[GetManagedDatabaseOpensearchIndicesIndexArgs]]]] = None,
                                            service: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetManagedDatabaseOpensearchIndicesResult]

func GetManagedDatabaseOpensearchIndices(ctx *Context, args *GetManagedDatabaseOpensearchIndicesArgs, opts ...InvokeOption) (*GetManagedDatabaseOpensearchIndicesResult, error)
func GetManagedDatabaseOpensearchIndicesOutput(ctx *Context, args *GetManagedDatabaseOpensearchIndicesOutputArgs, opts ...InvokeOption) GetManagedDatabaseOpensearchIndicesResultOutput

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

public static class GetManagedDatabaseOpensearchIndices 
{
    public static Task<GetManagedDatabaseOpensearchIndicesResult> InvokeAsync(GetManagedDatabaseOpensearchIndicesArgs args, InvokeOptions? opts = null)
    public static Output<GetManagedDatabaseOpensearchIndicesResult> Invoke(GetManagedDatabaseOpensearchIndicesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetManagedDatabaseOpensearchIndicesResult> getManagedDatabaseOpensearchIndices(GetManagedDatabaseOpensearchIndicesArgs args, InvokeOptions options)
public static Output<GetManagedDatabaseOpensearchIndicesResult> getManagedDatabaseOpensearchIndices(GetManagedDatabaseOpensearchIndicesArgs args, InvokeOptions options)

fn::invoke:
  function: upcloud:index/getManagedDatabaseOpensearchIndices:getManagedDatabaseOpensearchIndices
  arguments:
    # arguments dictionary

The following arguments are supported:

Service string
Indices List<UpCloud.Pulumi.UpCloud.Inputs.GetManagedDatabaseOpensearchIndicesIndex>

Service string
Indices []GetManagedDatabaseOpensearchIndicesIndex

service String
indices List<GetManagedDatabaseOpensearchIndicesIndex>

service string
indices GetManagedDatabaseOpensearchIndicesIndex[]

service str
indices Sequence[GetManagedDatabaseOpensearchIndicesIndex]

service String
indices List<Property Map>

getManagedDatabaseOpensearchIndices Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Indices List<UpCloud.Pulumi.UpCloud.Outputs.GetManagedDatabaseOpensearchIndicesIndex>
Service string

Id string: The provider-assigned unique ID for this managed resource.
Indices []GetManagedDatabaseOpensearchIndicesIndex
Service string

id String: The provider-assigned unique ID for this managed resource.
indices List<GetManagedDatabaseOpensearchIndicesIndex>
service String

id string: The provider-assigned unique ID for this managed resource.
indices GetManagedDatabaseOpensearchIndicesIndex[]
service string

id str: The provider-assigned unique ID for this managed resource.
indices Sequence[GetManagedDatabaseOpensearchIndicesIndex]
service str

id String: The provider-assigned unique ID for this managed resource.
indices List<Property Map>
service String

Supporting Types

GetManagedDatabaseOpensearchIndicesIndex

CreateTime string: Timestamp indicating the creation time of the index.
Docs int: Number of documents stored in the index.
Health string: Health status of the index e.g. green, yellow, or red.
IndexName string: Name of the index.
NumberOfReplicas int: Number of replicas configured for the index.
NumberOfShards int: Number of shards configured & used by the index.
ReadOnlyAllowDelete bool: Indicates whether the index is in a read-only state that permits deletion of the entire index. This attribute can be automatically set to true in certain scenarios where the node disk space exceeds the flood stage.
Size int: Size of the index in bytes.
Status string: Status of the index e.g. open or closed.

CreateTime string: Timestamp indicating the creation time of the index.
Docs int: Number of documents stored in the index.
Health string: Health status of the index e.g. green, yellow, or red.
IndexName string: Name of the index.
NumberOfReplicas int: Number of replicas configured for the index.
NumberOfShards int: Number of shards configured & used by the index.
ReadOnlyAllowDelete bool: Indicates whether the index is in a read-only state that permits deletion of the entire index. This attribute can be automatically set to true in certain scenarios where the node disk space exceeds the flood stage.
Size int: Size of the index in bytes.
Status string: Status of the index e.g. open or closed.

createTime String: Timestamp indicating the creation time of the index.
docs Integer: Number of documents stored in the index.
health String: Health status of the index e.g. green, yellow, or red.
indexName String: Name of the index.
numberOfReplicas Integer: Number of replicas configured for the index.
numberOfShards Integer: Number of shards configured & used by the index.
readOnlyAllowDelete Boolean: Indicates whether the index is in a read-only state that permits deletion of the entire index. This attribute can be automatically set to true in certain scenarios where the node disk space exceeds the flood stage.
size Integer: Size of the index in bytes.
status String: Status of the index e.g. open or closed.

createTime string: Timestamp indicating the creation time of the index.
docs number: Number of documents stored in the index.
health string: Health status of the index e.g. green, yellow, or red.
indexName string: Name of the index.
numberOfReplicas number: Number of replicas configured for the index.
numberOfShards number: Number of shards configured & used by the index.
readOnlyAllowDelete boolean: Indicates whether the index is in a read-only state that permits deletion of the entire index. This attribute can be automatically set to true in certain scenarios where the node disk space exceeds the flood stage.
size number: Size of the index in bytes.
status string: Status of the index e.g. open or closed.

create_time str: Timestamp indicating the creation time of the index.
docs int: Number of documents stored in the index.
health str: Health status of the index e.g. green, yellow, or red.
index_name str: Name of the index.
number_of_replicas int: Number of replicas configured for the index.
number_of_shards int: Number of shards configured & used by the index.
read_only_allow_delete bool: Indicates whether the index is in a read-only state that permits deletion of the entire index. This attribute can be automatically set to true in certain scenarios where the node disk space exceeds the flood stage.
size int: Size of the index in bytes.
status str: Status of the index e.g. open or closed.

createTime String: Timestamp indicating the creation time of the index.
docs Number: Number of documents stored in the index.
health String: Health status of the index e.g. green, yellow, or red.
indexName String: Name of the index.
numberOfReplicas Number: Number of replicas configured for the index.
numberOfShards Number: Number of shards configured & used by the index.
readOnlyAllowDelete Boolean: Indicates whether the index is in a read-only state that permits deletion of the entire index. This attribute can be automatically set to true in certain scenarios where the node disk space exceeds the flood stage.
size Number: Size of the index in bytes.
status String: Status of the index e.g. open or closed.

Package Details

Repository: upcloud UpCloudLtd/pulumi-upcloud
License: Apache-2.0
Notes: This Pulumi package is based on the upcloud Terraform Provider.

UpCloud v0.2.0 published on Wednesday, Apr 16, 2025 by UpCloudLtd

UpCloudLtd/pulumi-upcloud

upcloud.getManagedDatabaseOpensearchIndices

On this page

On this page

Example Usage

Using getManagedDatabaseOpensearchIndices

getManagedDatabaseOpensearchIndices Result

Supporting Types

GetManagedDatabaseOpensearchIndicesIndex

Package Details

On this page

On this page