Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

Cluster

This resource provides the Opensearch Cluster resource in Oracle Cloud Infrastructure Opensearch service.

Creates a new OpensearchCluster.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testOpensearchCluster = new Oci.Opensearch.Cluster("testOpensearchCluster", new()
    {
        CompartmentId = @var.Compartment_id,
        DataNodeCount = @var.Opensearch_cluster_data_node_count,
        DataNodeHostMemoryGb = @var.Opensearch_cluster_data_node_host_memory_gb,
        DataNodeHostOcpuCount = @var.Opensearch_cluster_data_node_host_ocpu_count,
        DataNodeHostType = @var.Opensearch_cluster_data_node_host_type,
        DataNodeStorageGb = @var.Opensearch_cluster_data_node_storage_gb,
        DisplayName = @var.Opensearch_cluster_display_name,
        MasterNodeCount = @var.Opensearch_cluster_master_node_count,
        MasterNodeHostMemoryGb = @var.Opensearch_cluster_master_node_host_memory_gb,
        MasterNodeHostOcpuCount = @var.Opensearch_cluster_master_node_host_ocpu_count,
        MasterNodeHostType = @var.Opensearch_cluster_master_node_host_type,
        OpendashboardNodeCount = @var.Opensearch_cluster_opendashboard_node_count,
        OpendashboardNodeHostMemoryGb = @var.Opensearch_cluster_opendashboard_node_host_memory_gb,
        OpendashboardNodeHostOcpuCount = @var.Opensearch_cluster_opendashboard_node_host_ocpu_count,
        SoftwareVersion = @var.Opensearch_cluster_software_version,
        SubnetCompartmentId = oci_identity_compartment.Test_compartment.Id,
        SubnetId = oci_core_subnet.Test_subnet.Id,
        VcnCompartmentId = oci_identity_compartment.Test_compartment.Id,
        VcnId = oci_core_vcn.Test_vcn.Id,
        DataNodeHostBareMetalShape = @var.Opensearch_cluster_data_node_host_bare_metal_shape,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        MasterNodeHostBareMetalShape = @var.Opensearch_cluster_master_node_host_bare_metal_shape,
        SystemTags = @var.Opensearch_cluster_system_tags,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Opensearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Opensearch.NewCluster(ctx, "testOpensearchCluster", &Opensearch.ClusterArgs{
			CompartmentId:                  pulumi.Any(_var.Compartment_id),
			DataNodeCount:                  pulumi.Any(_var.Opensearch_cluster_data_node_count),
			DataNodeHostMemoryGb:           pulumi.Any(_var.Opensearch_cluster_data_node_host_memory_gb),
			DataNodeHostOcpuCount:          pulumi.Any(_var.Opensearch_cluster_data_node_host_ocpu_count),
			DataNodeHostType:               pulumi.Any(_var.Opensearch_cluster_data_node_host_type),
			DataNodeStorageGb:              pulumi.Any(_var.Opensearch_cluster_data_node_storage_gb),
			DisplayName:                    pulumi.Any(_var.Opensearch_cluster_display_name),
			MasterNodeCount:                pulumi.Any(_var.Opensearch_cluster_master_node_count),
			MasterNodeHostMemoryGb:         pulumi.Any(_var.Opensearch_cluster_master_node_host_memory_gb),
			MasterNodeHostOcpuCount:        pulumi.Any(_var.Opensearch_cluster_master_node_host_ocpu_count),
			MasterNodeHostType:             pulumi.Any(_var.Opensearch_cluster_master_node_host_type),
			OpendashboardNodeCount:         pulumi.Any(_var.Opensearch_cluster_opendashboard_node_count),
			OpendashboardNodeHostMemoryGb:  pulumi.Any(_var.Opensearch_cluster_opendashboard_node_host_memory_gb),
			OpendashboardNodeHostOcpuCount: pulumi.Any(_var.Opensearch_cluster_opendashboard_node_host_ocpu_count),
			SoftwareVersion:                pulumi.Any(_var.Opensearch_cluster_software_version),
			SubnetCompartmentId:            pulumi.Any(oci_identity_compartment.Test_compartment.Id),
			SubnetId:                       pulumi.Any(oci_core_subnet.Test_subnet.Id),
			VcnCompartmentId:               pulumi.Any(oci_identity_compartment.Test_compartment.Id),
			VcnId:                          pulumi.Any(oci_core_vcn.Test_vcn.Id),
			DataNodeHostBareMetalShape:     pulumi.Any(_var.Opensearch_cluster_data_node_host_bare_metal_shape),
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
			MasterNodeHostBareMetalShape: pulumi.Any(_var.Opensearch_cluster_master_node_host_bare_metal_shape),
			SystemTags:                   pulumi.Any(_var.Opensearch_cluster_system_tags),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Opensearch.Cluster;
import com.pulumi.oci.Opensearch.ClusterArgs;
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) {
        var testOpensearchCluster = new Cluster("testOpensearchCluster", ClusterArgs.builder()        
            .compartmentId(var_.compartment_id())
            .dataNodeCount(var_.opensearch_cluster_data_node_count())
            .dataNodeHostMemoryGb(var_.opensearch_cluster_data_node_host_memory_gb())
            .dataNodeHostOcpuCount(var_.opensearch_cluster_data_node_host_ocpu_count())
            .dataNodeHostType(var_.opensearch_cluster_data_node_host_type())
            .dataNodeStorageGb(var_.opensearch_cluster_data_node_storage_gb())
            .displayName(var_.opensearch_cluster_display_name())
            .masterNodeCount(var_.opensearch_cluster_master_node_count())
            .masterNodeHostMemoryGb(var_.opensearch_cluster_master_node_host_memory_gb())
            .masterNodeHostOcpuCount(var_.opensearch_cluster_master_node_host_ocpu_count())
            .masterNodeHostType(var_.opensearch_cluster_master_node_host_type())
            .opendashboardNodeCount(var_.opensearch_cluster_opendashboard_node_count())
            .opendashboardNodeHostMemoryGb(var_.opensearch_cluster_opendashboard_node_host_memory_gb())
            .opendashboardNodeHostOcpuCount(var_.opensearch_cluster_opendashboard_node_host_ocpu_count())
            .softwareVersion(var_.opensearch_cluster_software_version())
            .subnetCompartmentId(oci_identity_compartment.test_compartment().id())
            .subnetId(oci_core_subnet.test_subnet().id())
            .vcnCompartmentId(oci_identity_compartment.test_compartment().id())
            .vcnId(oci_core_vcn.test_vcn().id())
            .dataNodeHostBareMetalShape(var_.opensearch_cluster_data_node_host_bare_metal_shape())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .masterNodeHostBareMetalShape(var_.opensearch_cluster_master_node_host_bare_metal_shape())
            .systemTags(var_.opensearch_cluster_system_tags())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_opensearch_cluster = oci.opensearch.Cluster("testOpensearchCluster",
    compartment_id=var["compartment_id"],
    data_node_count=var["opensearch_cluster_data_node_count"],
    data_node_host_memory_gb=var["opensearch_cluster_data_node_host_memory_gb"],
    data_node_host_ocpu_count=var["opensearch_cluster_data_node_host_ocpu_count"],
    data_node_host_type=var["opensearch_cluster_data_node_host_type"],
    data_node_storage_gb=var["opensearch_cluster_data_node_storage_gb"],
    display_name=var["opensearch_cluster_display_name"],
    master_node_count=var["opensearch_cluster_master_node_count"],
    master_node_host_memory_gb=var["opensearch_cluster_master_node_host_memory_gb"],
    master_node_host_ocpu_count=var["opensearch_cluster_master_node_host_ocpu_count"],
    master_node_host_type=var["opensearch_cluster_master_node_host_type"],
    opendashboard_node_count=var["opensearch_cluster_opendashboard_node_count"],
    opendashboard_node_host_memory_gb=var["opensearch_cluster_opendashboard_node_host_memory_gb"],
    opendashboard_node_host_ocpu_count=var["opensearch_cluster_opendashboard_node_host_ocpu_count"],
    software_version=var["opensearch_cluster_software_version"],
    subnet_compartment_id=oci_identity_compartment["test_compartment"]["id"],
    subnet_id=oci_core_subnet["test_subnet"]["id"],
    vcn_compartment_id=oci_identity_compartment["test_compartment"]["id"],
    vcn_id=oci_core_vcn["test_vcn"]["id"],
    data_node_host_bare_metal_shape=var["opensearch_cluster_data_node_host_bare_metal_shape"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    master_node_host_bare_metal_shape=var["opensearch_cluster_master_node_host_bare_metal_shape"],
    system_tags=var["opensearch_cluster_system_tags"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testOpensearchCluster = new oci.opensearch.Cluster("testOpensearchCluster", {
    compartmentId: _var.compartment_id,
    dataNodeCount: _var.opensearch_cluster_data_node_count,
    dataNodeHostMemoryGb: _var.opensearch_cluster_data_node_host_memory_gb,
    dataNodeHostOcpuCount: _var.opensearch_cluster_data_node_host_ocpu_count,
    dataNodeHostType: _var.opensearch_cluster_data_node_host_type,
    dataNodeStorageGb: _var.opensearch_cluster_data_node_storage_gb,
    displayName: _var.opensearch_cluster_display_name,
    masterNodeCount: _var.opensearch_cluster_master_node_count,
    masterNodeHostMemoryGb: _var.opensearch_cluster_master_node_host_memory_gb,
    masterNodeHostOcpuCount: _var.opensearch_cluster_master_node_host_ocpu_count,
    masterNodeHostType: _var.opensearch_cluster_master_node_host_type,
    opendashboardNodeCount: _var.opensearch_cluster_opendashboard_node_count,
    opendashboardNodeHostMemoryGb: _var.opensearch_cluster_opendashboard_node_host_memory_gb,
    opendashboardNodeHostOcpuCount: _var.opensearch_cluster_opendashboard_node_host_ocpu_count,
    softwareVersion: _var.opensearch_cluster_software_version,
    subnetCompartmentId: oci_identity_compartment.test_compartment.id,
    subnetId: oci_core_subnet.test_subnet.id,
    vcnCompartmentId: oci_identity_compartment.test_compartment.id,
    vcnId: oci_core_vcn.test_vcn.id,
    dataNodeHostBareMetalShape: _var.opensearch_cluster_data_node_host_bare_metal_shape,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    masterNodeHostBareMetalShape: _var.opensearch_cluster_master_node_host_bare_metal_shape,
    systemTags: _var.opensearch_cluster_system_tags,
});
resources:
  testOpensearchCluster:
    type: oci:Opensearch:Cluster
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      dataNodeCount: ${var.opensearch_cluster_data_node_count}
      dataNodeHostMemoryGb: ${var.opensearch_cluster_data_node_host_memory_gb}
      dataNodeHostOcpuCount: ${var.opensearch_cluster_data_node_host_ocpu_count}
      dataNodeHostType: ${var.opensearch_cluster_data_node_host_type}
      dataNodeStorageGb: ${var.opensearch_cluster_data_node_storage_gb}
      displayName: ${var.opensearch_cluster_display_name}
      masterNodeCount: ${var.opensearch_cluster_master_node_count}
      masterNodeHostMemoryGb: ${var.opensearch_cluster_master_node_host_memory_gb}
      masterNodeHostOcpuCount: ${var.opensearch_cluster_master_node_host_ocpu_count}
      masterNodeHostType: ${var.opensearch_cluster_master_node_host_type}
      opendashboardNodeCount: ${var.opensearch_cluster_opendashboard_node_count}
      opendashboardNodeHostMemoryGb: ${var.opensearch_cluster_opendashboard_node_host_memory_gb}
      opendashboardNodeHostOcpuCount: ${var.opensearch_cluster_opendashboard_node_host_ocpu_count}
      softwareVersion: ${var.opensearch_cluster_software_version}
      subnetCompartmentId: ${oci_identity_compartment.test_compartment.id}
      subnetId: ${oci_core_subnet.test_subnet.id}
      vcnCompartmentId: ${oci_identity_compartment.test_compartment.id}
      vcnId: ${oci_core_vcn.test_vcn.id}
      #Optional
      dataNodeHostBareMetalShape: ${var.opensearch_cluster_data_node_host_bare_metal_shape}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      masterNodeHostBareMetalShape: ${var.opensearch_cluster_master_node_host_bare_metal_shape}
      systemTags: ${var.opensearch_cluster_system_tags}

Create a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            data_node_count: Optional[int] = None,
            data_node_host_bare_metal_shape: Optional[str] = None,
            data_node_host_memory_gb: Optional[int] = None,
            data_node_host_ocpu_count: Optional[int] = None,
            data_node_host_type: Optional[str] = None,
            data_node_storage_gb: Optional[int] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            master_node_count: Optional[int] = None,
            master_node_host_bare_metal_shape: Optional[str] = None,
            master_node_host_memory_gb: Optional[int] = None,
            master_node_host_ocpu_count: Optional[int] = None,
            master_node_host_type: Optional[str] = None,
            opendashboard_node_count: Optional[int] = None,
            opendashboard_node_host_memory_gb: Optional[int] = None,
            opendashboard_node_host_ocpu_count: Optional[int] = None,
            software_version: Optional[str] = None,
            subnet_compartment_id: Optional[str] = None,
            subnet_id: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            vcn_compartment_id: Optional[str] = None,
            vcn_id: Optional[str] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: oci:Opensearch:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ClusterArgs
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 ClusterArgs
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 ClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Cluster Resource Properties

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

Inputs

The Cluster resource accepts the following input properties:

CompartmentId string

The OCID of the compartment to create the cluster in.

DataNodeCount int

The number of data nodes to configure for the cluster.

DataNodeHostMemoryGb int

The amount of memory in GB, to configure per node for the cluster's data nodes.

DataNodeHostOcpuCount int

The number of OCPUs to configure for the cluster's data nodes.

DataNodeHostType string

TThe instance type for the cluster's data nodes.

DataNodeStorageGb int

The amount of storage in GB, to configure per node for the cluster's data nodes.

DisplayName string

(Updatable) The name of the cluster. Avoid entering confidential information.

MasterNodeCount int

The number of master nodes to configure for the cluster.

MasterNodeHostMemoryGb int

The amount of memory in GB, to configure per node for the cluster's master nodes.

MasterNodeHostOcpuCount int

The number of OCPUs to configure for the cluser's master nodes.

MasterNodeHostType string

The instance type for the cluster's master nodes.

OpendashboardNodeCount int

The number of OpenSearch Dashboard nodes to configure for the cluster.

OpendashboardNodeHostMemoryGb int

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

OpendashboardNodeHostOcpuCount int

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

SoftwareVersion string

(Updatable) The version of the software the cluster is running.

SubnetCompartmentId string

The OCID for the compartment where the cluster's subnet is located.

SubnetId string

The OCID of the cluster's subnet.

VcnCompartmentId string

The OCID for the compartment where the cluster's VCN is located.

VcnId string

The OCID of the cluster's VCN.

DataNodeHostBareMetalShape string

The bare metal shape for the cluster's data nodes.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

FreeformTags Dictionary<string, object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

MasterNodeHostBareMetalShape string

The bare metal shape for the cluster's master nodes.

SystemTags Dictionary<string, object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

CompartmentId string

The OCID of the compartment to create the cluster in.

DataNodeCount int

The number of data nodes to configure for the cluster.

DataNodeHostMemoryGb int

The amount of memory in GB, to configure per node for the cluster's data nodes.

DataNodeHostOcpuCount int

The number of OCPUs to configure for the cluster's data nodes.

DataNodeHostType string

TThe instance type for the cluster's data nodes.

DataNodeStorageGb int

The amount of storage in GB, to configure per node for the cluster's data nodes.

DisplayName string

(Updatable) The name of the cluster. Avoid entering confidential information.

MasterNodeCount int

The number of master nodes to configure for the cluster.

MasterNodeHostMemoryGb int

The amount of memory in GB, to configure per node for the cluster's master nodes.

MasterNodeHostOcpuCount int

The number of OCPUs to configure for the cluser's master nodes.

MasterNodeHostType string

The instance type for the cluster's master nodes.

OpendashboardNodeCount int

The number of OpenSearch Dashboard nodes to configure for the cluster.

OpendashboardNodeHostMemoryGb int

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

OpendashboardNodeHostOcpuCount int

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

SoftwareVersion string

(Updatable) The version of the software the cluster is running.

SubnetCompartmentId string

The OCID for the compartment where the cluster's subnet is located.

SubnetId string

The OCID of the cluster's subnet.

VcnCompartmentId string

The OCID for the compartment where the cluster's VCN is located.

VcnId string

The OCID of the cluster's VCN.

DataNodeHostBareMetalShape string

The bare metal shape for the cluster's data nodes.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

FreeformTags map[string]interface{}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

MasterNodeHostBareMetalShape string

The bare metal shape for the cluster's master nodes.

SystemTags map[string]interface{}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

compartmentId String

The OCID of the compartment to create the cluster in.

dataNodeCount Integer

The number of data nodes to configure for the cluster.

dataNodeHostMemoryGb Integer

The amount of memory in GB, to configure per node for the cluster's data nodes.

dataNodeHostOcpuCount Integer

The number of OCPUs to configure for the cluster's data nodes.

dataNodeHostType String

TThe instance type for the cluster's data nodes.

dataNodeStorageGb Integer

The amount of storage in GB, to configure per node for the cluster's data nodes.

displayName String

(Updatable) The name of the cluster. Avoid entering confidential information.

masterNodeCount Integer

The number of master nodes to configure for the cluster.

masterNodeHostMemoryGb Integer

The amount of memory in GB, to configure per node for the cluster's master nodes.

masterNodeHostOcpuCount Integer

The number of OCPUs to configure for the cluser's master nodes.

masterNodeHostType String

The instance type for the cluster's master nodes.

opendashboardNodeCount Integer

The number of OpenSearch Dashboard nodes to configure for the cluster.

opendashboardNodeHostMemoryGb Integer

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

opendashboardNodeHostOcpuCount Integer

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

softwareVersion String

(Updatable) The version of the software the cluster is running.

subnetCompartmentId String

The OCID for the compartment where the cluster's subnet is located.

subnetId String

The OCID of the cluster's subnet.

vcnCompartmentId String

The OCID for the compartment where the cluster's VCN is located.

vcnId String

The OCID of the cluster's VCN.

dataNodeHostBareMetalShape String

The bare metal shape for the cluster's data nodes.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags Map<String,Object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

masterNodeHostBareMetalShape String

The bare metal shape for the cluster's master nodes.

systemTags Map<String,Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

compartmentId string

The OCID of the compartment to create the cluster in.

dataNodeCount number

The number of data nodes to configure for the cluster.

dataNodeHostMemoryGb number

The amount of memory in GB, to configure per node for the cluster's data nodes.

dataNodeHostOcpuCount number

The number of OCPUs to configure for the cluster's data nodes.

dataNodeHostType string

TThe instance type for the cluster's data nodes.

dataNodeStorageGb number

The amount of storage in GB, to configure per node for the cluster's data nodes.

displayName string

(Updatable) The name of the cluster. Avoid entering confidential information.

masterNodeCount number

The number of master nodes to configure for the cluster.

masterNodeHostMemoryGb number

The amount of memory in GB, to configure per node for the cluster's master nodes.

masterNodeHostOcpuCount number

The number of OCPUs to configure for the cluser's master nodes.

masterNodeHostType string

The instance type for the cluster's master nodes.

opendashboardNodeCount number

The number of OpenSearch Dashboard nodes to configure for the cluster.

opendashboardNodeHostMemoryGb number

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

opendashboardNodeHostOcpuCount number

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

softwareVersion string

(Updatable) The version of the software the cluster is running.

subnetCompartmentId string

The OCID for the compartment where the cluster's subnet is located.

subnetId string

The OCID of the cluster's subnet.

vcnCompartmentId string

The OCID for the compartment where the cluster's VCN is located.

vcnId string

The OCID of the cluster's VCN.

dataNodeHostBareMetalShape string

The bare metal shape for the cluster's data nodes.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags {[key: string]: any}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

masterNodeHostBareMetalShape string

The bare metal shape for the cluster's master nodes.

systemTags {[key: string]: any}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

compartment_id str

The OCID of the compartment to create the cluster in.

data_node_count int

The number of data nodes to configure for the cluster.

data_node_host_memory_gb int

The amount of memory in GB, to configure per node for the cluster's data nodes.

data_node_host_ocpu_count int

The number of OCPUs to configure for the cluster's data nodes.

data_node_host_type str

TThe instance type for the cluster's data nodes.

data_node_storage_gb int

The amount of storage in GB, to configure per node for the cluster's data nodes.

display_name str

(Updatable) The name of the cluster. Avoid entering confidential information.

master_node_count int

The number of master nodes to configure for the cluster.

master_node_host_memory_gb int

The amount of memory in GB, to configure per node for the cluster's master nodes.

master_node_host_ocpu_count int

The number of OCPUs to configure for the cluser's master nodes.

master_node_host_type str

The instance type for the cluster's master nodes.

opendashboard_node_count int

The number of OpenSearch Dashboard nodes to configure for the cluster.

opendashboard_node_host_memory_gb int

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

opendashboard_node_host_ocpu_count int

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

software_version str

(Updatable) The version of the software the cluster is running.

subnet_compartment_id str

The OCID for the compartment where the cluster's subnet is located.

subnet_id str

The OCID of the cluster's subnet.

vcn_compartment_id str

The OCID for the compartment where the cluster's VCN is located.

vcn_id str

The OCID of the cluster's VCN.

data_node_host_bare_metal_shape str

The bare metal shape for the cluster's data nodes.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeform_tags Mapping[str, Any]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

master_node_host_bare_metal_shape str

The bare metal shape for the cluster's master nodes.

system_tags Mapping[str, Any]

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

compartmentId String

The OCID of the compartment to create the cluster in.

dataNodeCount Number

The number of data nodes to configure for the cluster.

dataNodeHostMemoryGb Number

The amount of memory in GB, to configure per node for the cluster's data nodes.

dataNodeHostOcpuCount Number

The number of OCPUs to configure for the cluster's data nodes.

dataNodeHostType String

TThe instance type for the cluster's data nodes.

dataNodeStorageGb Number

The amount of storage in GB, to configure per node for the cluster's data nodes.

displayName String

(Updatable) The name of the cluster. Avoid entering confidential information.

masterNodeCount Number

The number of master nodes to configure for the cluster.

masterNodeHostMemoryGb Number

The amount of memory in GB, to configure per node for the cluster's master nodes.

masterNodeHostOcpuCount Number

The number of OCPUs to configure for the cluser's master nodes.

masterNodeHostType String

The instance type for the cluster's master nodes.

opendashboardNodeCount Number

The number of OpenSearch Dashboard nodes to configure for the cluster.

opendashboardNodeHostMemoryGb Number

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

opendashboardNodeHostOcpuCount Number

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

softwareVersion String

(Updatable) The version of the software the cluster is running.

subnetCompartmentId String

The OCID for the compartment where the cluster's subnet is located.

subnetId String

The OCID of the cluster's subnet.

vcnCompartmentId String

The OCID for the compartment where the cluster's VCN is located.

vcnId String

The OCID of the cluster's VCN.

dataNodeHostBareMetalShape String

The bare metal shape for the cluster's data nodes.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags Map<Any>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

masterNodeHostBareMetalShape String

The bare metal shape for the cluster's master nodes.

systemTags Map<Any>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

Outputs

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

AvailabilityDomains List<string>

The availability domains to distribute the cluser nodes across.

Fqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

Additional information about the current lifecycle state of the cluster.

OpendashboardFqdn string

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

OpendashboardPrivateIp string

The private IP address for the cluster's OpenSearch Dashboard.

OpensearchFqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

OpensearchPrivateIp string

The cluster's private IP address.

State string

The current state of the cluster.

TimeCreated string

The amount of time in milliseconds since the cluster was created.

TimeDeleted string

The amount of time in milliseconds since the cluster was updated.

TimeUpdated string

The amount of time in milliseconds since the cluster was updated.

TotalStorageGb int

The size in GB of the cluster's total storage.

AvailabilityDomains []string

The availability domains to distribute the cluser nodes across.

Fqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

Additional information about the current lifecycle state of the cluster.

OpendashboardFqdn string

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

OpendashboardPrivateIp string

The private IP address for the cluster's OpenSearch Dashboard.

OpensearchFqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

OpensearchPrivateIp string

The cluster's private IP address.

State string

The current state of the cluster.

TimeCreated string

The amount of time in milliseconds since the cluster was created.

TimeDeleted string

The amount of time in milliseconds since the cluster was updated.

TimeUpdated string

The amount of time in milliseconds since the cluster was updated.

TotalStorageGb int

The size in GB of the cluster's total storage.

availabilityDomains List<String>

The availability domains to distribute the cluser nodes across.

fqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

Additional information about the current lifecycle state of the cluster.

opendashboardFqdn String

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboardPrivateIp String

The private IP address for the cluster's OpenSearch Dashboard.

opensearchFqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearchPrivateIp String

The cluster's private IP address.

state String

The current state of the cluster.

timeCreated String

The amount of time in milliseconds since the cluster was created.

timeDeleted String

The amount of time in milliseconds since the cluster was updated.

timeUpdated String

The amount of time in milliseconds since the cluster was updated.

totalStorageGb Integer

The size in GB of the cluster's total storage.

availabilityDomains string[]

The availability domains to distribute the cluser nodes across.

fqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

id string

The provider-assigned unique ID for this managed resource.

lifecycleDetails string

Additional information about the current lifecycle state of the cluster.

opendashboardFqdn string

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboardPrivateIp string

The private IP address for the cluster's OpenSearch Dashboard.

opensearchFqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearchPrivateIp string

The cluster's private IP address.

state string

The current state of the cluster.

timeCreated string

The amount of time in milliseconds since the cluster was created.

timeDeleted string

The amount of time in milliseconds since the cluster was updated.

timeUpdated string

The amount of time in milliseconds since the cluster was updated.

totalStorageGb number

The size in GB of the cluster's total storage.

availability_domains Sequence[str]

The availability domains to distribute the cluser nodes across.

fqdn str

The fully qualified domain name (FQDN) for the cluster's API endpoint.

id str

The provider-assigned unique ID for this managed resource.

lifecycle_details str

Additional information about the current lifecycle state of the cluster.

opendashboard_fqdn str

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboard_private_ip str

The private IP address for the cluster's OpenSearch Dashboard.

opensearch_fqdn str

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearch_private_ip str

The cluster's private IP address.

state str

The current state of the cluster.

time_created str

The amount of time in milliseconds since the cluster was created.

time_deleted str

The amount of time in milliseconds since the cluster was updated.

time_updated str

The amount of time in milliseconds since the cluster was updated.

total_storage_gb int

The size in GB of the cluster's total storage.

availabilityDomains List<String>

The availability domains to distribute the cluser nodes across.

fqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

Additional information about the current lifecycle state of the cluster.

opendashboardFqdn String

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboardPrivateIp String

The private IP address for the cluster's OpenSearch Dashboard.

opensearchFqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearchPrivateIp String

The cluster's private IP address.

state String

The current state of the cluster.

timeCreated String

The amount of time in milliseconds since the cluster was created.

timeDeleted String

The amount of time in milliseconds since the cluster was updated.

timeUpdated String

The amount of time in milliseconds since the cluster was updated.

totalStorageGb Number

The size in GB of the cluster's total storage.

Look up an Existing Cluster Resource

Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_domains: Optional[Sequence[str]] = None,
        compartment_id: Optional[str] = None,
        data_node_count: Optional[int] = None,
        data_node_host_bare_metal_shape: Optional[str] = None,
        data_node_host_memory_gb: Optional[int] = None,
        data_node_host_ocpu_count: Optional[int] = None,
        data_node_host_type: Optional[str] = None,
        data_node_storage_gb: Optional[int] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        fqdn: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        lifecycle_details: Optional[str] = None,
        master_node_count: Optional[int] = None,
        master_node_host_bare_metal_shape: Optional[str] = None,
        master_node_host_memory_gb: Optional[int] = None,
        master_node_host_ocpu_count: Optional[int] = None,
        master_node_host_type: Optional[str] = None,
        opendashboard_fqdn: Optional[str] = None,
        opendashboard_node_count: Optional[int] = None,
        opendashboard_node_host_memory_gb: Optional[int] = None,
        opendashboard_node_host_ocpu_count: Optional[int] = None,
        opendashboard_private_ip: Optional[str] = None,
        opensearch_fqdn: Optional[str] = None,
        opensearch_private_ip: Optional[str] = None,
        software_version: Optional[str] = None,
        state: Optional[str] = None,
        subnet_compartment_id: Optional[str] = None,
        subnet_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        time_created: Optional[str] = None,
        time_deleted: Optional[str] = None,
        time_updated: Optional[str] = None,
        total_storage_gb: Optional[int] = None,
        vcn_compartment_id: Optional[str] = None,
        vcn_id: Optional[str] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
AvailabilityDomains List<string>

The availability domains to distribute the cluser nodes across.

CompartmentId string

The OCID of the compartment to create the cluster in.

DataNodeCount int

The number of data nodes to configure for the cluster.

DataNodeHostBareMetalShape string

The bare metal shape for the cluster's data nodes.

DataNodeHostMemoryGb int

The amount of memory in GB, to configure per node for the cluster's data nodes.

DataNodeHostOcpuCount int

The number of OCPUs to configure for the cluster's data nodes.

DataNodeHostType string

TThe instance type for the cluster's data nodes.

DataNodeStorageGb int

The amount of storage in GB, to configure per node for the cluster's data nodes.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

(Updatable) The name of the cluster. Avoid entering confidential information.

Fqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

FreeformTags Dictionary<string, object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

LifecycleDetails string

Additional information about the current lifecycle state of the cluster.

MasterNodeCount int

The number of master nodes to configure for the cluster.

MasterNodeHostBareMetalShape string

The bare metal shape for the cluster's master nodes.

MasterNodeHostMemoryGb int

The amount of memory in GB, to configure per node for the cluster's master nodes.

MasterNodeHostOcpuCount int

The number of OCPUs to configure for the cluser's master nodes.

MasterNodeHostType string

The instance type for the cluster's master nodes.

OpendashboardFqdn string

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

OpendashboardNodeCount int

The number of OpenSearch Dashboard nodes to configure for the cluster.

OpendashboardNodeHostMemoryGb int

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

OpendashboardNodeHostOcpuCount int

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

OpendashboardPrivateIp string

The private IP address for the cluster's OpenSearch Dashboard.

OpensearchFqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

OpensearchPrivateIp string

The cluster's private IP address.

SoftwareVersion string

(Updatable) The version of the software the cluster is running.

State string

The current state of the cluster.

SubnetCompartmentId string

The OCID for the compartment where the cluster's subnet is located.

SubnetId string

The OCID of the cluster's subnet.

SystemTags Dictionary<string, object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The amount of time in milliseconds since the cluster was created.

TimeDeleted string

The amount of time in milliseconds since the cluster was updated.

TimeUpdated string

The amount of time in milliseconds since the cluster was updated.

TotalStorageGb int

The size in GB of the cluster's total storage.

VcnCompartmentId string

The OCID for the compartment where the cluster's VCN is located.

VcnId string

The OCID of the cluster's VCN.

AvailabilityDomains []string

The availability domains to distribute the cluser nodes across.

CompartmentId string

The OCID of the compartment to create the cluster in.

DataNodeCount int

The number of data nodes to configure for the cluster.

DataNodeHostBareMetalShape string

The bare metal shape for the cluster's data nodes.

DataNodeHostMemoryGb int

The amount of memory in GB, to configure per node for the cluster's data nodes.

DataNodeHostOcpuCount int

The number of OCPUs to configure for the cluster's data nodes.

DataNodeHostType string

TThe instance type for the cluster's data nodes.

DataNodeStorageGb int

The amount of storage in GB, to configure per node for the cluster's data nodes.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

(Updatable) The name of the cluster. Avoid entering confidential information.

Fqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

FreeformTags map[string]interface{}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

LifecycleDetails string

Additional information about the current lifecycle state of the cluster.

MasterNodeCount int

The number of master nodes to configure for the cluster.

MasterNodeHostBareMetalShape string

The bare metal shape for the cluster's master nodes.

MasterNodeHostMemoryGb int

The amount of memory in GB, to configure per node for the cluster's master nodes.

MasterNodeHostOcpuCount int

The number of OCPUs to configure for the cluser's master nodes.

MasterNodeHostType string

The instance type for the cluster's master nodes.

OpendashboardFqdn string

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

OpendashboardNodeCount int

The number of OpenSearch Dashboard nodes to configure for the cluster.

OpendashboardNodeHostMemoryGb int

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

OpendashboardNodeHostOcpuCount int

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

OpendashboardPrivateIp string

The private IP address for the cluster's OpenSearch Dashboard.

OpensearchFqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

OpensearchPrivateIp string

The cluster's private IP address.

SoftwareVersion string

(Updatable) The version of the software the cluster is running.

State string

The current state of the cluster.

SubnetCompartmentId string

The OCID for the compartment where the cluster's subnet is located.

SubnetId string

The OCID of the cluster's subnet.

SystemTags map[string]interface{}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The amount of time in milliseconds since the cluster was created.

TimeDeleted string

The amount of time in milliseconds since the cluster was updated.

TimeUpdated string

The amount of time in milliseconds since the cluster was updated.

TotalStorageGb int

The size in GB of the cluster's total storage.

VcnCompartmentId string

The OCID for the compartment where the cluster's VCN is located.

VcnId string

The OCID of the cluster's VCN.

availabilityDomains List<String>

The availability domains to distribute the cluser nodes across.

compartmentId String

The OCID of the compartment to create the cluster in.

dataNodeCount Integer

The number of data nodes to configure for the cluster.

dataNodeHostBareMetalShape String

The bare metal shape for the cluster's data nodes.

dataNodeHostMemoryGb Integer

The amount of memory in GB, to configure per node for the cluster's data nodes.

dataNodeHostOcpuCount Integer

The number of OCPUs to configure for the cluster's data nodes.

dataNodeHostType String

TThe instance type for the cluster's data nodes.

dataNodeStorageGb Integer

The amount of storage in GB, to configure per node for the cluster's data nodes.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

(Updatable) The name of the cluster. Avoid entering confidential information.

fqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

freeformTags Map<String,Object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

lifecycleDetails String

Additional information about the current lifecycle state of the cluster.

masterNodeCount Integer

The number of master nodes to configure for the cluster.

masterNodeHostBareMetalShape String

The bare metal shape for the cluster's master nodes.

masterNodeHostMemoryGb Integer

The amount of memory in GB, to configure per node for the cluster's master nodes.

masterNodeHostOcpuCount Integer

The number of OCPUs to configure for the cluser's master nodes.

masterNodeHostType String

The instance type for the cluster's master nodes.

opendashboardFqdn String

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboardNodeCount Integer

The number of OpenSearch Dashboard nodes to configure for the cluster.

opendashboardNodeHostMemoryGb Integer

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

opendashboardNodeHostOcpuCount Integer

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

opendashboardPrivateIp String

The private IP address for the cluster's OpenSearch Dashboard.

opensearchFqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearchPrivateIp String

The cluster's private IP address.

softwareVersion String

(Updatable) The version of the software the cluster is running.

state String

The current state of the cluster.

subnetCompartmentId String

The OCID for the compartment where the cluster's subnet is located.

subnetId String

The OCID of the cluster's subnet.

systemTags Map<String,Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The amount of time in milliseconds since the cluster was created.

timeDeleted String

The amount of time in milliseconds since the cluster was updated.

timeUpdated String

The amount of time in milliseconds since the cluster was updated.

totalStorageGb Integer

The size in GB of the cluster's total storage.

vcnCompartmentId String

The OCID for the compartment where the cluster's VCN is located.

vcnId String

The OCID of the cluster's VCN.

availabilityDomains string[]

The availability domains to distribute the cluser nodes across.

compartmentId string

The OCID of the compartment to create the cluster in.

dataNodeCount number

The number of data nodes to configure for the cluster.

dataNodeHostBareMetalShape string

The bare metal shape for the cluster's data nodes.

dataNodeHostMemoryGb number

The amount of memory in GB, to configure per node for the cluster's data nodes.

dataNodeHostOcpuCount number

The number of OCPUs to configure for the cluster's data nodes.

dataNodeHostType string

TThe instance type for the cluster's data nodes.

dataNodeStorageGb number

The amount of storage in GB, to configure per node for the cluster's data nodes.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName string

(Updatable) The name of the cluster. Avoid entering confidential information.

fqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

freeformTags {[key: string]: any}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

lifecycleDetails string

Additional information about the current lifecycle state of the cluster.

masterNodeCount number

The number of master nodes to configure for the cluster.

masterNodeHostBareMetalShape string

The bare metal shape for the cluster's master nodes.

masterNodeHostMemoryGb number

The amount of memory in GB, to configure per node for the cluster's master nodes.

masterNodeHostOcpuCount number

The number of OCPUs to configure for the cluser's master nodes.

masterNodeHostType string

The instance type for the cluster's master nodes.

opendashboardFqdn string

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboardNodeCount number

The number of OpenSearch Dashboard nodes to configure for the cluster.

opendashboardNodeHostMemoryGb number

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

opendashboardNodeHostOcpuCount number

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

opendashboardPrivateIp string

The private IP address for the cluster's OpenSearch Dashboard.

opensearchFqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearchPrivateIp string

The cluster's private IP address.

softwareVersion string

(Updatable) The version of the software the cluster is running.

state string

The current state of the cluster.

subnetCompartmentId string

The OCID for the compartment where the cluster's subnet is located.

subnetId string

The OCID of the cluster's subnet.

systemTags {[key: string]: any}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

The amount of time in milliseconds since the cluster was created.

timeDeleted string

The amount of time in milliseconds since the cluster was updated.

timeUpdated string

The amount of time in milliseconds since the cluster was updated.

totalStorageGb number

The size in GB of the cluster's total storage.

vcnCompartmentId string

The OCID for the compartment where the cluster's VCN is located.

vcnId string

The OCID of the cluster's VCN.

availability_domains Sequence[str]

The availability domains to distribute the cluser nodes across.

compartment_id str

The OCID of the compartment to create the cluster in.

data_node_count int

The number of data nodes to configure for the cluster.

data_node_host_bare_metal_shape str

The bare metal shape for the cluster's data nodes.

data_node_host_memory_gb int

The amount of memory in GB, to configure per node for the cluster's data nodes.

data_node_host_ocpu_count int

The number of OCPUs to configure for the cluster's data nodes.

data_node_host_type str

TThe instance type for the cluster's data nodes.

data_node_storage_gb int

The amount of storage in GB, to configure per node for the cluster's data nodes.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

display_name str

(Updatable) The name of the cluster. Avoid entering confidential information.

fqdn str

The fully qualified domain name (FQDN) for the cluster's API endpoint.

freeform_tags Mapping[str, Any]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

lifecycle_details str

Additional information about the current lifecycle state of the cluster.

master_node_count int

The number of master nodes to configure for the cluster.

master_node_host_bare_metal_shape str

The bare metal shape for the cluster's master nodes.

master_node_host_memory_gb int

The amount of memory in GB, to configure per node for the cluster's master nodes.

master_node_host_ocpu_count int

The number of OCPUs to configure for the cluser's master nodes.

master_node_host_type str

The instance type for the cluster's master nodes.

opendashboard_fqdn str

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboard_node_count int

The number of OpenSearch Dashboard nodes to configure for the cluster.

opendashboard_node_host_memory_gb int

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

opendashboard_node_host_ocpu_count int

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

opendashboard_private_ip str

The private IP address for the cluster's OpenSearch Dashboard.

opensearch_fqdn str

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearch_private_ip str

The cluster's private IP address.

software_version str

(Updatable) The version of the software the cluster is running.

state str

The current state of the cluster.

subnet_compartment_id str

The OCID for the compartment where the cluster's subnet is located.

subnet_id str

The OCID of the cluster's subnet.

system_tags Mapping[str, Any]

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

The amount of time in milliseconds since the cluster was created.

time_deleted str

The amount of time in milliseconds since the cluster was updated.

time_updated str

The amount of time in milliseconds since the cluster was updated.

total_storage_gb int

The size in GB of the cluster's total storage.

vcn_compartment_id str

The OCID for the compartment where the cluster's VCN is located.

vcn_id str

The OCID of the cluster's VCN.

availabilityDomains List<String>

The availability domains to distribute the cluser nodes across.

compartmentId String

The OCID of the compartment to create the cluster in.

dataNodeCount Number

The number of data nodes to configure for the cluster.

dataNodeHostBareMetalShape String

The bare metal shape for the cluster's data nodes.

dataNodeHostMemoryGb Number

The amount of memory in GB, to configure per node for the cluster's data nodes.

dataNodeHostOcpuCount Number

The number of OCPUs to configure for the cluster's data nodes.

dataNodeHostType String

TThe instance type for the cluster's data nodes.

dataNodeStorageGb Number

The amount of storage in GB, to configure per node for the cluster's data nodes.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

(Updatable) The name of the cluster. Avoid entering confidential information.

fqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

freeformTags Map<Any>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

lifecycleDetails String

Additional information about the current lifecycle state of the cluster.

masterNodeCount Number

The number of master nodes to configure for the cluster.

masterNodeHostBareMetalShape String

The bare metal shape for the cluster's master nodes.

masterNodeHostMemoryGb Number

The amount of memory in GB, to configure per node for the cluster's master nodes.

masterNodeHostOcpuCount Number

The number of OCPUs to configure for the cluser's master nodes.

masterNodeHostType String

The instance type for the cluster's master nodes.

opendashboardFqdn String

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboardNodeCount Number

The number of OpenSearch Dashboard nodes to configure for the cluster.

opendashboardNodeHostMemoryGb Number

The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.

opendashboardNodeHostOcpuCount Number

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

opendashboardPrivateIp String

The private IP address for the cluster's OpenSearch Dashboard.

opensearchFqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearchPrivateIp String

The cluster's private IP address.

softwareVersion String

(Updatable) The version of the software the cluster is running.

state String

The current state of the cluster.

subnetCompartmentId String

The OCID for the compartment where the cluster's subnet is located.

subnetId String

The OCID of the cluster's subnet.

systemTags Map<Any>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The amount of time in milliseconds since the cluster was created.

timeDeleted String

The amount of time in milliseconds since the cluster was updated.

timeUpdated String

The amount of time in milliseconds since the cluster was updated.

totalStorageGb Number

The size in GB of the cluster's total storage.

vcnCompartmentId String

The OCID for the compartment where the cluster's VCN is located.

vcnId String

The OCID of the cluster's VCN.

Import

OpensearchClusters can be imported using the id, e.g.

 $ pulumi import oci:Opensearch/cluster:Cluster test_opensearch_cluster "id"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.