Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Opensearch
  5. Cluster
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

oci.Opensearch.Cluster

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

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

    Creates a new OpensearchCluster.

    Prerequisites

    The below policies must be created in compartment before creating OpensearchCluster

    {Compartment-Name} - Name of your compartment
    Allow service opensearch to manage vnics in compartment {Compartment-Name}
Allow service opensearch to use subnets in compartment {Compartment-Name}
Allow service opensearch to use network-security-groups in compartment {Compartment-Name}
Allow service opensearch to manage vcns in compartment {Compartment-Name}

    For latest documentation on OpenSearch use please refer to https://docs.oracle.com/en-us/iaas/Content/search-opensearch/home.htm
    Required permissions: https://docs.oracle.com/en-us/iaas/Content/search-opensearch/Concepts/ocisearchpermissions.htm

    Create Cluster Resource

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

    Constructor syntax

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

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            opendashboard_node_count: Optional[int] = None,
            opendashboard_node_host_memory_gb: Optional[int] = None,
            vcn_compartment_id: 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,
            data_node_count: Optional[int] = None,
            vcn_id: Optional[str] = None,
            subnet_compartment_id: Optional[str] = None,
            subnet_id: Optional[str] = None,
            software_version: Optional[str] = None,
            master_node_count: Optional[int] = None,
            opendashboard_node_host_ocpu_count: Optional[int] = None,
            master_node_host_memory_gb: Optional[int] = None,
            master_node_host_ocpu_count: Optional[int] = None,
            master_node_host_type: Optional[str] = None,
            display_name: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            master_node_host_bare_metal_shape: Optional[str] = None,
            outbound_cluster_config: Optional[_opensearch.ClusterOutboundClusterConfigArgs] = None,
            reverse_connection_endpoint_customer_ips: Optional[Sequence[str]] = None,
            security_master_user_name: Optional[str] = None,
            security_master_user_password_hash: Optional[str] = None,
            security_mode: Optional[str] = None,
            maintenance_details: Optional[_opensearch.ClusterMaintenanceDetailsArgs] = None,
            inbound_cluster_ids: Optional[Sequence[str]] = None,
            freeform_tags: Optional[Mapping[str, str]] = None,
            system_tags: Optional[Mapping[str, str]] = None,
            upgrade_major_version_trigger: Optional[int] = None,
            data_node_host_bare_metal_shape: Optional[str] = None,
            configure_outbound_cluster_trigger: Optional[int] = 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.

    Parameters

    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.

    Constructor example

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

    var exampleclusterResourceResourceFromOpensearchcluster = new Oci.Opensearch.Cluster("exampleclusterResourceResourceFromOpensearchcluster", new()
{
    CompartmentId = "string",
    OpendashboardNodeCount = 0,
    OpendashboardNodeHostMemoryGb = 0,
    VcnCompartmentId = "string",
    DataNodeHostMemoryGb = 0,
    DataNodeHostOcpuCount = 0,
    DataNodeHostType = "string",
    DataNodeStorageGb = 0,
    DataNodeCount = 0,
    VcnId = "string",
    SubnetCompartmentId = "string",
    SubnetId = "string",
    SoftwareVersion = "string",
    MasterNodeCount = 0,
    OpendashboardNodeHostOcpuCount = 0,
    MasterNodeHostMemoryGb = 0,
    MasterNodeHostOcpuCount = 0,
    MasterNodeHostType = "string",
    DisplayName = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    MasterNodeHostBareMetalShape = "string",
    OutboundClusterConfig = new Oci.Opensearch.Inputs.ClusterOutboundClusterConfigArgs
    {
        IsEnabled = false,
        OutboundClusters = new[]
        {
            new Oci.Opensearch.Inputs.ClusterOutboundClusterConfigOutboundClusterArgs
            {
                DisplayName = "string",
                SeedClusterId = "string",
                IsSkipUnavailable = false,
                Mode = "string",
                PingSchedule = "string",
            },
        },
    },
    ReverseConnectionEndpointCustomerIps = new[]
    {
        "string",
    },
    SecurityMasterUserName = "string",
    SecurityMasterUserPasswordHash = "string",
    SecurityMode = "string",
    MaintenanceDetails = new Oci.Opensearch.Inputs.ClusterMaintenanceDetailsArgs
    {
        EndTime = "string",
        NotificationEmailIds = new[]
        {
            "string",
        },
        StartTime = "string",
        State = "string",
    },
    InboundClusterIds = new[]
    {
        "string",
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    SystemTags = 
    {
        { "string", "string" },
    },
    UpgradeMajorVersionTrigger = 0,
    DataNodeHostBareMetalShape = "string",
    ConfigureOutboundClusterTrigger = 0,
});

    example, err := Opensearch.NewCluster(ctx, "exampleclusterResourceResourceFromOpensearchcluster", &Opensearch.ClusterArgs{
	CompartmentId:                  pulumi.String("string"),
	OpendashboardNodeCount:         pulumi.Int(0),
	OpendashboardNodeHostMemoryGb:  pulumi.Int(0),
	VcnCompartmentId:               pulumi.String("string"),
	DataNodeHostMemoryGb:           pulumi.Int(0),
	DataNodeHostOcpuCount:          pulumi.Int(0),
	DataNodeHostType:               pulumi.String("string"),
	DataNodeStorageGb:              pulumi.Int(0),
	DataNodeCount:                  pulumi.Int(0),
	VcnId:                          pulumi.String("string"),
	SubnetCompartmentId:            pulumi.String("string"),
	SubnetId:                       pulumi.String("string"),
	SoftwareVersion:                pulumi.String("string"),
	MasterNodeCount:                pulumi.Int(0),
	OpendashboardNodeHostOcpuCount: pulumi.Int(0),
	MasterNodeHostMemoryGb:         pulumi.Int(0),
	MasterNodeHostOcpuCount:        pulumi.Int(0),
	MasterNodeHostType:             pulumi.String("string"),
	DisplayName:                    pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	MasterNodeHostBareMetalShape: pulumi.String("string"),
	OutboundClusterConfig: &opensearch.ClusterOutboundClusterConfigArgs{
		IsEnabled: pulumi.Bool(false),
		OutboundClusters: opensearch.ClusterOutboundClusterConfigOutboundClusterArray{
			&opensearch.ClusterOutboundClusterConfigOutboundClusterArgs{
				DisplayName:       pulumi.String("string"),
				SeedClusterId:     pulumi.String("string"),
				IsSkipUnavailable: pulumi.Bool(false),
				Mode:              pulumi.String("string"),
				PingSchedule:      pulumi.String("string"),
			},
		},
	},
	ReverseConnectionEndpointCustomerIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	SecurityMasterUserName:         pulumi.String("string"),
	SecurityMasterUserPasswordHash: pulumi.String("string"),
	SecurityMode:                   pulumi.String("string"),
	MaintenanceDetails: &opensearch.ClusterMaintenanceDetailsArgs{
		EndTime: pulumi.String("string"),
		NotificationEmailIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		StartTime: pulumi.String("string"),
		State:     pulumi.String("string"),
	},
	InboundClusterIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SystemTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UpgradeMajorVersionTrigger:      pulumi.Int(0),
	DataNodeHostBareMetalShape:      pulumi.String("string"),
	ConfigureOutboundClusterTrigger: pulumi.Int(0),
})

    var exampleclusterResourceResourceFromOpensearchcluster = new Cluster("exampleclusterResourceResourceFromOpensearchcluster", ClusterArgs.builder()
    .compartmentId("string")
    .opendashboardNodeCount(0)
    .opendashboardNodeHostMemoryGb(0)
    .vcnCompartmentId("string")
    .dataNodeHostMemoryGb(0)
    .dataNodeHostOcpuCount(0)
    .dataNodeHostType("string")
    .dataNodeStorageGb(0)
    .dataNodeCount(0)
    .vcnId("string")
    .subnetCompartmentId("string")
    .subnetId("string")
    .softwareVersion("string")
    .masterNodeCount(0)
    .opendashboardNodeHostOcpuCount(0)
    .masterNodeHostMemoryGb(0)
    .masterNodeHostOcpuCount(0)
    .masterNodeHostType("string")
    .displayName("string")
    .definedTags(Map.of("string", "string"))
    .masterNodeHostBareMetalShape("string")
    .outboundClusterConfig(ClusterOutboundClusterConfigArgs.builder()
        .isEnabled(false)
        .outboundClusters(ClusterOutboundClusterConfigOutboundClusterArgs.builder()
            .displayName("string")
            .seedClusterId("string")
            .isSkipUnavailable(false)
            .mode("string")
            .pingSchedule("string")
            .build())
        .build())
    .reverseConnectionEndpointCustomerIps("string")
    .securityMasterUserName("string")
    .securityMasterUserPasswordHash("string")
    .securityMode("string")
    .maintenanceDetails(ClusterMaintenanceDetailsArgs.builder()
        .endTime("string")
        .notificationEmailIds("string")
        .startTime("string")
        .state("string")
        .build())
    .inboundClusterIds("string")
    .freeformTags(Map.of("string", "string"))
    .systemTags(Map.of("string", "string"))
    .upgradeMajorVersionTrigger(0)
    .dataNodeHostBareMetalShape("string")
    .configureOutboundClusterTrigger(0)
    .build());

    examplecluster_resource_resource_from_opensearchcluster = oci.opensearch.Cluster("exampleclusterResourceResourceFromOpensearchcluster",
    compartment_id="string",
    opendashboard_node_count=0,
    opendashboard_node_host_memory_gb=0,
    vcn_compartment_id="string",
    data_node_host_memory_gb=0,
    data_node_host_ocpu_count=0,
    data_node_host_type="string",
    data_node_storage_gb=0,
    data_node_count=0,
    vcn_id="string",
    subnet_compartment_id="string",
    subnet_id="string",
    software_version="string",
    master_node_count=0,
    opendashboard_node_host_ocpu_count=0,
    master_node_host_memory_gb=0,
    master_node_host_ocpu_count=0,
    master_node_host_type="string",
    display_name="string",
    defined_tags={
        "string": "string",
    },
    master_node_host_bare_metal_shape="string",
    outbound_cluster_config={
        "is_enabled": False,
        "outbound_clusters": [{
            "display_name": "string",
            "seed_cluster_id": "string",
            "is_skip_unavailable": False,
            "mode": "string",
            "ping_schedule": "string",
        }],
    },
    reverse_connection_endpoint_customer_ips=["string"],
    security_master_user_name="string",
    security_master_user_password_hash="string",
    security_mode="string",
    maintenance_details={
        "end_time": "string",
        "notification_email_ids": ["string"],
        "start_time": "string",
        "state": "string",
    },
    inbound_cluster_ids=["string"],
    freeform_tags={
        "string": "string",
    },
    system_tags={
        "string": "string",
    },
    upgrade_major_version_trigger=0,
    data_node_host_bare_metal_shape="string",
    configure_outbound_cluster_trigger=0)

    const exampleclusterResourceResourceFromOpensearchcluster = new oci.opensearch.Cluster("exampleclusterResourceResourceFromOpensearchcluster", {
    compartmentId: "string",
    opendashboardNodeCount: 0,
    opendashboardNodeHostMemoryGb: 0,
    vcnCompartmentId: "string",
    dataNodeHostMemoryGb: 0,
    dataNodeHostOcpuCount: 0,
    dataNodeHostType: "string",
    dataNodeStorageGb: 0,
    dataNodeCount: 0,
    vcnId: "string",
    subnetCompartmentId: "string",
    subnetId: "string",
    softwareVersion: "string",
    masterNodeCount: 0,
    opendashboardNodeHostOcpuCount: 0,
    masterNodeHostMemoryGb: 0,
    masterNodeHostOcpuCount: 0,
    masterNodeHostType: "string",
    displayName: "string",
    definedTags: {
        string: "string",
    },
    masterNodeHostBareMetalShape: "string",
    outboundClusterConfig: {
        isEnabled: false,
        outboundClusters: [{
            displayName: "string",
            seedClusterId: "string",
            isSkipUnavailable: false,
            mode: "string",
            pingSchedule: "string",
        }],
    },
    reverseConnectionEndpointCustomerIps: ["string"],
    securityMasterUserName: "string",
    securityMasterUserPasswordHash: "string",
    securityMode: "string",
    maintenanceDetails: {
        endTime: "string",
        notificationEmailIds: ["string"],
        startTime: "string",
        state: "string",
    },
    inboundClusterIds: ["string"],
    freeformTags: {
        string: "string",
    },
    systemTags: {
        string: "string",
    },
    upgradeMajorVersionTrigger: 0,
    dataNodeHostBareMetalShape: "string",
    configureOutboundClusterTrigger: 0,
});

    type: oci:Opensearch:Cluster
properties:
    compartmentId: string
    configureOutboundClusterTrigger: 0
    dataNodeCount: 0
    dataNodeHostBareMetalShape: string
    dataNodeHostMemoryGb: 0
    dataNodeHostOcpuCount: 0
    dataNodeHostType: string
    dataNodeStorageGb: 0
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    inboundClusterIds:
        - string
    maintenanceDetails:
        endTime: string
        notificationEmailIds:
            - string
        startTime: string
        state: string
    masterNodeCount: 0
    masterNodeHostBareMetalShape: string
    masterNodeHostMemoryGb: 0
    masterNodeHostOcpuCount: 0
    masterNodeHostType: string
    opendashboardNodeCount: 0
    opendashboardNodeHostMemoryGb: 0
    opendashboardNodeHostOcpuCount: 0
    outboundClusterConfig:
        isEnabled: false
        outboundClusters:
            - displayName: string
              isSkipUnavailable: false
              mode: string
              pingSchedule: string
              seedClusterId: string
    reverseConnectionEndpointCustomerIps:
        - string
    securityMasterUserName: string
    securityMasterUserPasswordHash: string
    securityMode: string
    softwareVersion: string
    subnetCompartmentId: string
    subnetId: string
    systemTags:
        string: string
    upgradeMajorVersionTrigger: 0
    vcnCompartmentId: string
    vcnId: string

    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

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

    The Cluster resource accepts the following input properties:

    CompartmentId string
    The OCID of the compartment to create the cluster in.
    DataNodeCount int
    (Updatable) The number of data nodes to configure for the cluster.
    DataNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    DataNodeHostOcpuCount int
    (Updatable) 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
    (Updatable) 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
    (Updatable) The number of master nodes to configure for the cluster.
    MasterNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    MasterNodeHostOcpuCount int
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    OpendashboardNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    OpendashboardNodeHostOcpuCount int
    (Updatable) 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.
    ConfigureOutboundClusterTrigger int
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    DataNodeHostBareMetalShape string
    The bare metal shape for the cluster's data nodes.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    InboundClusterIds List<string>
    List of inbound clusters that will be queried using cross cluster search
    MaintenanceDetails ClusterMaintenanceDetails
    (Updatable) Details for creation of maintenance details
    MasterNodeHostBareMetalShape string
    The bare metal shape for the cluster's master nodes.
    OutboundClusterConfig ClusterOutboundClusterConfig
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    ReverseConnectionEndpointCustomerIps List<string>
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    SecurityMasterUserName string
    (Updatable) The name of the master user that are used to manage security config
    SecurityMasterUserPasswordHash string
    (Updatable) The password hash of the master user that are used to manage security config
    SecurityMode string
    (Updatable) The security mode of the cluster.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    UpgradeMajorVersionTrigger int

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    The OCID of the compartment to create the cluster in.
    DataNodeCount int
    (Updatable) The number of data nodes to configure for the cluster.
    DataNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    DataNodeHostOcpuCount int
    (Updatable) 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
    (Updatable) 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
    (Updatable) The number of master nodes to configure for the cluster.
    MasterNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    MasterNodeHostOcpuCount int
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    OpendashboardNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    OpendashboardNodeHostOcpuCount int
    (Updatable) 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.
    ConfigureOutboundClusterTrigger int
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    DataNodeHostBareMetalShape string
    The bare metal shape for the cluster's data nodes.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    InboundClusterIds []string
    List of inbound clusters that will be queried using cross cluster search
    MaintenanceDetails ClusterMaintenanceDetailsArgs
    (Updatable) Details for creation of maintenance details
    MasterNodeHostBareMetalShape string
    The bare metal shape for the cluster's master nodes.
    OutboundClusterConfig ClusterOutboundClusterConfigArgs
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    ReverseConnectionEndpointCustomerIps []string
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    SecurityMasterUserName string
    (Updatable) The name of the master user that are used to manage security config
    SecurityMasterUserPasswordHash string
    (Updatable) The password hash of the master user that are used to manage security config
    SecurityMode string
    (Updatable) The security mode of the cluster.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    UpgradeMajorVersionTrigger int

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    The OCID of the compartment to create the cluster in.
    dataNodeCount Integer
    (Updatable) The number of data nodes to configure for the cluster.
    dataNodeHostMemoryGb Integer
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    dataNodeHostOcpuCount Integer
    (Updatable) 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
    (Updatable) 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
    (Updatable) The number of master nodes to configure for the cluster.
    masterNodeHostMemoryGb Integer
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    masterNodeHostOcpuCount Integer
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    opendashboardNodeHostMemoryGb Integer
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    opendashboardNodeHostOcpuCount Integer
    (Updatable) 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.
    configureOutboundClusterTrigger Integer
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    dataNodeHostBareMetalShape String
    The bare metal shape for the cluster's data nodes.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    inboundClusterIds List<String>
    List of inbound clusters that will be queried using cross cluster search
    maintenanceDetails ClusterMaintenanceDetails
    (Updatable) Details for creation of maintenance details
    masterNodeHostBareMetalShape String
    The bare metal shape for the cluster's master nodes.
    outboundClusterConfig ClusterOutboundClusterConfig
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    reverseConnectionEndpointCustomerIps List<String>
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    securityMasterUserName String
    (Updatable) The name of the master user that are used to manage security config
    securityMasterUserPasswordHash String
    (Updatable) The password hash of the master user that are used to manage security config
    securityMode String
    (Updatable) The security mode of the cluster.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    upgradeMajorVersionTrigger Integer

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    The OCID of the compartment to create the cluster in.
    dataNodeCount number
    (Updatable) The number of data nodes to configure for the cluster.
    dataNodeHostMemoryGb number
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    dataNodeHostOcpuCount number
    (Updatable) 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
    (Updatable) 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
    (Updatable) The number of master nodes to configure for the cluster.
    masterNodeHostMemoryGb number
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    masterNodeHostOcpuCount number
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    opendashboardNodeHostMemoryGb number
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    opendashboardNodeHostOcpuCount number
    (Updatable) 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.
    configureOutboundClusterTrigger number
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    dataNodeHostBareMetalShape string
    The bare metal shape for the cluster's data nodes.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    inboundClusterIds string[]
    List of inbound clusters that will be queried using cross cluster search
    maintenanceDetails ClusterMaintenanceDetails
    (Updatable) Details for creation of maintenance details
    masterNodeHostBareMetalShape string
    The bare metal shape for the cluster's master nodes.
    outboundClusterConfig ClusterOutboundClusterConfig
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    reverseConnectionEndpointCustomerIps string[]
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    securityMasterUserName string
    (Updatable) The name of the master user that are used to manage security config
    securityMasterUserPasswordHash string
    (Updatable) The password hash of the master user that are used to manage security config
    securityMode string
    (Updatable) The security mode of the cluster.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    upgradeMajorVersionTrigger number

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    The OCID of the compartment to create the cluster in.
    data_node_count int
    (Updatable) The number of data nodes to configure for the cluster.
    data_node_host_memory_gb int
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    data_node_host_ocpu_count int
    (Updatable) 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
    (Updatable) 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
    (Updatable) The number of master nodes to configure for the cluster.
    master_node_host_memory_gb int
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    master_node_host_ocpu_count int
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    opendashboard_node_host_memory_gb int
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    opendashboard_node_host_ocpu_count int
    (Updatable) 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.
    configure_outbound_cluster_trigger int
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    data_node_host_bare_metal_shape str
    The bare metal shape for the cluster's data nodes.
    defined_tags Mapping[str, str]
    (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, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    inbound_cluster_ids Sequence[str]
    List of inbound clusters that will be queried using cross cluster search
    maintenance_details opensearch.ClusterMaintenanceDetailsArgs
    (Updatable) Details for creation of maintenance details
    master_node_host_bare_metal_shape str
    The bare metal shape for the cluster's master nodes.
    outbound_cluster_config opensearch.ClusterOutboundClusterConfigArgs
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    reverse_connection_endpoint_customer_ips Sequence[str]
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    security_master_user_name str
    (Updatable) The name of the master user that are used to manage security config
    security_master_user_password_hash str
    (Updatable) The password hash of the master user that are used to manage security config
    security_mode str
    (Updatable) The security mode of the cluster.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    upgrade_major_version_trigger int

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    The OCID of the compartment to create the cluster in.
    dataNodeCount Number
    (Updatable) The number of data nodes to configure for the cluster.
    dataNodeHostMemoryGb Number
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    dataNodeHostOcpuCount Number
    (Updatable) 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
    (Updatable) 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
    (Updatable) The number of master nodes to configure for the cluster.
    masterNodeHostMemoryGb Number
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    masterNodeHostOcpuCount Number
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    opendashboardNodeHostMemoryGb Number
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    opendashboardNodeHostOcpuCount Number
    (Updatable) 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.
    configureOutboundClusterTrigger Number
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    dataNodeHostBareMetalShape String
    The bare metal shape for the cluster's data nodes.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    inboundClusterIds List<String>
    List of inbound clusters that will be queried using cross cluster search
    maintenanceDetails Property Map
    (Updatable) Details for creation of maintenance details
    masterNodeHostBareMetalShape String
    The bare metal shape for the cluster's master nodes.
    outboundClusterConfig Property Map
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    reverseConnectionEndpointCustomerIps List<String>
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    securityMasterUserName String
    (Updatable) The name of the master user that are used to manage security config
    securityMasterUserPasswordHash String
    (Updatable) The password hash of the master user that are used to manage security config
    securityMode String
    (Updatable) The security mode of the cluster.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    upgradeMajorVersionTrigger Number

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    ReverseConnectionEndpoints List<ClusterReverseConnectionEndpoint>
    The list of reverse connection endpoints.
    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.
    ReverseConnectionEndpoints []ClusterReverseConnectionEndpoint
    The list of reverse connection endpoints.
    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.
    reverseConnectionEndpoints List<ClusterReverseConnectionEndpoint>
    The list of reverse connection endpoints.
    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.
    reverseConnectionEndpoints ClusterReverseConnectionEndpoint[]
    The list of reverse connection endpoints.
    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.
    reverse_connection_endpoints Sequence[opensearch.ClusterReverseConnectionEndpoint]
    The list of reverse connection endpoints.
    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.
    reverseConnectionEndpoints List<Property Map>
    The list of reverse connection endpoints.
    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 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,
        configure_outbound_cluster_trigger: Optional[int] = 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, str]] = None,
        display_name: Optional[str] = None,
        fqdn: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        inbound_cluster_ids: Optional[Sequence[str]] = None,
        lifecycle_details: Optional[str] = None,
        maintenance_details: Optional[_opensearch.ClusterMaintenanceDetailsArgs] = 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,
        outbound_cluster_config: Optional[_opensearch.ClusterOutboundClusterConfigArgs] = None,
        reverse_connection_endpoint_customer_ips: Optional[Sequence[str]] = None,
        reverse_connection_endpoints: Optional[Sequence[_opensearch.ClusterReverseConnectionEndpointArgs]] = None,
        security_master_user_name: Optional[str] = None,
        security_master_user_password_hash: Optional[str] = None,
        security_mode: 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, str]] = None,
        time_created: Optional[str] = None,
        time_deleted: Optional[str] = None,
        time_updated: Optional[str] = None,
        total_storage_gb: Optional[int] = None,
        upgrade_major_version_trigger: 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)
    resources:  _:    type: oci:Opensearch:Cluster    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:
    AvailabilityDomains List<string>
    The availability domains to distribute the cluser nodes across.
    CompartmentId string
    The OCID of the compartment to create the cluster in.
    ConfigureOutboundClusterTrigger int
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    DataNodeCount int
    (Updatable) The number of data nodes to configure for the cluster.
    DataNodeHostBareMetalShape string
    The bare metal shape for the cluster's data nodes.
    DataNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    DataNodeHostOcpuCount int
    (Updatable) 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
    (Updatable) The amount of storage in GB, to configure per node for the cluster's data nodes.
    DefinedTags Dictionary<string, string>
    (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, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    InboundClusterIds List<string>
    List of inbound clusters that will be queried using cross cluster search
    LifecycleDetails string
    Additional information about the current lifecycle state of the cluster.
    MaintenanceDetails ClusterMaintenanceDetails
    (Updatable) Details for creation of maintenance details
    MasterNodeCount int
    (Updatable) The number of master nodes to configure for the cluster.
    MasterNodeHostBareMetalShape string
    The bare metal shape for the cluster's master nodes.
    MasterNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    MasterNodeHostOcpuCount int
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    OpendashboardNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    OpendashboardNodeHostOcpuCount int
    (Updatable) 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.
    OutboundClusterConfig ClusterOutboundClusterConfig
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    ReverseConnectionEndpointCustomerIps List<string>
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    ReverseConnectionEndpoints List<ClusterReverseConnectionEndpoint>
    The list of reverse connection endpoints.
    SecurityMasterUserName string
    (Updatable) The name of the master user that are used to manage security config
    SecurityMasterUserPasswordHash string
    (Updatable) The password hash of the master user that are used to manage security config
    SecurityMode string
    (Updatable) The security mode of the cluster.
    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, string>
    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.
    UpgradeMajorVersionTrigger int

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    ConfigureOutboundClusterTrigger int
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    DataNodeCount int
    (Updatable) The number of data nodes to configure for the cluster.
    DataNodeHostBareMetalShape string
    The bare metal shape for the cluster's data nodes.
    DataNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    DataNodeHostOcpuCount int
    (Updatable) 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
    (Updatable) The amount of storage in GB, to configure per node for the cluster's data nodes.
    DefinedTags map[string]string
    (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]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    InboundClusterIds []string
    List of inbound clusters that will be queried using cross cluster search
    LifecycleDetails string
    Additional information about the current lifecycle state of the cluster.
    MaintenanceDetails ClusterMaintenanceDetailsArgs
    (Updatable) Details for creation of maintenance details
    MasterNodeCount int
    (Updatable) The number of master nodes to configure for the cluster.
    MasterNodeHostBareMetalShape string
    The bare metal shape for the cluster's master nodes.
    MasterNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    MasterNodeHostOcpuCount int
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    OpendashboardNodeHostMemoryGb int
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    OpendashboardNodeHostOcpuCount int
    (Updatable) 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.
    OutboundClusterConfig ClusterOutboundClusterConfigArgs
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    ReverseConnectionEndpointCustomerIps []string
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    ReverseConnectionEndpoints []ClusterReverseConnectionEndpointArgs
    The list of reverse connection endpoints.
    SecurityMasterUserName string
    (Updatable) The name of the master user that are used to manage security config
    SecurityMasterUserPasswordHash string
    (Updatable) The password hash of the master user that are used to manage security config
    SecurityMode string
    (Updatable) The security mode of the cluster.
    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]string
    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.
    UpgradeMajorVersionTrigger int

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    configureOutboundClusterTrigger Integer
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    dataNodeCount Integer
    (Updatable) The number of data nodes to configure for the cluster.
    dataNodeHostBareMetalShape String
    The bare metal shape for the cluster's data nodes.
    dataNodeHostMemoryGb Integer
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    dataNodeHostOcpuCount Integer
    (Updatable) 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
    (Updatable) The amount of storage in GB, to configure per node for the cluster's data nodes.
    definedTags Map<String,String>
    (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,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    inboundClusterIds List<String>
    List of inbound clusters that will be queried using cross cluster search
    lifecycleDetails String
    Additional information about the current lifecycle state of the cluster.
    maintenanceDetails ClusterMaintenanceDetails
    (Updatable) Details for creation of maintenance details
    masterNodeCount Integer
    (Updatable) The number of master nodes to configure for the cluster.
    masterNodeHostBareMetalShape String
    The bare metal shape for the cluster's master nodes.
    masterNodeHostMemoryGb Integer
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    masterNodeHostOcpuCount Integer
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    opendashboardNodeHostMemoryGb Integer
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    opendashboardNodeHostOcpuCount Integer
    (Updatable) 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.
    outboundClusterConfig ClusterOutboundClusterConfig
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    reverseConnectionEndpointCustomerIps List<String>
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    reverseConnectionEndpoints List<ClusterReverseConnectionEndpoint>
    The list of reverse connection endpoints.
    securityMasterUserName String
    (Updatable) The name of the master user that are used to manage security config
    securityMasterUserPasswordHash String
    (Updatable) The password hash of the master user that are used to manage security config
    securityMode String
    (Updatable) The security mode of the cluster.
    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,String>
    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.
    upgradeMajorVersionTrigger Integer

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    configureOutboundClusterTrigger number
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    dataNodeCount number
    (Updatable) The number of data nodes to configure for the cluster.
    dataNodeHostBareMetalShape string
    The bare metal shape for the cluster's data nodes.
    dataNodeHostMemoryGb number
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    dataNodeHostOcpuCount number
    (Updatable) 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
    (Updatable) The amount of storage in GB, to configure per node for the cluster's data nodes.
    definedTags {[key: string]: string}
    (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]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    inboundClusterIds string[]
    List of inbound clusters that will be queried using cross cluster search
    lifecycleDetails string
    Additional information about the current lifecycle state of the cluster.
    maintenanceDetails ClusterMaintenanceDetails
    (Updatable) Details for creation of maintenance details
    masterNodeCount number
    (Updatable) The number of master nodes to configure for the cluster.
    masterNodeHostBareMetalShape string
    The bare metal shape for the cluster's master nodes.
    masterNodeHostMemoryGb number
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    masterNodeHostOcpuCount number
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    opendashboardNodeHostMemoryGb number
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    opendashboardNodeHostOcpuCount number
    (Updatable) 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.
    outboundClusterConfig ClusterOutboundClusterConfig
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    reverseConnectionEndpointCustomerIps string[]
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    reverseConnectionEndpoints ClusterReverseConnectionEndpoint[]
    The list of reverse connection endpoints.
    securityMasterUserName string
    (Updatable) The name of the master user that are used to manage security config
    securityMasterUserPasswordHash string
    (Updatable) The password hash of the master user that are used to manage security config
    securityMode string
    (Updatable) The security mode of the cluster.
    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]: string}
    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.
    upgradeMajorVersionTrigger number

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    configure_outbound_cluster_trigger int
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    data_node_count int
    (Updatable) 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
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    data_node_host_ocpu_count int
    (Updatable) 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
    (Updatable) The amount of storage in GB, to configure per node for the cluster's data nodes.
    defined_tags Mapping[str, str]
    (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, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    inbound_cluster_ids Sequence[str]
    List of inbound clusters that will be queried using cross cluster search
    lifecycle_details str
    Additional information about the current lifecycle state of the cluster.
    maintenance_details opensearch.ClusterMaintenanceDetailsArgs
    (Updatable) Details for creation of maintenance details
    master_node_count int
    (Updatable) 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
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    master_node_host_ocpu_count int
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    opendashboard_node_host_memory_gb int
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    opendashboard_node_host_ocpu_count int
    (Updatable) 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.
    outbound_cluster_config opensearch.ClusterOutboundClusterConfigArgs
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    reverse_connection_endpoint_customer_ips Sequence[str]
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    reverse_connection_endpoints Sequence[opensearch.ClusterReverseConnectionEndpointArgs]
    The list of reverse connection endpoints.
    security_master_user_name str
    (Updatable) The name of the master user that are used to manage security config
    security_master_user_password_hash str
    (Updatable) The password hash of the master user that are used to manage security config
    security_mode str
    (Updatable) The security mode of the cluster.
    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, str]
    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.
    upgrade_major_version_trigger int

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    configureOutboundClusterTrigger Number
    (Updatable) An optional property when incremented triggers Configure Outbound Cluster. Could be set to any integer value.
    dataNodeCount Number
    (Updatable) The number of data nodes to configure for the cluster.
    dataNodeHostBareMetalShape String
    The bare metal shape for the cluster's data nodes.
    dataNodeHostMemoryGb Number
    (Updatable) The amount of memory in GB, to configure per node for the cluster's data nodes.
    dataNodeHostOcpuCount Number
    (Updatable) 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
    (Updatable) The amount of storage in GB, to configure per node for the cluster's data nodes.
    definedTags Map<String>
    (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>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    inboundClusterIds List<String>
    List of inbound clusters that will be queried using cross cluster search
    lifecycleDetails String
    Additional information about the current lifecycle state of the cluster.
    maintenanceDetails Property Map
    (Updatable) Details for creation of maintenance details
    masterNodeCount Number
    (Updatable) The number of master nodes to configure for the cluster.
    masterNodeHostBareMetalShape String
    The bare metal shape for the cluster's master nodes.
    masterNodeHostMemoryGb Number
    (Updatable) The amount of memory in GB, to configure per node for the cluster's master nodes.
    masterNodeHostOcpuCount Number
    (Updatable) 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
    (Updatable) The number of OpenSearch Dashboard nodes to configure for the cluster.
    opendashboardNodeHostMemoryGb Number
    (Updatable) The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
    opendashboardNodeHostOcpuCount Number
    (Updatable) 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.
    outboundClusterConfig Property Map
    (Updatable) This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
    reverseConnectionEndpointCustomerIps List<String>
    (Updatable) The customer IP addresses of the endpoint in customer VCN
    reverseConnectionEndpoints List<Property Map>
    The list of reverse connection endpoints.
    securityMasterUserName String
    (Updatable) The name of the master user that are used to manage security config
    securityMasterUserPasswordHash String
    (Updatable) The password hash of the master user that are used to manage security config
    securityMode String
    (Updatable) The security mode of the cluster.
    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>
    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.
    upgradeMajorVersionTrigger Number

    An optional property to upgrade the major version of the cluster. This workflow upgrades the cluster without creating a clone. If you want to create a clone and upgrade the clone for testing please use SDK or CLI.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    vcnCompartmentId String
    The OCID for the compartment where the cluster's VCN is located.
    vcnId String
    The OCID of the cluster's VCN.

    Supporting Types

    ClusterMaintenanceDetails, ClusterMaintenanceDetailsArgs

    EndTime string
    End time of the maintenance activity
    NotificationEmailIds List<string>
    (Updatable) The Email IDs given by the customer to get notified about maintenance activities
    StartTime string
    Start time of the maintenance activity
    State string
    The current state of the cluster.
    EndTime string
    End time of the maintenance activity
    NotificationEmailIds []string
    (Updatable) The Email IDs given by the customer to get notified about maintenance activities
    StartTime string
    Start time of the maintenance activity
    State string
    The current state of the cluster.
    endTime String
    End time of the maintenance activity
    notificationEmailIds List<String>
    (Updatable) The Email IDs given by the customer to get notified about maintenance activities
    startTime String
    Start time of the maintenance activity
    state String
    The current state of the cluster.
    endTime string
    End time of the maintenance activity
    notificationEmailIds string[]
    (Updatable) The Email IDs given by the customer to get notified about maintenance activities
    startTime string
    Start time of the maintenance activity
    state string
    The current state of the cluster.
    end_time str
    End time of the maintenance activity
    notification_email_ids Sequence[str]
    (Updatable) The Email IDs given by the customer to get notified about maintenance activities
    start_time str
    Start time of the maintenance activity
    state str
    The current state of the cluster.
    endTime String
    End time of the maintenance activity
    notificationEmailIds List<String>
    (Updatable) The Email IDs given by the customer to get notified about maintenance activities
    startTime String
    Start time of the maintenance activity
    state String
    The current state of the cluster.

    ClusterOutboundClusterConfig, ClusterOutboundClusterConfigArgs

    IsEnabled bool
    (Updatable) Flag to indicate whether outbound cluster configuration is enabled
    OutboundClusters List<ClusterOutboundClusterConfigOutboundCluster>
    (Updatable) List of outbound clusters to be connected to the inbound cluster
    IsEnabled bool
    (Updatable) Flag to indicate whether outbound cluster configuration is enabled
    OutboundClusters []ClusterOutboundClusterConfigOutboundCluster
    (Updatable) List of outbound clusters to be connected to the inbound cluster
    isEnabled Boolean
    (Updatable) Flag to indicate whether outbound cluster configuration is enabled
    outboundClusters List<ClusterOutboundClusterConfigOutboundCluster>
    (Updatable) List of outbound clusters to be connected to the inbound cluster
    isEnabled boolean
    (Updatable) Flag to indicate whether outbound cluster configuration is enabled
    outboundClusters ClusterOutboundClusterConfigOutboundCluster[]
    (Updatable) List of outbound clusters to be connected to the inbound cluster
    is_enabled bool
    (Updatable) Flag to indicate whether outbound cluster configuration is enabled
    outbound_clusters Sequence[opensearch.ClusterOutboundClusterConfigOutboundCluster]
    (Updatable) List of outbound clusters to be connected to the inbound cluster
    isEnabled Boolean
    (Updatable) Flag to indicate whether outbound cluster configuration is enabled
    outboundClusters List<Property Map>
    (Updatable) List of outbound clusters to be connected to the inbound cluster

    ClusterOutboundClusterConfigOutboundCluster, ClusterOutboundClusterConfigOutboundClusterArgs

    DisplayName string
    (Updatable) Name of the Outbound cluster. Avoid entering confidential information.
    SeedClusterId string
    (Updatable) OCID of the Outbound cluster
    IsSkipUnavailable bool
    (Updatable) Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    Mode string
    (Updatable) Mode for the cross cluster connection
    PingSchedule string
    (Updatable) Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
    DisplayName string
    (Updatable) Name of the Outbound cluster. Avoid entering confidential information.
    SeedClusterId string
    (Updatable) OCID of the Outbound cluster
    IsSkipUnavailable bool
    (Updatable) Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    Mode string
    (Updatable) Mode for the cross cluster connection
    PingSchedule string
    (Updatable) Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
    displayName String
    (Updatable) Name of the Outbound cluster. Avoid entering confidential information.
    seedClusterId String
    (Updatable) OCID of the Outbound cluster
    isSkipUnavailable Boolean
    (Updatable) Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    mode String
    (Updatable) Mode for the cross cluster connection
    pingSchedule String
    (Updatable) Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
    displayName string
    (Updatable) Name of the Outbound cluster. Avoid entering confidential information.
    seedClusterId string
    (Updatable) OCID of the Outbound cluster
    isSkipUnavailable boolean
    (Updatable) Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    mode string
    (Updatable) Mode for the cross cluster connection
    pingSchedule string
    (Updatable) Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
    display_name str
    (Updatable) Name of the Outbound cluster. Avoid entering confidential information.
    seed_cluster_id str
    (Updatable) OCID of the Outbound cluster
    is_skip_unavailable bool
    (Updatable) Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    mode str
    (Updatable) Mode for the cross cluster connection
    ping_schedule str
    (Updatable) Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
    displayName String
    (Updatable) Name of the Outbound cluster. Avoid entering confidential information.
    seedClusterId String
    (Updatable) OCID of the Outbound cluster
    isSkipUnavailable Boolean
    (Updatable) Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    mode String
    (Updatable) Mode for the cross cluster connection
    pingSchedule String
    (Updatable) Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.

    ClusterReverseConnectionEndpoint, ClusterReverseConnectionEndpointArgs

    CustomerIp string
    The IP addresses of the endpoint in customer VCN
    NatIp string
    The NAT IP addresses of the endpoint in service VCN
    CustomerIp string
    The IP addresses of the endpoint in customer VCN
    NatIp string
    The NAT IP addresses of the endpoint in service VCN
    customerIp String
    The IP addresses of the endpoint in customer VCN
    natIp String
    The NAT IP addresses of the endpoint in service VCN
    customerIp string
    The IP addresses of the endpoint in customer VCN
    natIp string
    The NAT IP addresses of the endpoint in service VCN
    customer_ip str
    The IP addresses of the endpoint in customer VCN
    nat_ip str
    The NAT IP addresses of the endpoint in service VCN
    customerIp String
    The IP addresses of the endpoint in customer VCN
    natIp String
    The NAT IP addresses of the endpoint in service VCN

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-oci