Google Cloud v8.21.0, Mar 5 25

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

gcp.dataproc.getMetastoreService

Explore with Pulumi AI

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

Example Usage

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

const foo = gcp.dataproc.getMetastoreService({
    serviceId: "foo-bar",
    location: "global",
});

import pulumi
import pulumi_gcp as gcp

foo = gcp.dataproc.get_metastore_service(service_id="foo-bar",
    location="global")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataproc.LookupMetastoreService(ctx, &dataproc.LookupMetastoreServiceArgs{
			ServiceId: "foo-bar",
			Location:  "global",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Gcp.Dataproc.GetMetastoreService.Invoke(new()
    {
        ServiceId = "foo-bar",
        Location = "global",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataproc.DataprocFunctions;
import com.pulumi.gcp.dataproc.inputs.GetMetastoreServiceArgs;
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) {
        final var foo = DataprocFunctions.getMetastoreService(GetMetastoreServiceArgs.builder()
            .serviceId("foo-bar")
            .location("global")
            .build());

    }
}

variables:
  foo:
    fn::invoke:
      function: gcp:dataproc:getMetastoreService
      arguments:
        serviceId: foo-bar
        location: global

Using getMetastoreService

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMetastoreService(args: GetMetastoreServiceArgs, opts?: InvokeOptions): Promise<GetMetastoreServiceResult>
function getMetastoreServiceOutput(args: GetMetastoreServiceOutputArgs, opts?: InvokeOptions): Output<GetMetastoreServiceResult>

def get_metastore_service(location: Optional[str] = None,
                          project: Optional[str] = None,
                          service_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetMetastoreServiceResult
def get_metastore_service_output(location: Optional[pulumi.Input[str]] = None,
                          project: Optional[pulumi.Input[str]] = None,
                          service_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetMetastoreServiceResult]

func LookupMetastoreService(ctx *Context, args *LookupMetastoreServiceArgs, opts ...InvokeOption) (*LookupMetastoreServiceResult, error)
func LookupMetastoreServiceOutput(ctx *Context, args *LookupMetastoreServiceOutputArgs, opts ...InvokeOption) LookupMetastoreServiceResultOutput

> Note: This function is named LookupMetastoreService in the Go SDK.

public static class GetMetastoreService 
{
    public static Task<GetMetastoreServiceResult> InvokeAsync(GetMetastoreServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetMetastoreServiceResult> Invoke(GetMetastoreServiceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMetastoreServiceResult> getMetastoreService(GetMetastoreServiceArgs args, InvokeOptions options)
public static Output<GetMetastoreServiceResult> getMetastoreService(GetMetastoreServiceArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:dataproc/getMetastoreService:getMetastoreService
  arguments:
    # arguments dictionary

The following arguments are supported:

Location string: The location where the metastore service resides.
ServiceId string: The ID of the metastore service.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.

Location string: The location where the metastore service resides.
ServiceId string: The ID of the metastore service.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.

location String: The location where the metastore service resides.
serviceId String: The ID of the metastore service.
project String: The project in which the resource belongs. If it is not provided, the provider project is used.

location string: The location where the metastore service resides.
serviceId string: The ID of the metastore service.
project string: The project in which the resource belongs. If it is not provided, the provider project is used.

location str: The location where the metastore service resides.
service_id str: The ID of the metastore service.
project str: The project in which the resource belongs. If it is not provided, the provider project is used.

location String: The location where the metastore service resides.
serviceId String: The ID of the metastore service.
project String: The project in which the resource belongs. If it is not provided, the provider project is used.

getMetastoreService Result

The following output properties are available:

ArtifactGcsUri string
DatabaseType string
DeletionProtection bool
EffectiveLabels Dictionary<string, string>
EncryptionConfigs List<GetMetastoreServiceEncryptionConfig>
EndpointUri string
HiveMetastoreConfigs List<GetMetastoreServiceHiveMetastoreConfig>
Id string: The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>
Location string
MaintenanceWindows List<GetMetastoreServiceMaintenanceWindow>
MetadataIntegrations List<GetMetastoreServiceMetadataIntegration>
Name string
Network string
NetworkConfigs List<GetMetastoreServiceNetworkConfig>
Port int
PulumiLabels Dictionary<string, string>
ReleaseChannel string
ScalingConfigs List<GetMetastoreServiceScalingConfig>
ScheduledBackups List<GetMetastoreServiceScheduledBackup>
ServiceId string
State string
StateMessage string
TelemetryConfigs List<GetMetastoreServiceTelemetryConfig>
Tier string
Uid string
Project string

ArtifactGcsUri string
DatabaseType string
DeletionProtection bool
EffectiveLabels map[string]string
EncryptionConfigs []GetMetastoreServiceEncryptionConfig
EndpointUri string
HiveMetastoreConfigs []GetMetastoreServiceHiveMetastoreConfig
Id string: The provider-assigned unique ID for this managed resource.
Labels map[string]string
Location string
MaintenanceWindows []GetMetastoreServiceMaintenanceWindow
MetadataIntegrations []GetMetastoreServiceMetadataIntegration
Name string
Network string
NetworkConfigs []GetMetastoreServiceNetworkConfig
Port int
PulumiLabels map[string]string
ReleaseChannel string
ScalingConfigs []GetMetastoreServiceScalingConfig
ScheduledBackups []GetMetastoreServiceScheduledBackup
ServiceId string
State string
StateMessage string
TelemetryConfigs []GetMetastoreServiceTelemetryConfig
Tier string
Uid string
Project string

artifactGcsUri String
databaseType String
deletionProtection Boolean
effectiveLabels Map<String,String>
encryptionConfigs List<GetMetastoreServiceEncryptionConfig>
endpointUri String
hiveMetastoreConfigs List<GetMetastoreServiceHiveMetastoreConfig>
id String: The provider-assigned unique ID for this managed resource.
labels Map<String,String>
location String
maintenanceWindows List<GetMetastoreServiceMaintenanceWindow>
metadataIntegrations List<GetMetastoreServiceMetadataIntegration>
name String
network String
networkConfigs List<GetMetastoreServiceNetworkConfig>
port Integer
pulumiLabels Map<String,String>
releaseChannel String
scalingConfigs List<GetMetastoreServiceScalingConfig>
scheduledBackups List<GetMetastoreServiceScheduledBackup>
serviceId String
state String
stateMessage String
telemetryConfigs List<GetMetastoreServiceTelemetryConfig>
tier String
uid String
project String

artifactGcsUri string
databaseType string
deletionProtection boolean
effectiveLabels {[key: string]: string}
encryptionConfigs GetMetastoreServiceEncryptionConfig[]
endpointUri string
hiveMetastoreConfigs GetMetastoreServiceHiveMetastoreConfig[]
id string: The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}
location string
maintenanceWindows GetMetastoreServiceMaintenanceWindow[]
metadataIntegrations GetMetastoreServiceMetadataIntegration[]
name string
network string
networkConfigs GetMetastoreServiceNetworkConfig[]
port number
pulumiLabels {[key: string]: string}
releaseChannel string
scalingConfigs GetMetastoreServiceScalingConfig[]
scheduledBackups GetMetastoreServiceScheduledBackup[]
serviceId string
state string
stateMessage string
telemetryConfigs GetMetastoreServiceTelemetryConfig[]
tier string
uid string
project string

artifact_gcs_uri str
database_type str
deletion_protection bool
effective_labels Mapping[str, str]
encryption_configs Sequence[GetMetastoreServiceEncryptionConfig]
endpoint_uri str
hive_metastore_configs Sequence[GetMetastoreServiceHiveMetastoreConfig]
id str: The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]
location str
maintenance_windows Sequence[GetMetastoreServiceMaintenanceWindow]
metadata_integrations Sequence[GetMetastoreServiceMetadataIntegration]
name str
network str
network_configs Sequence[GetMetastoreServiceNetworkConfig]
port int
pulumi_labels Mapping[str, str]
release_channel str
scaling_configs Sequence[GetMetastoreServiceScalingConfig]
scheduled_backups Sequence[GetMetastoreServiceScheduledBackup]
service_id str
state str
state_message str
telemetry_configs Sequence[GetMetastoreServiceTelemetryConfig]
tier str
uid str
project str

artifactGcsUri String
databaseType String
deletionProtection Boolean
effectiveLabels Map<String>
encryptionConfigs List<Property Map>
endpointUri String
hiveMetastoreConfigs List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
labels Map<String>
location String
maintenanceWindows List<Property Map>
metadataIntegrations List<Property Map>
name String
network String
networkConfigs List<Property Map>
port Number
pulumiLabels Map<String>
releaseChannel String
scalingConfigs List<Property Map>
scheduledBackups List<Property Map>
serviceId String
state String
stateMessage String
telemetryConfigs List<Property Map>
tier String
uid String
project String

Supporting Types

GetMetastoreServiceEncryptionConfig

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/([^/]+)'

GetMetastoreServiceHiveMetastoreConfig

AuxiliaryVersions List<GetMetastoreServiceHiveMetastoreConfigAuxiliaryVersion>: A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
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: The protocol to use for the metastore service endpoint. If unspecified, defaults to 'THRIFT'. Default value: "THRIFT" Possible values: ["THRIFT", "GRPC"]
KerberosConfigs List<GetMetastoreServiceHiveMetastoreConfigKerberosConfig>: Information used to configure the Hive metastore service as a service principal in a Kerberos realm.
Version string: The Hive metastore schema version.

AuxiliaryVersions []GetMetastoreServiceHiveMetastoreConfigAuxiliaryVersion: A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
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: The protocol to use for the metastore service endpoint. If unspecified, defaults to 'THRIFT'. Default value: "THRIFT" Possible values: ["THRIFT", "GRPC"]
KerberosConfigs []GetMetastoreServiceHiveMetastoreConfigKerberosConfig: Information used to configure the Hive metastore service as a service principal in a Kerberos realm.
Version string: The Hive metastore schema version.

auxiliaryVersions List<GetMetastoreServiceHiveMetastoreConfigAuxiliaryVersion>: A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
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: The protocol to use for the metastore service endpoint. If unspecified, defaults to 'THRIFT'. Default value: "THRIFT" Possible values: ["THRIFT", "GRPC"]
kerberosConfigs List<GetMetastoreServiceHiveMetastoreConfigKerberosConfig>: Information used to configure the Hive metastore service as a service principal in a Kerberos realm.
version String: The Hive metastore schema version.

auxiliaryVersions GetMetastoreServiceHiveMetastoreConfigAuxiliaryVersion[]: A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
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: The protocol to use for the metastore service endpoint. If unspecified, defaults to 'THRIFT'. Default value: "THRIFT" Possible values: ["THRIFT", "GRPC"]
kerberosConfigs GetMetastoreServiceHiveMetastoreConfigKerberosConfig[]: Information used to configure the Hive metastore service as a service principal in a Kerberos realm.
version string: The Hive metastore schema version.

auxiliary_versions Sequence[GetMetastoreServiceHiveMetastoreConfigAuxiliaryVersion]: A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
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: The protocol to use for the metastore service endpoint. If unspecified, defaults to 'THRIFT'. Default value: "THRIFT" Possible values: ["THRIFT", "GRPC"]
kerberos_configs Sequence[GetMetastoreServiceHiveMetastoreConfigKerberosConfig]: Information used to configure the Hive metastore service as a service principal in a Kerberos realm.
version str: The Hive metastore schema version.

auxiliaryVersions List<Property Map>: A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
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: The protocol to use for the metastore service endpoint. If unspecified, defaults to 'THRIFT'. Default value: "THRIFT" Possible values: ["THRIFT", "GRPC"]
kerberosConfigs List<Property Map>: Information used to configure the Hive metastore service as a service principal in a Kerberos realm.
version String: The Hive metastore schema version.

GetMetastoreServiceHiveMetastoreConfigAuxiliaryVersion

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
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
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
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 string
version string: 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 str
version str: 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.
key String
version String: The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version.

GetMetastoreServiceHiveMetastoreConfigKerberosConfig

Keytabs List<GetMetastoreServiceHiveMetastoreConfigKerberosConfigKeytab>: A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
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.

Keytabs []GetMetastoreServiceHiveMetastoreConfigKerberosConfigKeytab: A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
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.

keytabs List<GetMetastoreServiceHiveMetastoreConfigKerberosConfigKeytab>: A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
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.

keytabs GetMetastoreServiceHiveMetastoreConfigKerberosConfigKeytab[]: A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
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.

keytabs Sequence[GetMetastoreServiceHiveMetastoreConfigKerberosConfigKeytab]: A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
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.

keytabs List<Property Map>: A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).
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.