Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opensearch Provider
  3. API Docs
  4. DashboardTenant
opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
opensearch-project/terraform-provider-opensearch

opensearch.DashboardTenant

Explore with Pulumi AI

opensearch logo
opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
opensearch-project/terraform-provider-opensearch

    Provides an OpenSearch dashboard tenant resource. Please refer to the OpenSearch documentation for details.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as opensearch from "@pulumi/opensearch";

// Create a tenant
const test = new opensearch.DashboardTenant("test", {
    description: "test tenant",
    tenantName: "test",
});

    import pulumi
import pulumi_opensearch as opensearch

# Create a tenant
test = opensearch.DashboardTenant("test",
    description="test tenant",
    tenant_name="test")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opensearch/v2/opensearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a tenant
		_, err := opensearch.NewDashboardTenant(ctx, "test", &opensearch.DashboardTenantArgs{
			Description: pulumi.String("test tenant"),
			TenantName:  pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Create a tenant
    var test = new Opensearch.DashboardTenant("test", new()
    {
        Description = "test tenant",
        TenantName = "test",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opensearch.DashboardTenant;
import com.pulumi.opensearch.DashboardTenantArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        // Create a tenant
        var test = new DashboardTenant("test", DashboardTenantArgs.builder()
            .description("test tenant")
            .tenantName("test")
            .build());

    }
}

    resources:
  # Create a tenant
  test:
    type: opensearch:DashboardTenant
    properties:
      description: test tenant
      tenantName: test

    Create DashboardTenant Resource

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

    Constructor syntax

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

@overload
def DashboardTenant(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    tenant_name: Optional[str] = None,
                    dashboard_tenant_id: Optional[str] = None,
                    description: Optional[str] = None)
    func NewDashboardTenant(ctx *Context, name string, args DashboardTenantArgs, opts ...ResourceOption) (*DashboardTenant, error)
    public DashboardTenant(string name, DashboardTenantArgs args, CustomResourceOptions? opts = null)
    public DashboardTenant(String name, DashboardTenantArgs args)
public DashboardTenant(String name, DashboardTenantArgs args, CustomResourceOptions options)

    type: opensearch:DashboardTenant
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 DashboardTenantArgs
    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 DashboardTenantArgs
    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 DashboardTenantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardTenantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardTenantArgs
    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 dashboardTenantResource = new Opensearch.DashboardTenant("dashboardTenantResource", new()
{
    TenantName = "string",
    DashboardTenantId = "string",
    Description = "string",
});

    example, err := opensearch.NewDashboardTenant(ctx, "dashboardTenantResource", &opensearch.DashboardTenantArgs{
	TenantName:        pulumi.String("string"),
	DashboardTenantId: pulumi.String("string"),
	Description:       pulumi.String("string"),
})

    var dashboardTenantResource = new DashboardTenant("dashboardTenantResource", DashboardTenantArgs.builder()
    .tenantName("string")
    .dashboardTenantId("string")
    .description("string")
    .build());

    dashboard_tenant_resource = opensearch.DashboardTenant("dashboardTenantResource",
    tenant_name="string",
    dashboard_tenant_id="string",
    description="string")

    const dashboardTenantResource = new opensearch.DashboardTenant("dashboardTenantResource", {
    tenantName: "string",
    dashboardTenantId: "string",
    description: "string",
});

    type: opensearch:DashboardTenant
properties:
    dashboardTenantId: string
    description: string
    tenantName: string

    DashboardTenant 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 DashboardTenant resource accepts the following input properties:

    TenantName string
    The name of the tenant.
    DashboardTenantId string
    The ID of this resource.
    Description string
    Description of the tenant.
    TenantName string
    The name of the tenant.
    DashboardTenantId string
    The ID of this resource.
    Description string
    Description of the tenant.
    tenantName String
    The name of the tenant.
    dashboardTenantId String
    The ID of this resource.
    description String
    Description of the tenant.
    tenantName string
    The name of the tenant.
    dashboardTenantId string
    The ID of this resource.
    description string
    Description of the tenant.
    tenant_name str
    The name of the tenant.
    dashboard_tenant_id str
    The ID of this resource.
    description str
    Description of the tenant.
    tenantName String
    The name of the tenant.
    dashboardTenantId String
    The ID of this resource.
    description String
    Description of the tenant.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Index string
    Id string
    The provider-assigned unique ID for this managed resource.
    Index string
    id String
    The provider-assigned unique ID for this managed resource.
    index String
    id string
    The provider-assigned unique ID for this managed resource.
    index string
    id str
    The provider-assigned unique ID for this managed resource.
    index str
    id String
    The provider-assigned unique ID for this managed resource.
    index String

    Look up Existing DashboardTenant Resource

    Get an existing DashboardTenant 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?: DashboardTenantState, opts?: CustomResourceOptions): DashboardTenant
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dashboard_tenant_id: Optional[str] = None,
        description: Optional[str] = None,
        index: Optional[str] = None,
        tenant_name: Optional[str] = None) -> DashboardTenant
    func GetDashboardTenant(ctx *Context, name string, id IDInput, state *DashboardTenantState, opts ...ResourceOption) (*DashboardTenant, error)
    public static DashboardTenant Get(string name, Input<string> id, DashboardTenantState? state, CustomResourceOptions? opts = null)
    public static DashboardTenant get(String name, Output<String> id, DashboardTenantState state, CustomResourceOptions options)
    resources:  _:    type: opensearch:DashboardTenant    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:
    DashboardTenantId string
    The ID of this resource.
    Description string
    Description of the tenant.
    Index string
    TenantName string
    The name of the tenant.
    DashboardTenantId string
    The ID of this resource.
    Description string
    Description of the tenant.
    Index string
    TenantName string
    The name of the tenant.
    dashboardTenantId String
    The ID of this resource.
    description String
    Description of the tenant.
    index String
    tenantName String
    The name of the tenant.
    dashboardTenantId string
    The ID of this resource.
    description string
    Description of the tenant.
    index string
    tenantName string
    The name of the tenant.
    dashboard_tenant_id str
    The ID of this resource.
    description str
    Description of the tenant.
    index str
    tenant_name str
    The name of the tenant.
    dashboardTenantId String
    The ID of this resource.
    description String
    Description of the tenant.
    index String
    tenantName String
    The name of the tenant.

    Import

    $ pulumi import opensearch:index/dashboardTenant:DashboardTenant writer test

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

    Package Details

    Repository
    opensearch opensearch-project/terraform-provider-opensearch
    License
    Notes
    This Pulumi package is based on the opensearch Terraform Provider.
    opensearch logo
    opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
    opensearch-project/terraform-provider-opensearch