Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.BigDataService.BdsInstanceMetastoreConfig

This resource provides the Bds Instance Metastore Config resource in Oracle Cloud Infrastructure Big Data Service service.

Create and activate external metastore configuration.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testBdsInstanceMetastoreConfig = new Oci.BigDataService.BdsInstanceMetastoreConfig("testBdsInstanceMetastoreConfig", new()
    {
        BdsApiKeyId = oci_identity_api_key.Test_api_key.Id,
        BdsApiKeyPassphrase = @var.Bds_instance_metastore_config_bds_api_key_passphrase,
        BdsInstanceId = oci_bds_bds_instance.Test_bds_instance.Id,
        ClusterAdminPassword = @var.Bds_instance_metastore_config_cluster_admin_password,
        MetastoreId = oci_datacatalog_metastore.Test_metastore.Id,
        DisplayName = @var.Bds_instance_metastore_config_display_name,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := BigDataService.NewBdsInstanceMetastoreConfig(ctx, "testBdsInstanceMetastoreConfig", &BigDataService.BdsInstanceMetastoreConfigArgs{
			BdsApiKeyId:          pulumi.Any(oci_identity_api_key.Test_api_key.Id),
			BdsApiKeyPassphrase:  pulumi.Any(_var.Bds_instance_metastore_config_bds_api_key_passphrase),
			BdsInstanceId:        pulumi.Any(oci_bds_bds_instance.Test_bds_instance.Id),
			ClusterAdminPassword: pulumi.Any(_var.Bds_instance_metastore_config_cluster_admin_password),
			MetastoreId:          pulumi.Any(oci_datacatalog_metastore.Test_metastore.Id),
			DisplayName:          pulumi.Any(_var.Bds_instance_metastore_config_display_name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.BigDataService.BdsInstanceMetastoreConfig;
import com.pulumi.oci.BigDataService.BdsInstanceMetastoreConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var testBdsInstanceMetastoreConfig = new BdsInstanceMetastoreConfig("testBdsInstanceMetastoreConfig", BdsInstanceMetastoreConfigArgs.builder()        
            .bdsApiKeyId(oci_identity_api_key.test_api_key().id())
            .bdsApiKeyPassphrase(var_.bds_instance_metastore_config_bds_api_key_passphrase())
            .bdsInstanceId(oci_bds_bds_instance.test_bds_instance().id())
            .clusterAdminPassword(var_.bds_instance_metastore_config_cluster_admin_password())
            .metastoreId(oci_datacatalog_metastore.test_metastore().id())
            .displayName(var_.bds_instance_metastore_config_display_name())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_bds_instance_metastore_config = oci.big_data_service.BdsInstanceMetastoreConfig("testBdsInstanceMetastoreConfig",
    bds_api_key_id=oci_identity_api_key["test_api_key"]["id"],
    bds_api_key_passphrase=var["bds_instance_metastore_config_bds_api_key_passphrase"],
    bds_instance_id=oci_bds_bds_instance["test_bds_instance"]["id"],
    cluster_admin_password=var["bds_instance_metastore_config_cluster_admin_password"],
    metastore_id=oci_datacatalog_metastore["test_metastore"]["id"],
    display_name=var["bds_instance_metastore_config_display_name"])

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

const testBdsInstanceMetastoreConfig = new oci.bigdataservice.BdsInstanceMetastoreConfig("testBdsInstanceMetastoreConfig", {
    bdsApiKeyId: oci_identity_api_key.test_api_key.id,
    bdsApiKeyPassphrase: _var.bds_instance_metastore_config_bds_api_key_passphrase,
    bdsInstanceId: oci_bds_bds_instance.test_bds_instance.id,
    clusterAdminPassword: _var.bds_instance_metastore_config_cluster_admin_password,
    metastoreId: oci_datacatalog_metastore.test_metastore.id,
    displayName: _var.bds_instance_metastore_config_display_name,
});

resources:
  testBdsInstanceMetastoreConfig:
    type: oci:BigDataService:BdsInstanceMetastoreConfig
    properties:
      #Required
      bdsApiKeyId: ${oci_identity_api_key.test_api_key.id}
      bdsApiKeyPassphrase: ${var.bds_instance_metastore_config_bds_api_key_passphrase}
      bdsInstanceId: ${oci_bds_bds_instance.test_bds_instance.id}
      clusterAdminPassword: ${var.bds_instance_metastore_config_cluster_admin_password}
      metastoreId: ${oci_datacatalog_metastore.test_metastore.id}
      #Optional
      displayName: ${var.bds_instance_metastore_config_display_name}

Create BdsInstanceMetastoreConfig Resource

new BdsInstanceMetastoreConfig(name: string, args: BdsInstanceMetastoreConfigArgs, opts?: CustomResourceOptions);

@overload
def BdsInstanceMetastoreConfig(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               activate_trigger: Optional[int] = None,
                               bds_api_key_id: Optional[str] = None,
                               bds_api_key_passphrase: Optional[str] = None,
                               bds_instance_id: Optional[str] = None,
                               cluster_admin_password: Optional[str] = None,
                               display_name: Optional[str] = None,
                               metastore_id: Optional[str] = None)
@overload
def BdsInstanceMetastoreConfig(resource_name: str,
                               args: BdsInstanceMetastoreConfigArgs,
                               opts: Optional[ResourceOptions] = None)

func NewBdsInstanceMetastoreConfig(ctx *Context, name string, args BdsInstanceMetastoreConfigArgs, opts ...ResourceOption) (*BdsInstanceMetastoreConfig, error)

public BdsInstanceMetastoreConfig(string name, BdsInstanceMetastoreConfigArgs args, CustomResourceOptions? opts = null)

public BdsInstanceMetastoreConfig(String name, BdsInstanceMetastoreConfigArgs args)
public BdsInstanceMetastoreConfig(String name, BdsInstanceMetastoreConfigArgs args, CustomResourceOptions options)

type: oci:BigDataService:BdsInstanceMetastoreConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

name string: The unique name of the resource.
args BdsInstanceMetastoreConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BdsInstanceMetastoreConfigArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

BdsInstanceMetastoreConfig Resource Properties

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

Inputs

The BdsInstanceMetastoreConfig resource accepts the following input properties:

BdsApiKeyId string: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
BdsApiKeyPassphrase string: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
BdsInstanceId string: The OCID of the cluster.
ClusterAdminPassword string: (Updatable) Base-64 encoded password for the cluster admin user.
MetastoreId string: The OCID of the Data Catalog metastore.
ActivateTrigger int: (Updatable) An optional integer, when flipped triggers activation of metastore config.
DisplayName string: (Updatable) The display name of the metastore configuration

BdsApiKeyId string: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
BdsApiKeyPassphrase string: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
BdsInstanceId string: The OCID of the cluster.
ClusterAdminPassword string: (Updatable) Base-64 encoded password for the cluster admin user.
MetastoreId string: The OCID of the Data Catalog metastore.
ActivateTrigger int: (Updatable) An optional integer, when flipped triggers activation of metastore config.
DisplayName string: (Updatable) The display name of the metastore configuration

bdsApiKeyId String: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
bdsApiKeyPassphrase String: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
bdsInstanceId String: The OCID of the cluster.
clusterAdminPassword String: (Updatable) Base-64 encoded password for the cluster admin user.
metastoreId String: The OCID of the Data Catalog metastore.
activateTrigger Integer: (Updatable) An optional integer, when flipped triggers activation of metastore config.
displayName String: (Updatable) The display name of the metastore configuration

bdsApiKeyId string: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
bdsApiKeyPassphrase string: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
bdsInstanceId string: The OCID of the cluster.
clusterAdminPassword string: (Updatable) Base-64 encoded password for the cluster admin user.
metastoreId string: The OCID of the Data Catalog metastore.
activateTrigger number: (Updatable) An optional integer, when flipped triggers activation of metastore config.
displayName string: (Updatable) The display name of the metastore configuration

bds_api_key_id str: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
bds_api_key_passphrase str: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
bds_instance_id str: The OCID of the cluster.
cluster_admin_password str: (Updatable) Base-64 encoded password for the cluster admin user.
metastore_id str: The OCID of the Data Catalog metastore.
activate_trigger int: (Updatable) An optional integer, when flipped triggers activation of metastore config.
display_name str: (Updatable) The display name of the metastore configuration

bdsApiKeyId String: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
bdsApiKeyPassphrase String: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
bdsInstanceId String: The OCID of the cluster.
clusterAdminPassword String: (Updatable) Base-64 encoded password for the cluster admin user.
metastoreId String: The OCID of the Data Catalog metastore.
activateTrigger Number: (Updatable) An optional integer, when flipped triggers activation of metastore config.
displayName String: (Updatable) The display name of the metastore configuration

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
MetastoreType string: The type of the metastore in the metastore configuration.
State string: the lifecycle state of the metastore configuration.
TimeCreated string: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
TimeUpdated string: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

Id string: The provider-assigned unique ID for this managed resource.
MetastoreType string: The type of the metastore in the metastore configuration.
State string: the lifecycle state of the metastore configuration.
TimeCreated string: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
TimeUpdated string: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

id String: The provider-assigned unique ID for this managed resource.
metastoreType String: The type of the metastore in the metastore configuration.
state String: the lifecycle state of the metastore configuration.
timeCreated String: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
timeUpdated String: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

id string: The provider-assigned unique ID for this managed resource.
metastoreType string: The type of the metastore in the metastore configuration.
state string: the lifecycle state of the metastore configuration.
timeCreated string: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
timeUpdated string: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

id str: The provider-assigned unique ID for this managed resource.
metastore_type str: The type of the metastore in the metastore configuration.
state str: the lifecycle state of the metastore configuration.
time_created str: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
time_updated str: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

id String: The provider-assigned unique ID for this managed resource.
metastoreType String: The type of the metastore in the metastore configuration.
state String: the lifecycle state of the metastore configuration.
timeCreated String: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
timeUpdated String: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

Look up Existing BdsInstanceMetastoreConfig Resource

Get an existing BdsInstanceMetastoreConfig 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?: BdsInstanceMetastoreConfigState, opts?: CustomResourceOptions): BdsInstanceMetastoreConfig

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activate_trigger: Optional[int] = None,
        bds_api_key_id: Optional[str] = None,
        bds_api_key_passphrase: Optional[str] = None,
        bds_instance_id: Optional[str] = None,
        cluster_admin_password: Optional[str] = None,
        display_name: Optional[str] = None,
        metastore_id: Optional[str] = None,
        metastore_type: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> BdsInstanceMetastoreConfig

func GetBdsInstanceMetastoreConfig(ctx *Context, name string, id IDInput, state *BdsInstanceMetastoreConfigState, opts ...ResourceOption) (*BdsInstanceMetastoreConfig, error)

public static BdsInstanceMetastoreConfig Get(string name, Input<string> id, BdsInstanceMetastoreConfigState? state, CustomResourceOptions? opts = null)

public static BdsInstanceMetastoreConfig get(String name, Output<String> id, BdsInstanceMetastoreConfigState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ActivateTrigger int: (Updatable) An optional integer, when flipped triggers activation of metastore config.
BdsApiKeyId string: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
BdsApiKeyPassphrase string: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
BdsInstanceId string: The OCID of the cluster.
ClusterAdminPassword string: (Updatable) Base-64 encoded password for the cluster admin user.
DisplayName string: (Updatable) The display name of the metastore configuration
MetastoreId string: The OCID of the Data Catalog metastore.
MetastoreType string: The type of the metastore in the metastore configuration.
State string: the lifecycle state of the metastore configuration.
TimeCreated string: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
TimeUpdated string: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

ActivateTrigger int: (Updatable) An optional integer, when flipped triggers activation of metastore config.
BdsApiKeyId string: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
BdsApiKeyPassphrase string: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
BdsInstanceId string: The OCID of the cluster.
ClusterAdminPassword string: (Updatable) Base-64 encoded password for the cluster admin user.
DisplayName string: (Updatable) The display name of the metastore configuration
MetastoreId string: The OCID of the Data Catalog metastore.
MetastoreType string: The type of the metastore in the metastore configuration.
State string: the lifecycle state of the metastore configuration.
TimeCreated string: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
TimeUpdated string: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

activateTrigger Integer: (Updatable) An optional integer, when flipped triggers activation of metastore config.
bdsApiKeyId String: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
bdsApiKeyPassphrase String: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
bdsInstanceId String: The OCID of the cluster.
clusterAdminPassword String: (Updatable) Base-64 encoded password for the cluster admin user.
displayName String: (Updatable) The display name of the metastore configuration
metastoreId String: The OCID of the Data Catalog metastore.
metastoreType String: The type of the metastore in the metastore configuration.
state String: the lifecycle state of the metastore configuration.
timeCreated String: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
timeUpdated String: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

activateTrigger number: (Updatable) An optional integer, when flipped triggers activation of metastore config.
bdsApiKeyId string: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
bdsApiKeyPassphrase string: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
bdsInstanceId string: The OCID of the cluster.
clusterAdminPassword string: (Updatable) Base-64 encoded password for the cluster admin user.
displayName string: (Updatable) The display name of the metastore configuration
metastoreId string: The OCID of the Data Catalog metastore.
metastoreType string: The type of the metastore in the metastore configuration.
state string: the lifecycle state of the metastore configuration.
timeCreated string: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
timeUpdated string: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

activate_trigger int: (Updatable) An optional integer, when flipped triggers activation of metastore config.
bds_api_key_id str: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
bds_api_key_passphrase str: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
bds_instance_id str: The OCID of the cluster.
cluster_admin_password str: (Updatable) Base-64 encoded password for the cluster admin user.
display_name str: (Updatable) The display name of the metastore configuration
metastore_id str: The OCID of the Data Catalog metastore.
metastore_type str: The type of the metastore in the metastore configuration.
state str: the lifecycle state of the metastore configuration.
time_created str: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
time_updated str: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

activateTrigger Number: (Updatable) An optional integer, when flipped triggers activation of metastore config.
bdsApiKeyId String: (Updatable) The ID of BDS Api Key used for Data Catalog metastore integration.
bdsApiKeyPassphrase String: (Updatable) Base-64 encoded passphrase of the BDS Api Key.
bdsInstanceId String: The OCID of the cluster.
clusterAdminPassword String: (Updatable) Base-64 encoded password for the cluster admin user.
displayName String: (Updatable) The display name of the metastore configuration
metastoreId String: The OCID of the Data Catalog metastore.
metastoreType String: The type of the metastore in the metastore configuration.
state String: the lifecycle state of the metastore configuration.
timeCreated String: The time when the configuration was created, shown as an RFC 3339 formatted datetime string.
timeUpdated String: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

Import

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

 $ pulumi import oci:BigDataService/bdsInstanceMetastoreConfig:BdsInstanceMetastoreConfig test_bds_instance_metastore_config "bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}"

Package Details

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