Google Cloud (GCP) Classic

Pulumi Official
Package maintained by Pulumi
v6.28.0 published on Friday, Jun 17, 2022 by Pulumi

MetastoreService

A managed metastore service that serves metadata queries.

Example Usage

Dataproc Metastore Service Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new Gcp.Dataproc.MetastoreService("default", new Gcp.Dataproc.MetastoreServiceArgs
        {
            ServiceId = "metastore-srv",
            Location = "us-central1",
            Port = 9080,
            Tier = "DEVELOPER",
            MaintenanceWindow = new Gcp.Dataproc.Inputs.MetastoreServiceMaintenanceWindowArgs
            {
                HourOfDay = 2,
                DayOfWeek = "SUNDAY",
            },
            HiveMetastoreConfig = new Gcp.Dataproc.Inputs.MetastoreServiceHiveMetastoreConfigArgs
            {
                Version = "2.3.6",
            },
        }, new CustomResourceOptions
        {
            Provider = google_beta,
        });
    }

}
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{
			ServiceId: pulumi.String("metastore-srv"),
			Location:  pulumi.String("us-central1"),
			Port:      pulumi.Int(9080),
			Tier:      pulumi.String("DEVELOPER"),
			MaintenanceWindow: &dataproc.MetastoreServiceMaintenanceWindowArgs{
				HourOfDay: pulumi.Int(2),
				DayOfWeek: pulumi.String("SUNDAY"),
			},
			HiveMetastoreConfig: &dataproc.MetastoreServiceHiveMetastoreConfigArgs{
				Version: pulumi.String("2.3.6"),
			},
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
import com.pulumi.resources.CustomResourceOptions;

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()        
            .serviceId("metastore-srv")
            .location("us-central1")
            .port(9080)
            .tier("DEVELOPER")
            .maintenanceWindow(MetastoreServiceMaintenanceWindowArgs.builder()
                .hourOfDay(2)
                .dayOfWeek("SUNDAY")
                .build())
            .hiveMetastoreConfig(MetastoreServiceHiveMetastoreConfigArgs.builder()
                .version("2.3.6")
                .build())
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

    }
}
import pulumi
import pulumi_gcp as gcp

default = gcp.dataproc.MetastoreService("default",
    service_id="metastore-srv",
    location="us-central1",
    port=9080,
    tier="DEVELOPER",
    maintenance_window=gcp.dataproc.MetastoreServiceMaintenanceWindowArgs(
        hour_of_day=2,
        day_of_week="SUNDAY",
    ),
    hive_metastore_config=gcp.dataproc.MetastoreServiceHiveMetastoreConfigArgs(
        version="2.3.6",
    ),
    opts=pulumi.ResourceOptions(provider=google_beta))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.dataproc.MetastoreService("default", {
    serviceId: "metastore-srv",
    location: "us-central1",
    port: 9080,
    tier: "DEVELOPER",
    maintenanceWindow: {
        hourOfDay: 2,
        dayOfWeek: "SUNDAY",
    },
    hiveMetastoreConfig: {
        version: "2.3.6",
    },
}, {
    provider: google_beta,
});
resources:
  default:
    type: gcp:dataproc:MetastoreService
    properties:
      serviceId: metastore-srv
      location: us-central1
      port: 9080
      tier: DEVELOPER
      maintenanceWindow:
        hourOfDay: 2
        dayOfWeek: SUNDAY
      hiveMetastoreConfig:
        version: 2.3.6
    options:
      provider: ${["google-beta"]}

Dataproc Metastore Service Cmek Example

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var keyRing = new Gcp.Kms.KeyRing("keyRing", new Gcp.Kms.KeyRingArgs
        {
            Location = "us-central1",
        }, new CustomResourceOptions
        {
            Provider = google_beta,
        });
        var cryptoKey = new Gcp.Kms.CryptoKey("cryptoKey", new Gcp.Kms.CryptoKeyArgs
        {
            KeyRing = keyRing.Id,
            Purpose = "ENCRYPT_DECRYPT",
        }, new CustomResourceOptions
        {
            Provider = google_beta,
        });
        var @default = new Gcp.Dataproc.MetastoreService("default", new Gcp.Dataproc.MetastoreServiceArgs
        {
            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",
            },
        }, new CustomResourceOptions
        {
            Provider = google_beta,
        });
    }

}
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"),
			},
		}, pulumi.Provider(google_beta))
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
import com.pulumi.resources.CustomResourceOptions;

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(), CustomResourceOptions.builder()
                .provider(google_beta)
                .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",
    ),
    opts=pulumi.ResourceOptions(provider=google_beta))
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",
    },
}, {
    provider: google_beta,
});
resources:
  default:
    type: gcp:dataproc:MetastoreService
    properties:
      serviceId: example-service
      location: us-central1
      encryptionConfig:
        kmsKey: ${cryptoKey.id}
      hiveMetastoreConfig:
        version: 3.1.2
    options:
      provider: ${["google-beta"]}
  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"]}

Create a MetastoreService Resource

new MetastoreService(name: string, args: MetastoreServiceArgs, opts?: CustomResourceOptions);
@overload
def MetastoreService(resource_name: str,
                     opts: Optional[ResourceOptions] = 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,
                     network: Optional[str] = None,
                     port: Optional[int] = None,
                     project: Optional[str] = None,
                     service_id: Optional[str] = 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.

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 autoscaling policy 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. Structure is documented below.

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}".

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.

Tier string

The tier of the service. Possible values are DEVELOPER and 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.

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 autoscaling policy 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. Structure is documented below.

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}".

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.

Tier string

The tier of the service. Possible values are DEVELOPER and 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.

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 autoscaling policy 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. Structure is documented below.

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}".

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.

tier String

The tier of the service. Possible values are DEVELOPER and 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.

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 autoscaling policy 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. Structure is documented below.

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}".

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.

tier string

The tier of the service. Possible values are DEVELOPER and 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.

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 autoscaling policy 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. Structure is documented below.

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}".

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.

tier str

The tier of the service. Possible values are DEVELOPER and 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.

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 autoscaling policy 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. Structure is documented below.

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}".

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.

tier String

The tier of the service. Possible values are DEVELOPER and 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

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.

ArtifactGcsUri string

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

EndpointUri string

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.

artifactGcsUri String

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

endpointUri String

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.

artifactGcsUri string

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

endpointUri string

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.

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

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.

artifactGcsUri String

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

endpointUri String

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.

Look up an 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,
        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,
        name: Optional[str] = None,
        network: Optional[str] = None,
        port: Optional[int] = None,
        project: Optional[str] = None,
        service_id: Optional[str] = None,
        state: Optional[str] = None,
        state_message: Optional[str] = None,
        tier: 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.

EncryptionConfig MetastoreServiceEncryptionConfigArgs

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

EndpointUri string

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 autoscaling policy 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. Structure is documented below.

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}".

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.

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.

Tier string

The tier of the service. Possible values are DEVELOPER and ENTERPRISE.

ArtifactGcsUri string

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

EncryptionConfig MetastoreServiceEncryptionConfigArgs

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

EndpointUri string

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 autoscaling policy 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. Structure is documented below.

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}".

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.

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.

Tier string

The tier of the service. Possible values are DEVELOPER and ENTERPRISE.

artifactGcsUri String

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

encryptionConfig MetastoreServiceEncryptionConfigArgs

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

endpointUri String

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 autoscaling policy 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. Structure is documented below.

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}".

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.

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.

tier String

The tier of the service. Possible values are DEVELOPER and ENTERPRISE.

artifactGcsUri string

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

encryptionConfig MetastoreServiceEncryptionConfigArgs

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

endpointUri string

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 autoscaling policy 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. Structure is documented below.

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}".

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.

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.

tier string

The tier of the service. Possible values are DEVELOPER and ENTERPRISE.

artifact_gcs_uri str

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

encryption_config MetastoreServiceEncryptionConfigArgs

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

endpoint_uri str

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 autoscaling policy 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. Structure is documented below.

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}".

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.

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.

tier str

The tier of the service. Possible values are DEVELOPER and ENTERPRISE.

artifactGcsUri String

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

encryptionConfig Property Map

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

endpointUri String

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 autoscaling policy 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. Structure is documented below.

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}".

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.

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.

tier String

The tier of the service. Possible values are DEVELOPER and ENTERPRISE.

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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

kerberosConfig Property Map

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

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, and 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, and 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, and 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, and 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, and 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, and SUNDAY.

hourOfDay Number

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

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
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes

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