Docs Packages
  1. Pulumi Registry
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. dataproc
  5. MetastoreService
gcp logo
Google Cloud Classic v6.56.0, May 18 23

gcp.dataproc.MetastoreService

Explore with Pulumi AI

A managed metastore service that serves metadata queries.

To get more information about Service, see:

Example Usage

Dataproc Metastore Service Basic

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

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.Dataproc.MetastoreService("default", new()
    {
        HiveMetastoreConfig = new Gcp.Dataproc.Inputs.MetastoreServiceHiveMetastoreConfigArgs
        {
            Version = "2.3.6",
        },
        Location = "us-central1",
        MaintenanceWindow = new Gcp.Dataproc.Inputs.MetastoreServiceMaintenanceWindowArgs
        {
            DayOfWeek = "SUNDAY",
            HourOfDay = 2,
        },
        Port = 9080,
        ServiceId = "metastore-srv",
        Tier = "DEVELOPER",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/dataproc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataproc.NewMetastoreService(ctx, "default", &dataproc.MetastoreServiceArgs{
			HiveMetastoreConfig: &dataproc.MetastoreServiceHiveMetastoreConfigArgs{
				Version: pulumi.String("2.3.6"),
			},
			Location: pulumi.String("us-central1"),
			MaintenanceWindow: &dataproc.MetastoreServiceMaintenanceWindowArgs{
				DayOfWeek: pulumi.String("SUNDAY"),
				HourOfDay: pulumi.Int(2),
			},
			Port:      pulumi.Int(9080),
			ServiceId: pulumi.String("metastore-srv"),
			Tier:      pulumi.String("DEVELOPER"),
		})
		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.gcp.dataproc.MetastoreService;
import com.pulumi.gcp.dataproc.MetastoreServiceArgs;
import com.pulumi.gcp.dataproc.inputs.MetastoreServiceHiveMetastoreConfigArgs;
import com.pulumi.gcp.dataproc.inputs.MetastoreServiceMaintenanceWindowArgs;
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 default_ = new MetastoreService("default", MetastoreServiceArgs.builder()        
            .hiveMetastoreConfig(MetastoreServiceHiveMetastoreConfigArgs.builder()
                .version("2.3.6")
                .build())
            .location("us-central1")
            .maintenanceWindow(MetastoreServiceMaintenanceWindowArgs.builder()
                .dayOfWeek("SUNDAY")
                .hourOfDay(2)
                .build())
            .port(9080)
            .serviceId("metastore-srv")
            .tier("DEVELOPER")
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

default = gcp.dataproc.MetastoreService("default",
    hive_metastore_config=gcp.dataproc.MetastoreServiceHiveMetastoreConfigArgs(
        version="2.3.6",
    ),
    location="us-central1",
    maintenance_window=gcp.dataproc.MetastoreServiceMaintenanceWindowArgs(
        day_of_week="SUNDAY",
        hour_of_day=2,
    ),
    port=9080,
    service_id="metastore-srv",
    tier="DEVELOPER")

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

const _default = new gcp.dataproc.MetastoreService("default", {
    hiveMetastoreConfig: {
        version: "2.3.6",
    },
    location: "us-central1",
    maintenanceWindow: {
        dayOfWeek: "SUNDAY",
        hourOfDay: 2,
    },
    port: 9080,
    serviceId: "metastore-srv",
    tier: "DEVELOPER",
});

resources:
  default:
    type: gcp:dataproc:MetastoreService
    properties:
      hiveMetastoreConfig:
        version: 2.3.6
      location: us-central1
      maintenanceWindow:
        dayOfWeek: SUNDAY
        hourOfDay: 2
      port: 9080
      serviceId: metastore-srv
      tier: DEVELOPER

Dataproc Metastore Service Cmek Example

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

return await Deployment.RunAsync(() => 
{
    var keyRing = new Gcp.Kms.KeyRing("keyRing", new()
    {
        Location = "us-central1",
    }, new CustomResourceOptions
    {
        Provider = google_beta,
    });

    var cryptoKey = new Gcp.Kms.CryptoKey("cryptoKey", new()
    {
        KeyRing = keyRing.Id,
        Purpose = "ENCRYPT_DECRYPT",
    }, new CustomResourceOptions
    {
        Provider = google_beta,
    });

    var @default = new Gcp.Dataproc.MetastoreService("default", new()
    {
        ServiceId = "example-service",
        Location = "us-central1",
        EncryptionConfig = new Gcp.Dataproc.Inputs.MetastoreServiceEncryptionConfigArgs
        {
            KmsKey = cryptoKey.Id,
        },
        HiveMetastoreConfig = new Gcp.Dataproc.Inputs.MetastoreServiceHiveMetastoreConfigArgs
        {
            Version = "3.1.2",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/dataproc"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/kms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		keyRing, err := kms.NewKeyRing(ctx, "keyRing", &kms.KeyRingArgs{
			Location: pulumi.String("us-central1"),
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		cryptoKey, err := kms.NewCryptoKey(ctx, "cryptoKey", &kms.CryptoKeyArgs{
			KeyRing: keyRing.ID(),
			Purpose: pulumi.String("ENCRYPT_DECRYPT"),
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		_, err = dataproc.NewMetastoreService(ctx, "default", &dataproc.MetastoreServiceArgs{
			ServiceId: pulumi.String("example-service"),
			Location:  pulumi.String("us-central1"),
			EncryptionConfig: &dataproc.MetastoreServiceEncryptionConfigArgs{
				KmsKey: cryptoKey.ID(),
			},
			HiveMetastoreConfig: &dataproc.MetastoreServiceHiveMetastoreConfigArgs{
				Version: pulumi.String("3.1.2"),
			},
		})
		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.gcp.kms.KeyRing;
import com.pulumi.gcp.kms.KeyRingArgs;
import com.pulumi.gcp.kms.CryptoKey;
import com.pulumi.gcp.kms.CryptoKeyArgs;
import com.pulumi.gcp.dataproc.MetastoreService;
import com.pulumi.gcp.dataproc.MetastoreServiceArgs;
import com.pulumi.gcp.dataproc.inputs.MetastoreServiceEncryptionConfigArgs;
import com.pulumi.gcp.dataproc.inputs.MetastoreServiceHiveMetastoreConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
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 keyRing = new KeyRing("keyRing", KeyRingArgs.builder()        
            .location("us-central1")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

        var cryptoKey = new CryptoKey("cryptoKey", CryptoKeyArgs.builder()        
            .keyRing(keyRing.id())
            .purpose("ENCRYPT_DECRYPT")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

        var default_ = new MetastoreService("default", MetastoreServiceArgs.builder()        
            .serviceId("example-service")
            .location("us-central1")
            .encryptionConfig(MetastoreServiceEncryptionConfigArgs.builder()
                .kmsKey(cryptoKey.id())
                .build())
            .hiveMetastoreConfig(MetastoreServiceHiveMetastoreConfigArgs.builder()
                .version("3.1.2")
                .build())
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

key_ring = gcp.kms.KeyRing("keyRing", location="us-central1",
opts=pulumi.ResourceOptions(provider=google_beta))
crypto_key = gcp.kms.CryptoKey("cryptoKey",
    key_ring=key_ring.id,
    purpose="ENCRYPT_DECRYPT",
    opts=pulumi.ResourceOptions(provider=google_beta))
default = gcp.dataproc.MetastoreService("default",
    service_id="example-service",
    location="us-central1",
    encryption_config=gcp.dataproc.MetastoreServiceEncryptionConfigArgs(
        kms_key=crypto_key.id,
    ),
    hive_metastore_config=gcp.dataproc.MetastoreServiceHiveMetastoreConfigArgs(
        version="3.1.2",
    ))

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

const keyRing = new gcp.kms.KeyRing("keyRing", {location: "us-central1"}, {
    provider: google_beta,
});
const cryptoKey = new gcp.kms.CryptoKey("cryptoKey", {
    keyRing: keyRing.id,
    purpose: "ENCRYPT_DECRYPT",
}, {
    provider: google_beta,
});
const _default = new gcp.dataproc.MetastoreService("default", {
    serviceId: "example-service",
    location: "us-central1",
    encryptionConfig: {
        kmsKey: cryptoKey.id,
    },
    hiveMetastoreConfig: {
        version: "3.1.2",
    },
});

resources:
  default:
    type: gcp:dataproc:MetastoreService
    properties:
      serviceId: example-service
      location: us-central1
      encryptionConfig:
        kmsKey: ${cryptoKey.id}
      hiveMetastoreConfig:
        version: 3.1.2
  cryptoKey:
    type: gcp:kms:CryptoKey
    properties:
      keyRing: ${keyRing.id}
      purpose: ENCRYPT_DECRYPT
    options:
      provider: ${["google-beta"]}
  keyRing:
    type: gcp:kms:KeyRing
    properties:
      location: us-central1
    options:
      provider: ${["google-beta"]}

Dataproc Metastore Service Private Service Connect

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

return await Deployment.RunAsync(() => 
{
    var net = new Gcp.Compute.Network("net", new()
    {
        AutoCreateSubnetworks = false,
    });

    var subnet = new Gcp.Compute.Subnetwork("subnet", new()
    {
        Region = "us-central1",
        Network = net.Id,
        IpCidrRange = "10.0.0.0/22",
        PrivateIpGoogleAccess = true,
    });

    var @default = new Gcp.Dataproc.MetastoreService("default", new()
    {
        ServiceId = "metastore-srv",
        Location = "us-central1",
        HiveMetastoreConfig = new Gcp.Dataproc.Inputs.MetastoreServiceHiveMetastoreConfigArgs
        {
            Version = "3.1.2",
        },
        NetworkConfig = new Gcp.Dataproc.Inputs.MetastoreServiceNetworkConfigArgs
        {
            Consumers = new[]
            {
                new Gcp.Dataproc.Inputs.MetastoreServiceNetworkConfigConsumerArgs
                {
                    Subnetwork = subnet.Id,
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/dataproc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		net, err := compute.NewNetwork(ctx, "net", &compute.NetworkArgs{
			AutoCreateSubnetworks: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		subnet, err := compute.NewSubnetwork(ctx, "subnet", &compute.SubnetworkArgs{
			Region:                pulumi.String("us-central1"),
			Network:               net.ID(),
			IpCidrRange:           pulumi.String("10.0.0.0/22"),
			PrivateIpGoogleAccess: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = dataproc.NewMetastoreService(ctx, "default", &dataproc.MetastoreServiceArgs{
			ServiceId: pulumi.String("metastore-srv"),
			Location:  pulumi.String("us-central1"),
			HiveMetastoreConfig: &dataproc.MetastoreServiceHiveMetastoreConfigArgs{
				Version: pulumi.String("3.1.2"),
			},
			NetworkConfig: &dataproc.MetastoreServiceNetworkConfigArgs{
				Consumers: dataproc.MetastoreServiceNetworkConfigConsumerArray{
					&dataproc.MetastoreServiceNetworkConfigConsumerArgs{
						Subnetwork: subnet.ID(),
					},
				},
			},
		})
		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.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.Subnetwork;
import com.pulumi.gcp.compute.SubnetworkArgs;
import com.pulumi.gcp.dataproc.MetastoreService;
import com.pulumi.gcp.dataproc.MetastoreServiceArgs;
import com.pulumi.gcp.dataproc.inputs.MetastoreServiceHiveMetastoreConfigArgs;
import com.pulumi.gcp.dataproc.inputs.MetastoreServiceNetworkConfigArgs;
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 net = new Network("net", NetworkArgs.builder()        
            .autoCreateSubnetworks(false)
            .build());

        var subnet = new Subnetwork("subnet", SubnetworkArgs.builder()        
            .region("us-central1")
            .network(net.id())
            .ipCidrRange("10.0.0.0/22")
            .privateIpGoogleAccess(true)
            .build());

        var default_ = new MetastoreService("default", MetastoreServiceArgs.builder()        
            .serviceId("metastore-srv")
            .location("us-central1")
            .hiveMetastoreConfig(MetastoreServiceHiveMetastoreConfigArgs.builder()
                .version("3.1.2")
                .build())
            .networkConfig(MetastoreServiceNetworkConfigArgs.builder()
                .consumers(MetastoreServiceNetworkConfigConsumerArgs.builder()
                    .subnetwork(subnet.id())
                    .build())
                .build())
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

net = gcp.compute.Network("net", auto_create_subnetworks=False)
subnet = gcp.compute.Subnetwork("subnet",
    region="us-central1",
    network=net.id,
    ip_cidr_range="10.0.0.0/22",
    private_ip_google_access=True)
default = gcp.dataproc.MetastoreService("default",
    service_id="metastore-srv",
    location="us-central1",
    hive_metastore_config=gcp.dataproc.MetastoreServiceHiveMetastoreConfigArgs(
        version="3.1.2",
    ),
    network_config=gcp.dataproc.MetastoreServiceNetworkConfigArgs(
        consumers=[gcp.dataproc.MetastoreServiceNetworkConfigConsumerArgs(
            subnetwork=subnet.id,
        )],
    ))

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

const net = new gcp.compute.Network("net", {autoCreateSubnetworks: false});
const subnet = new gcp.compute.Subnetwork("subnet", {
    region: "us-central1",
    network: net.id,
    ipCidrRange: "10.0.0.0/22",
    privateIpGoogleAccess: true,
});
const _default = new gcp.dataproc.MetastoreService("default", {
    serviceId: "metastore-srv",
    location: "us-central1",
    hiveMetastoreConfig: {
        version: "3.1.2",
    },
    networkConfig: {
        consumers: [{
            subnetwork: subnet.id,
        }],
    },
});

resources:
  net:
    type: gcp:compute:Network
    properties:
      autoCreateSubnetworks: false
  subnet:
    type: gcp:compute:Subnetwork
    properties:
      region: us-central1
      network: ${net.id}
      ipCidrRange: 10.0.0.0/22
      privateIpGoogleAccess: true
  default:
    type: gcp:dataproc:MetastoreService
    properties:
      serviceId: metastore-srv
      location: us-central1
      hiveMetastoreConfig:
        version: 3.1.2
      networkConfig:
        consumers:
          - subnetwork: ${subnet.id}

Create MetastoreService Resource

new MetastoreService(name: string, args: MetastoreServiceArgs, opts?: CustomResourceOptions);
@overload
def MetastoreService(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     database_type: Optional[str] = None,
                     encryption_config: Optional[MetastoreServiceEncryptionConfigArgs] = None,
                     hive_metastore_config: Optional[MetastoreServiceHiveMetastoreConfigArgs] = None,
                     labels: Optional[Mapping[str, str]] = None,
                     location: Optional[str] = None,
                     maintenance_window: Optional[MetastoreServiceMaintenanceWindowArgs] = None,
                     metadata_integration: Optional[MetastoreServiceMetadataIntegrationArgs] = None,
                     network: Optional[str] = None,
                     network_config: Optional[MetastoreServiceNetworkConfigArgs] = None,
                     port: Optional[int] = None,
                     project: Optional[str] = None,
                     release_channel: Optional[str] = None,
                     service_id: Optional[str] = None,
                     telemetry_config: Optional[MetastoreServiceTelemetryConfigArgs] = None,
                     tier: Optional[str] = None)
@overload
def MetastoreService(resource_name: str,
                     args: MetastoreServiceArgs,
                     opts: Optional[ResourceOptions] = None)
func NewMetastoreService(ctx *Context, name string, args MetastoreServiceArgs, opts ...ResourceOption) (*MetastoreService, error)
public MetastoreService(string name, MetastoreServiceArgs args, CustomResourceOptions? opts = null)
public MetastoreService(String name, MetastoreServiceArgs args)
public MetastoreService(String name, MetastoreServiceArgs args, CustomResourceOptions options)

type: gcp:dataproc:MetastoreService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MetastoreServiceArgs
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 MetastoreServiceArgs
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 MetastoreServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MetastoreServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args MetastoreServiceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ServiceId string

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

DatabaseType string

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

EncryptionConfig MetastoreServiceEncryptionConfigArgs

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

HiveMetastoreConfig MetastoreServiceHiveMetastoreConfigArgs

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

Labels Dictionary<string, string>

User-defined labels for the metastore service.

Location string

The location where the metastore service should reside. The default value is global.

MaintenanceWindow MetastoreServiceMaintenanceWindowArgs

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

MetadataIntegration MetastoreServiceMetadataIntegrationArgs

The setting that defines how metastore metadata should be integrated with external services and systems.

Network string

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

NetworkConfig MetastoreServiceNetworkConfigArgs

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

Port int

The TCP port at which the metastore service is reached. Default: 9083.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ReleaseChannel string

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

TelemetryConfig MetastoreServiceTelemetryConfigArgs

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

Tier string

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

ServiceId string

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

DatabaseType string

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

EncryptionConfig MetastoreServiceEncryptionConfigArgs

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

HiveMetastoreConfig MetastoreServiceHiveMetastoreConfigArgs

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

Labels map[string]string

User-defined labels for the metastore service.

Location string

The location where the metastore service should reside. The default value is global.

MaintenanceWindow MetastoreServiceMaintenanceWindowArgs

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

MetadataIntegration MetastoreServiceMetadataIntegrationArgs

The setting that defines how metastore metadata should be integrated with external services and systems.

Network string

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

NetworkConfig MetastoreServiceNetworkConfigArgs

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

Port int

The TCP port at which the metastore service is reached. Default: 9083.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ReleaseChannel string

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

TelemetryConfig MetastoreServiceTelemetryConfigArgs

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

Tier string

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

serviceId String

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

databaseType String

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

encryptionConfig MetastoreServiceEncryptionConfigArgs

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

hiveMetastoreConfig MetastoreServiceHiveMetastoreConfigArgs

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

labels Map<String,String>

User-defined labels for the metastore service.

location String

The location where the metastore service should reside. The default value is global.

maintenanceWindow MetastoreServiceMaintenanceWindowArgs

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

metadataIntegration MetastoreServiceMetadataIntegrationArgs

The setting that defines how metastore metadata should be integrated with external services and systems.

network String

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

networkConfig MetastoreServiceNetworkConfigArgs

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

port Integer

The TCP port at which the metastore service is reached. Default: 9083.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

releaseChannel String

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

telemetryConfig MetastoreServiceTelemetryConfigArgs

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

tier String

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

serviceId string

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

databaseType string

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

encryptionConfig MetastoreServiceEncryptionConfigArgs

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

hiveMetastoreConfig MetastoreServiceHiveMetastoreConfigArgs

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

labels {[key: string]: string}

User-defined labels for the metastore service.

location string

The location where the metastore service should reside. The default value is global.

maintenanceWindow MetastoreServiceMaintenanceWindowArgs

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

metadataIntegration MetastoreServiceMetadataIntegrationArgs

The setting that defines how metastore metadata should be integrated with external services and systems.

network string

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

networkConfig MetastoreServiceNetworkConfigArgs

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

port number

The TCP port at which the metastore service is reached. Default: 9083.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

releaseChannel string

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

telemetryConfig MetastoreServiceTelemetryConfigArgs

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

tier string

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

service_id str

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

database_type str

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

encryption_config MetastoreServiceEncryptionConfigArgs

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

hive_metastore_config MetastoreServiceHiveMetastoreConfigArgs

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

labels Mapping[str, str]

User-defined labels for the metastore service.

location str

The location where the metastore service should reside. The default value is global.

maintenance_window MetastoreServiceMaintenanceWindowArgs

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

metadata_integration MetastoreServiceMetadataIntegrationArgs

The setting that defines how metastore metadata should be integrated with external services and systems.

network str

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

network_config MetastoreServiceNetworkConfigArgs

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

port int

The TCP port at which the metastore service is reached. Default: 9083.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

release_channel str

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

telemetry_config MetastoreServiceTelemetryConfigArgs

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

tier str

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

serviceId String

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

databaseType String

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

encryptionConfig Property Map

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

hiveMetastoreConfig Property Map

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

labels Map<String>

User-defined labels for the metastore service.

location String

The location where the metastore service should reside. The default value is global.

maintenanceWindow Property Map

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

metadataIntegration Property Map

The setting that defines how metastore metadata should be integrated with external services and systems.

network String

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

networkConfig Property Map

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

port Number

The TCP port at which the metastore service is reached. Default: 9083.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

releaseChannel String

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

telemetryConfig Property Map

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

tier String

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

Outputs

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

ArtifactGcsUri string

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

EndpointUri string

(Output) The URI of the endpoint used to access the metastore service.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The relative resource name of the metastore service.

State string

The current state of the metastore service.

StateMessage string

Additional information about the current state of the metastore service, if available.

Uid string

The globally unique resource identifier of the metastore service.

ArtifactGcsUri string

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

EndpointUri string

(Output) The URI of the endpoint used to access the metastore service.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The relative resource name of the metastore service.

State string

The current state of the metastore service.

StateMessage string

Additional information about the current state of the metastore service, if available.

Uid string

The globally unique resource identifier of the metastore service.

artifactGcsUri String

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

endpointUri String

(Output) The URI of the endpoint used to access the metastore service.

id String

The provider-assigned unique ID for this managed resource.

name String

The relative resource name of the metastore service.

state String

The current state of the metastore service.

stateMessage String

Additional information about the current state of the metastore service, if available.

uid String

The globally unique resource identifier of the metastore service.

artifactGcsUri string

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

endpointUri string

(Output) The URI of the endpoint used to access the metastore service.

id string

The provider-assigned unique ID for this managed resource.

name string

The relative resource name of the metastore service.

state string

The current state of the metastore service.

stateMessage string

Additional information about the current state of the metastore service, if available.

uid string

The globally unique resource identifier of the metastore service.

artifact_gcs_uri str

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

endpoint_uri str

(Output) The URI of the endpoint used to access the metastore service.

id str

The provider-assigned unique ID for this managed resource.

name str

The relative resource name of the metastore service.

state str

The current state of the metastore service.

state_message str

Additional information about the current state of the metastore service, if available.

uid str

The globally unique resource identifier of the metastore service.

artifactGcsUri String

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

endpointUri String

(Output) The URI of the endpoint used to access the metastore service.

id String

The provider-assigned unique ID for this managed resource.

name String

The relative resource name of the metastore service.

state String

The current state of the metastore service.

stateMessage String

Additional information about the current state of the metastore service, if available.

uid String

The globally unique resource identifier of the metastore service.

Look up Existing MetastoreService Resource

Get an existing MetastoreService 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?: MetastoreServiceState, opts?: CustomResourceOptions): MetastoreService
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        artifact_gcs_uri: Optional[str] = None,
        database_type: Optional[str] = None,
        encryption_config: Optional[MetastoreServiceEncryptionConfigArgs] = None,
        endpoint_uri: Optional[str] = None,
        hive_metastore_config: Optional[MetastoreServiceHiveMetastoreConfigArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        maintenance_window: Optional[MetastoreServiceMaintenanceWindowArgs] = None,
        metadata_integration: Optional[MetastoreServiceMetadataIntegrationArgs] = None,
        name: Optional[str] = None,
        network: Optional[str] = None,
        network_config: Optional[MetastoreServiceNetworkConfigArgs] = None,
        port: Optional[int] = None,
        project: Optional[str] = None,
        release_channel: Optional[str] = None,
        service_id: Optional[str] = None,
        state: Optional[str] = None,
        state_message: Optional[str] = None,
        telemetry_config: Optional[MetastoreServiceTelemetryConfigArgs] = None,
        tier: Optional[str] = None,
        uid: Optional[str] = None) -> MetastoreService
func GetMetastoreService(ctx *Context, name string, id IDInput, state *MetastoreServiceState, opts ...ResourceOption) (*MetastoreService, error)
public static MetastoreService Get(string name, Input<string> id, MetastoreServiceState? state, CustomResourceOptions? opts = null)
public static MetastoreService get(String name, Output<String> id, MetastoreServiceState 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:
ArtifactGcsUri string

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

DatabaseType string

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

EncryptionConfig MetastoreServiceEncryptionConfigArgs

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

EndpointUri string

(Output) The URI of the endpoint used to access the metastore service.

HiveMetastoreConfig MetastoreServiceHiveMetastoreConfigArgs

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

Labels Dictionary<string, string>

User-defined labels for the metastore service.

Location string

The location where the metastore service should reside. The default value is global.

MaintenanceWindow MetastoreServiceMaintenanceWindowArgs

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

MetadataIntegration MetastoreServiceMetadataIntegrationArgs

The setting that defines how metastore metadata should be integrated with external services and systems.

Name string

The relative resource name of the metastore service.

Network string

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

NetworkConfig MetastoreServiceNetworkConfigArgs

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

Port int

The TCP port at which the metastore service is reached. Default: 9083.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ReleaseChannel string

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

ServiceId string

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

State string

The current state of the metastore service.

StateMessage string

Additional information about the current state of the metastore service, if available.

TelemetryConfig MetastoreServiceTelemetryConfigArgs

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

Tier string

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

Uid string

The globally unique resource identifier of the metastore service.

ArtifactGcsUri string

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

DatabaseType string

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

EncryptionConfig MetastoreServiceEncryptionConfigArgs

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

EndpointUri string

(Output) The URI of the endpoint used to access the metastore service.

HiveMetastoreConfig MetastoreServiceHiveMetastoreConfigArgs

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

Labels map[string]string

User-defined labels for the metastore service.

Location string

The location where the metastore service should reside. The default value is global.

MaintenanceWindow MetastoreServiceMaintenanceWindowArgs

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

MetadataIntegration MetastoreServiceMetadataIntegrationArgs

The setting that defines how metastore metadata should be integrated with external services and systems.

Name string

The relative resource name of the metastore service.

Network string

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

NetworkConfig MetastoreServiceNetworkConfigArgs

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

Port int

The TCP port at which the metastore service is reached. Default: 9083.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ReleaseChannel string

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

ServiceId string

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

State string

The current state of the metastore service.

StateMessage string

Additional information about the current state of the metastore service, if available.

TelemetryConfig MetastoreServiceTelemetryConfigArgs

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

Tier string

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

Uid string

The globally unique resource identifier of the metastore service.

artifactGcsUri String

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

databaseType String

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

encryptionConfig MetastoreServiceEncryptionConfigArgs

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

endpointUri String

(Output) The URI of the endpoint used to access the metastore service.

hiveMetastoreConfig MetastoreServiceHiveMetastoreConfigArgs

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

labels Map<String,String>

User-defined labels for the metastore service.

location String

The location where the metastore service should reside. The default value is global.

maintenanceWindow MetastoreServiceMaintenanceWindowArgs

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

metadataIntegration MetastoreServiceMetadataIntegrationArgs

The setting that defines how metastore metadata should be integrated with external services and systems.

name String

The relative resource name of the metastore service.

network String

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

networkConfig MetastoreServiceNetworkConfigArgs

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

port Integer

The TCP port at which the metastore service is reached. Default: 9083.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

releaseChannel String

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

serviceId String

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

state String

The current state of the metastore service.

stateMessage String

Additional information about the current state of the metastore service, if available.

telemetryConfig MetastoreServiceTelemetryConfigArgs

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

tier String

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

uid String

The globally unique resource identifier of the metastore service.

artifactGcsUri string

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

databaseType string

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

encryptionConfig MetastoreServiceEncryptionConfigArgs

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

endpointUri string

(Output) The URI of the endpoint used to access the metastore service.

hiveMetastoreConfig MetastoreServiceHiveMetastoreConfigArgs

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

labels {[key: string]: string}

User-defined labels for the metastore service.

location string

The location where the metastore service should reside. The default value is global.

maintenanceWindow MetastoreServiceMaintenanceWindowArgs

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

metadataIntegration MetastoreServiceMetadataIntegrationArgs

The setting that defines how metastore metadata should be integrated with external services and systems.

name string

The relative resource name of the metastore service.

network string

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

networkConfig MetastoreServiceNetworkConfigArgs

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

port number

The TCP port at which the metastore service is reached. Default: 9083.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

releaseChannel string

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

serviceId string

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

state string

The current state of the metastore service.

stateMessage string

Additional information about the current state of the metastore service, if available.

telemetryConfig MetastoreServiceTelemetryConfigArgs

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

tier string

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

uid string

The globally unique resource identifier of the metastore service.

artifact_gcs_uri str

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

database_type str

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

encryption_config MetastoreServiceEncryptionConfigArgs

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

endpoint_uri str

(Output) The URI of the endpoint used to access the metastore service.

hive_metastore_config MetastoreServiceHiveMetastoreConfigArgs

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

labels Mapping[str, str]

User-defined labels for the metastore service.

location str

The location where the metastore service should reside. The default value is global.

maintenance_window MetastoreServiceMaintenanceWindowArgs

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

metadata_integration MetastoreServiceMetadataIntegrationArgs

The setting that defines how metastore metadata should be integrated with external services and systems.

name str

The relative resource name of the metastore service.

network str

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

network_config MetastoreServiceNetworkConfigArgs

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

port int

The TCP port at which the metastore service is reached. Default: 9083.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

release_channel str

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

service_id str

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

state str

The current state of the metastore service.

state_message str

Additional information about the current state of the metastore service, if available.

telemetry_config MetastoreServiceTelemetryConfigArgs

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

tier str

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

uid str

The globally unique resource identifier of the metastore service.

artifactGcsUri String

A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

databaseType String

The database type that the Metastore service stores its data. Default value is MYSQL. Possible values are: MYSQL, SPANNER.

encryptionConfig Property Map

Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Structure is documented below.

endpointUri String

(Output) The URI of the endpoint used to access the metastore service.

hiveMetastoreConfig Property Map

Configuration information specific to running Hive metastore software as the metastore service. Structure is documented below.

labels Map<String>

User-defined labels for the metastore service.

location String

The location where the metastore service should reside. The default value is global.

maintenanceWindow Property Map

The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. Structure is documented below.

metadataIntegration Property Map

The setting that defines how metastore metadata should be integrated with external services and systems.

name String

The relative resource name of the metastore service.

network String

The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

networkConfig Property Map

The configuration specifying the network settings for the Dataproc Metastore service. Structure is documented below.

port Number

The TCP port at which the metastore service is reached. Default: 9083.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

releaseChannel String

The release channel of the service. If unspecified, defaults to STABLE. Default value is STABLE. Possible values are: CANARY, STABLE.

serviceId String

The ID of the metastore service. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

state String

The current state of the metastore service.

stateMessage String

Additional information about the current state of the metastore service, if available.

telemetryConfig Property Map

The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. Structure is documented below.

tier String

The tier of the service. Possible values are: DEVELOPER, ENTERPRISE.

uid String

The globally unique resource identifier of the metastore service.

Supporting Types

MetastoreServiceEncryptionConfig

KmsKey string

The fully qualified customer provided Cloud KMS key name to use for customer data encryption. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)

KmsKey string

The fully qualified customer provided Cloud KMS key name to use for customer data encryption. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)

kmsKey String

The fully qualified customer provided Cloud KMS key name to use for customer data encryption. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)

kmsKey string

The fully qualified customer provided Cloud KMS key name to use for customer data encryption. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)

kms_key str

The fully qualified customer provided Cloud KMS key name to use for customer data encryption. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)

kmsKey String

The fully qualified customer provided Cloud KMS key name to use for customer data encryption. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)

MetastoreServiceHiveMetastoreConfig

Version string

The Hive metastore schema version.

AuxiliaryVersions List<MetastoreServiceHiveMetastoreConfigAuxiliaryVersion>
ConfigOverrides Dictionary<string, string>

A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden)

EndpointProtocol string
KerberosConfig MetastoreServiceHiveMetastoreConfigKerberosConfig

Information used to configure the Hive metastore service as a service principal in a Kerberos realm. Structure is documented below.

Version string

The Hive metastore schema version.

AuxiliaryVersions []MetastoreServiceHiveMetastoreConfigAuxiliaryVersion
ConfigOverrides map[string]string

A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden)

EndpointProtocol string
KerberosConfig MetastoreServiceHiveMetastoreConfigKerberosConfig

Information used to configure the Hive metastore service as a service principal in a Kerberos realm. Structure is documented below.

version String

The Hive metastore schema version.

auxiliaryVersions List<MetastoreServiceHiveMetastoreConfigAuxiliaryVersion>
configOverrides Map<String,String>

A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden)

endpointProtocol String
kerberosConfig MetastoreServiceHiveMetastoreConfigKerberosConfig

Information used to configure the Hive metastore service as a service principal in a Kerberos realm. Structure is documented below.

version string

The Hive metastore schema version.

auxiliaryVersions MetastoreServiceHiveMetastoreConfigAuxiliaryVersion[]
configOverrides {[key: string]: string}

A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden)

endpointProtocol string
kerberosConfig MetastoreServiceHiveMetastoreConfigKerberosConfig

Information used to configure the Hive metastore service as a service principal in a Kerberos realm. Structure is documented below.

version str

The Hive metastore schema version.

auxiliary_versions Sequence[MetastoreServiceHiveMetastoreConfigAuxiliaryVersion]
config_overrides Mapping[str, str]

A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden)

endpoint_protocol str
kerberos_config MetastoreServiceHiveMetastoreConfigKerberosConfig

Information used to configure the Hive metastore service as a service principal in a Kerberos realm. Structure is documented below.

version String

The Hive metastore schema version.

auxiliaryVersions List<Property Map>
configOverrides Map<String>

A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden)

endpointProtocol String
kerberosConfig Property Map

Information used to configure the Hive metastore service as a service principal in a Kerberos realm. Structure is documented below.

MetastoreServiceHiveMetastoreConfigAuxiliaryVersion

Key string

The identifier for this object. Format specified above.

Version string

The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.

ConfigOverrides Dictionary<string, string>

A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.

Key string

The identifier for this object. Format specified above.

Version string

The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.

ConfigOverrides map[string]string

A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.

key String

The identifier for this object. Format specified above.

version String

The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.

configOverrides Map<String,String>

A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.

key string

The identifier for this object. Format specified above.

version string

The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.

configOverrides {[key: string]: string}

A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.

key str

The identifier for this object. Format specified above.

version str

The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.

config_overrides Mapping[str, str]

A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.

key String

The identifier for this object. Format specified above.

version String

The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.

configOverrides Map<String>

A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.

MetastoreServiceHiveMetastoreConfigKerberosConfig

Keytab MetastoreServiceHiveMetastoreConfigKerberosConfigKeytab

A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC). Structure is documented below.

Krb5ConfigGcsUri string

A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.

Principal string

A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form "primary/instance@REALM", but there is no exact format.

Keytab MetastoreServiceHiveMetastoreConfigKerberosConfigKeytab

A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC). Structure is documented below.

Krb5ConfigGcsUri string

A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.

Principal string

A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form "primary/instance@REALM", but there is no exact format.

keytab MetastoreServiceHiveMetastoreConfigKerberosConfigKeytab

A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC). Structure is documented below.

krb5ConfigGcsUri String

A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.

principal String

A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form "primary/instance@REALM", but there is no exact format.

keytab MetastoreServiceHiveMetastoreConfigKerberosConfigKeytab

A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC). Structure is documented below.

krb5ConfigGcsUri string

A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.

principal string

A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form "primary/instance@REALM", but there is no exact format.

keytab MetastoreServiceHiveMetastoreConfigKerberosConfigKeytab

A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC). Structure is documented below.

krb5_config_gcs_uri str

A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.

principal str

A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form "primary/instance@REALM", but there is no exact format.

keytab Property Map

A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC). Structure is documented below.

krb5ConfigGcsUri String

A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.

principal String

A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form "primary/instance@REALM", but there is no exact format.

MetastoreServiceHiveMetastoreConfigKerberosConfigKeytab

CloudSecret string

The relative resource name of a Secret Manager secret version, in the following form: "projects/{projectNumber}/secrets/{secret_id}/versions/{version_id}".

CloudSecret string

The relative resource name of a Secret Manager secret version, in the following form: "projects/{projectNumber}/secrets/{secret_id}/versions/{version_id}".

cloudSecret String

The relative resource name of a Secret Manager secret version, in the following form: "projects/{projectNumber}/secrets/{secret_id}/versions/{version_id}".

cloudSecret string

The relative resource name of a Secret Manager secret version, in the following form: "projects/{projectNumber}/secrets/{secret_id}/versions/{version_id}".

cloud_secret str

The relative resource name of a Secret Manager secret version, in the following form: "projects/{projectNumber}/secrets/{secret_id}/versions/{version_id}".

cloudSecret String

The relative resource name of a Secret Manager secret version, in the following form: "projects/{projectNumber}/secrets/{secret_id}/versions/{version_id}".

MetastoreServiceMaintenanceWindow

DayOfWeek string

The day of week, when the window starts. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

HourOfDay int

The hour of day (0-23) when the window starts.

DayOfWeek string

The day of week, when the window starts. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

HourOfDay int

The hour of day (0-23) when the window starts.

dayOfWeek String

The day of week, when the window starts. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

hourOfDay Integer

The hour of day (0-23) when the window starts.

dayOfWeek string

The day of week, when the window starts. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

hourOfDay number

The hour of day (0-23) when the window starts.

day_of_week str

The day of week, when the window starts. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

hour_of_day int

The hour of day (0-23) when the window starts.

dayOfWeek String

The day of week, when the window starts. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

hourOfDay Number

The hour of day (0-23) when the window starts.

MetastoreServiceMetadataIntegration

DataCatalogConfig MetastoreServiceMetadataIntegrationDataCatalogConfig

The integration config for the Data Catalog service. Structure is documented below.

DataCatalogConfig MetastoreServiceMetadataIntegrationDataCatalogConfig

The integration config for the Data Catalog service. Structure is documented below.

dataCatalogConfig MetastoreServiceMetadataIntegrationDataCatalogConfig

The integration config for the Data Catalog service. Structure is documented below.

dataCatalogConfig MetastoreServiceMetadataIntegrationDataCatalogConfig

The integration config for the Data Catalog service. Structure is documented below.

data_catalog_config MetastoreServiceMetadataIntegrationDataCatalogConfig

The integration config for the Data Catalog service. Structure is documented below.

dataCatalogConfig Property Map

The integration config for the Data Catalog service. Structure is documented below.

MetastoreServiceMetadataIntegrationDataCatalogConfig

Enabled bool

Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.

Enabled bool

Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.

enabled Boolean

Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.

enabled boolean

Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.

enabled bool

Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.

enabled Boolean

Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.

MetastoreServiceNetworkConfig

Consumers List<MetastoreServiceNetworkConfigConsumer>

The consumer-side network configuration for the Dataproc Metastore instance. Structure is documented below.

Consumers []MetastoreServiceNetworkConfigConsumer

The consumer-side network configuration for the Dataproc Metastore instance. Structure is documented below.

consumers List<MetastoreServiceNetworkConfigConsumer>

The consumer-side network configuration for the Dataproc Metastore instance. Structure is documented below.

consumers MetastoreServiceNetworkConfigConsumer[]

The consumer-side network configuration for the Dataproc Metastore instance. Structure is documented below.

consumers Sequence[MetastoreServiceNetworkConfigConsumer]

The consumer-side network configuration for the Dataproc Metastore instance. Structure is documented below.

consumers List<Property Map>

The consumer-side network configuration for the Dataproc Metastore instance. Structure is documented below.

MetastoreServiceNetworkConfigConsumer

Subnetwork string

The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form: `projects/{projectNumber}/regions/{region_id}/subnetworks/{subnetwork_id}

EndpointUri string

(Output) The URI of the endpoint used to access the metastore service.

Subnetwork string

The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form: `projects/{projectNumber}/regions/{region_id}/subnetworks/{subnetwork_id}

EndpointUri string

(Output) The URI of the endpoint used to access the metastore service.

subnetwork String

The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form: `projects/{projectNumber}/regions/{region_id}/subnetworks/{subnetwork_id}

endpointUri String

(Output) The URI of the endpoint used to access the metastore service.

subnetwork string

The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form: `projects/{projectNumber}/regions/{region_id}/subnetworks/{subnetwork_id}

endpointUri string

(Output) The URI of the endpoint used to access the metastore service.

subnetwork str

The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form: `projects/{projectNumber}/regions/{region_id}/subnetworks/{subnetwork_id}

endpoint_uri str

(Output) The URI of the endpoint used to access the metastore service.

subnetwork String

The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form: `projects/{projectNumber}/regions/{region_id}/subnetworks/{subnetwork_id}

endpointUri String

(Output) The URI of the endpoint used to access the metastore service.

MetastoreServiceTelemetryConfig

LogFormat string

The output format of the Dataproc Metastore service's logs. Default value is JSON. Possible values are: LEGACY, JSON.

LogFormat string

The output format of the Dataproc Metastore service's logs. Default value is JSON. Possible values are: LEGACY, JSON.

logFormat String

The output format of the Dataproc Metastore service's logs. Default value is JSON. Possible values are: LEGACY, JSON.

logFormat string

The output format of the Dataproc Metastore service's logs. Default value is JSON. Possible values are: LEGACY, JSON.

log_format str

The output format of the Dataproc Metastore service's logs. Default value is JSON. Possible values are: LEGACY, JSON.

logFormat String

The output format of the Dataproc Metastore service's logs. Default value is JSON. Possible values are: LEGACY, JSON.

Import

Service can be imported using any of these accepted formats

 $ pulumi import gcp:dataproc/metastoreService:MetastoreService default projects/{{project}}/locations/{{location}}/services/{{service_id}}

 $ pulumi import gcp:dataproc/metastoreService:MetastoreService default {{project}}/{{location}}/{{service_id}}

 $ pulumi import gcp:dataproc/metastoreService:MetastoreService default {{location}}/{{service_id}}

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.