Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. dataproc
  5. MetastoreFederation
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.dataproc.MetastoreFederation

Explore with Pulumi AI

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

A managed metastore federation.

Example Usage

Dataproc Metastore Federation Basic

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

const defaultMetastoreService = new gcp.dataproc.MetastoreService("default", {
    serviceId: "metastore-service",
    location: "us-central1",
    tier: "DEVELOPER",
    hiveMetastoreConfig: {
        version: "3.1.2",
        endpointProtocol: "GRPC",
    },
    deletionProtection: false,
});
const _default = new gcp.dataproc.MetastoreFederation("default", {
    location: "us-central1",
    federationId: "metastore-fed",
    version: "3.1.2",
    backendMetastores: [{
        rank: "1",
        name: defaultMetastoreService.id,
        metastoreType: "DATAPROC_METASTORE",
    }],
});
Copy
import pulumi
import pulumi_gcp as gcp

default_metastore_service = gcp.dataproc.MetastoreService("default",
    service_id="metastore-service",
    location="us-central1",
    tier="DEVELOPER",
    hive_metastore_config={
        "version": "3.1.2",
        "endpoint_protocol": "GRPC",
    },
    deletion_protection=False)
default = gcp.dataproc.MetastoreFederation("default",
    location="us-central1",
    federation_id="metastore-fed",
    version="3.1.2",
    backend_metastores=[{
        "rank": "1",
        "name": default_metastore_service.id,
        "metastore_type": "DATAPROC_METASTORE",
    }])
Copy
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 {
		defaultMetastoreService, err := dataproc.NewMetastoreService(ctx, "default", &dataproc.MetastoreServiceArgs{
			ServiceId: pulumi.String("metastore-service"),
			Location:  pulumi.String("us-central1"),
			Tier:      pulumi.String("DEVELOPER"),
			HiveMetastoreConfig: &dataproc.MetastoreServiceHiveMetastoreConfigArgs{
				Version:          pulumi.String("3.1.2"),
				EndpointProtocol: pulumi.String("GRPC"),
			},
			DeletionProtection: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = dataproc.NewMetastoreFederation(ctx, "default", &dataproc.MetastoreFederationArgs{
			Location:     pulumi.String("us-central1"),
			FederationId: pulumi.String("metastore-fed"),
			Version:      pulumi.String("3.1.2"),
			BackendMetastores: dataproc.MetastoreFederationBackendMetastoreArray{
				&dataproc.MetastoreFederationBackendMetastoreArgs{
					Rank:          pulumi.String("1"),
					Name:          defaultMetastoreService.ID(),
					MetastoreType: pulumi.String("DATAPROC_METASTORE"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var defaultMetastoreService = new Gcp.Dataproc.MetastoreService("default", new()
    {
        ServiceId = "metastore-service",
        Location = "us-central1",
        Tier = "DEVELOPER",
        HiveMetastoreConfig = new Gcp.Dataproc.Inputs.MetastoreServiceHiveMetastoreConfigArgs
        {
            Version = "3.1.2",
            EndpointProtocol = "GRPC",
        },
        DeletionProtection = false,
    });

    var @default = new Gcp.Dataproc.MetastoreFederation("default", new()
    {
        Location = "us-central1",
        FederationId = "metastore-fed",
        Version = "3.1.2",
        BackendMetastores = new[]
        {
            new Gcp.Dataproc.Inputs.MetastoreFederationBackendMetastoreArgs
            {
                Rank = "1",
                Name = defaultMetastoreService.Id,
                MetastoreType = "DATAPROC_METASTORE",
            },
        },
    });

});
Copy
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.MetastoreFederation;
import com.pulumi.gcp.dataproc.MetastoreFederationArgs;
import com.pulumi.gcp.dataproc.inputs.MetastoreFederationBackendMetastoreArgs;
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 defaultMetastoreService = new MetastoreService("defaultMetastoreService", MetastoreServiceArgs.builder()
            .serviceId("metastore-service")
            .location("us-central1")
            .tier("DEVELOPER")
            .hiveMetastoreConfig(MetastoreServiceHiveMetastoreConfigArgs.builder()
                .version("3.1.2")
                .endpointProtocol("GRPC")
                .build())
            .deletionProtection(false)
            .build());

        var default_ = new MetastoreFederation("default", MetastoreFederationArgs.builder()
            .location("us-central1")
            .federationId("metastore-fed")
            .version("3.1.2")
            .backendMetastores(MetastoreFederationBackendMetastoreArgs.builder()
                .rank("1")
                .name(defaultMetastoreService.id())
                .metastoreType("DATAPROC_METASTORE")
                .build())
            .build());

    }
}
Copy
resources:
  default:
    type: gcp:dataproc:MetastoreFederation
    properties:
      location: us-central1
      federationId: metastore-fed
      version: 3.1.2
      backendMetastores:
        - rank: '1'
          name: ${defaultMetastoreService.id}
          metastoreType: DATAPROC_METASTORE
  defaultMetastoreService:
    type: gcp:dataproc:MetastoreService
    name: default
    properties:
      serviceId: metastore-service
      location: us-central1
      tier: DEVELOPER
      hiveMetastoreConfig:
        version: 3.1.2
        endpointProtocol: GRPC
      deletionProtection: false
Copy

Dataproc Metastore Federation Bigquery

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

const defaultMetastoreService = new gcp.dataproc.MetastoreService("default", {
    serviceId: "metastore-service",
    location: "us-central1",
    tier: "DEVELOPER",
    hiveMetastoreConfig: {
        version: "3.1.2",
        endpointProtocol: "GRPC",
    },
});
const project = gcp.organizations.getProject({});
const _default = new gcp.dataproc.MetastoreFederation("default", {
    location: "us-central1",
    federationId: "metastore-fed",
    version: "3.1.2",
    backendMetastores: [
        {
            rank: "2",
            name: project.then(project => project.id),
            metastoreType: "BIGQUERY",
        },
        {
            rank: "1",
            name: defaultMetastoreService.id,
            metastoreType: "DATAPROC_METASTORE",
        },
    ],
});
Copy
import pulumi
import pulumi_gcp as gcp

default_metastore_service = gcp.dataproc.MetastoreService("default",
    service_id="metastore-service",
    location="us-central1",
    tier="DEVELOPER",
    hive_metastore_config={
        "version": "3.1.2",
        "endpoint_protocol": "GRPC",
    })
project = gcp.organizations.get_project()
default = gcp.dataproc.MetastoreFederation("default",
    location="us-central1",
    federation_id="metastore-fed",
    version="3.1.2",
    backend_metastores=[
        {
            "rank": "2",
            "name": project.id,
            "metastore_type": "BIGQUERY",
        },
        {
            "rank": "1",
            "name": default_metastore_service.id,
            "metastore_type": "DATAPROC_METASTORE",
        },
    ])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		defaultMetastoreService, err := dataproc.NewMetastoreService(ctx, "default", &dataproc.MetastoreServiceArgs{
			ServiceId: pulumi.String("metastore-service"),
			Location:  pulumi.String("us-central1"),
			Tier:      pulumi.String("DEVELOPER"),
			HiveMetastoreConfig: &dataproc.MetastoreServiceHiveMetastoreConfigArgs{
				Version:          pulumi.String("3.1.2"),
				EndpointProtocol: pulumi.String("GRPC"),
			},
		})
		if err != nil {
			return err
		}
		project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = dataproc.NewMetastoreFederation(ctx, "default", &dataproc.MetastoreFederationArgs{
			Location:     pulumi.String("us-central1"),
			FederationId: pulumi.String("metastore-fed"),
			Version:      pulumi.String("3.1.2"),
			BackendMetastores: dataproc.MetastoreFederationBackendMetastoreArray{
				&dataproc.MetastoreFederationBackendMetastoreArgs{
					Rank:          pulumi.String("2"),
					Name:          pulumi.String(project.Id),
					MetastoreType: pulumi.String("BIGQUERY"),
				},
				&dataproc.MetastoreFederationBackendMetastoreArgs{
					Rank:          pulumi.String("1"),
					Name:          defaultMetastoreService.ID(),
					MetastoreType: pulumi.String("DATAPROC_METASTORE"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var defaultMetastoreService = new Gcp.Dataproc.MetastoreService("default", new()
    {
        ServiceId = "metastore-service",
        Location = "us-central1",
        Tier = "DEVELOPER",
        HiveMetastoreConfig = new Gcp.Dataproc.Inputs.MetastoreServiceHiveMetastoreConfigArgs
        {
            Version = "3.1.2",
            EndpointProtocol = "GRPC",
        },
    });

    var project = Gcp.Organizations.GetProject.Invoke();

    var @default = new Gcp.Dataproc.MetastoreFederation("default", new()
    {
        Location = "us-central1",
        FederationId = "metastore-fed",
        Version = "3.1.2",
        BackendMetastores = new[]
        {
            new Gcp.Dataproc.Inputs.MetastoreFederationBackendMetastoreArgs
            {
                Rank = "2",
                Name = project.Apply(getProjectResult => getProjectResult.Id),
                MetastoreType = "BIGQUERY",
            },
            new Gcp.Dataproc.Inputs.MetastoreFederationBackendMetastoreArgs
            {
                Rank = "1",
                Name = defaultMetastoreService.Id,
                MetastoreType = "DATAPROC_METASTORE",
            },
        },
    });

});
Copy
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.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.dataproc.MetastoreFederation;
import com.pulumi.gcp.dataproc.MetastoreFederationArgs;
import com.pulumi.gcp.dataproc.inputs.MetastoreFederationBackendMetastoreArgs;
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 defaultMetastoreService = new MetastoreService("defaultMetastoreService", MetastoreServiceArgs.builder()
            .serviceId("metastore-service")
            .location("us-central1")
            .tier("DEVELOPER")
            .hiveMetastoreConfig(MetastoreServiceHiveMetastoreConfigArgs.builder()
                .version("3.1.2")
                .endpointProtocol("GRPC")
                .build())
            .build());

        final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
            .build());

        var default_ = new MetastoreFederation("default", MetastoreFederationArgs.builder()
            .location("us-central1")
            .federationId("metastore-fed")
            .version("3.1.2")
            .backendMetastores(            
                MetastoreFederationBackendMetastoreArgs.builder()
                    .rank("2")
                    .name(project.id())
                    .metastoreType("BIGQUERY")
                    .build(),
                MetastoreFederationBackendMetastoreArgs.builder()
                    .rank("1")
                    .name(defaultMetastoreService.id())
                    .metastoreType("DATAPROC_METASTORE")
                    .build())
            .build());

    }
}
Copy
resources:
  default:
    type: gcp:dataproc:MetastoreFederation
    properties:
      location: us-central1
      federationId: metastore-fed
      version: 3.1.2
      backendMetastores:
        - rank: '2'
          name: ${project.id}
          metastoreType: BIGQUERY
        - rank: '1'
          name: ${defaultMetastoreService.id}
          metastoreType: DATAPROC_METASTORE
  defaultMetastoreService:
    type: gcp:dataproc:MetastoreService
    name: default
    properties:
      serviceId: metastore-service
      location: us-central1
      tier: DEVELOPER
      hiveMetastoreConfig:
        version: 3.1.2
        endpointProtocol: GRPC
variables:
  project:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments: {}
Copy

Create MetastoreFederation Resource

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

Constructor syntax

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

@overload
def MetastoreFederation(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        backend_metastores: Optional[Sequence[MetastoreFederationBackendMetastoreArgs]] = None,
                        federation_id: Optional[str] = None,
                        version: Optional[str] = None,
                        deletion_protection: Optional[bool] = None,
                        labels: Optional[Mapping[str, str]] = None,
                        location: Optional[str] = None,
                        project: Optional[str] = None)
func NewMetastoreFederation(ctx *Context, name string, args MetastoreFederationArgs, opts ...ResourceOption) (*MetastoreFederation, error)
public MetastoreFederation(string name, MetastoreFederationArgs args, CustomResourceOptions? opts = null)
public MetastoreFederation(String name, MetastoreFederationArgs args)
public MetastoreFederation(String name, MetastoreFederationArgs args, CustomResourceOptions options)

type: gcp:dataproc:MetastoreFederation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MetastoreFederationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MetastoreFederationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MetastoreFederationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MetastoreFederationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MetastoreFederationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var metastoreFederationResource = new Gcp.Dataproc.MetastoreFederation("metastoreFederationResource", new()
{
    BackendMetastores = new[]
    {
        new Gcp.Dataproc.Inputs.MetastoreFederationBackendMetastoreArgs
        {
            MetastoreType = "string",
            Name = "string",
            Rank = "string",
        },
    },
    FederationId = "string",
    Version = "string",
    DeletionProtection = false,
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Project = "string",
});
Copy
example, err := dataproc.NewMetastoreFederation(ctx, "metastoreFederationResource", &dataproc.MetastoreFederationArgs{
	BackendMetastores: dataproc.MetastoreFederationBackendMetastoreArray{
		&dataproc.MetastoreFederationBackendMetastoreArgs{
			MetastoreType: pulumi.String("string"),
			Name:          pulumi.String("string"),
			Rank:          pulumi.String("string"),
		},
	},
	FederationId:       pulumi.String("string"),
	Version:            pulumi.String("string"),
	DeletionProtection: pulumi.Bool(false),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Project:  pulumi.String("string"),
})
Copy
var metastoreFederationResource = new MetastoreFederation("metastoreFederationResource", MetastoreFederationArgs.builder()
    .backendMetastores(MetastoreFederationBackendMetastoreArgs.builder()
        .metastoreType("string")
        .name("string")
        .rank("string")
        .build())
    .federationId("string")
    .version("string")
    .deletionProtection(false)
    .labels(Map.of("string", "string"))
    .location("string")
    .project("string")
    .build());
Copy
metastore_federation_resource = gcp.dataproc.MetastoreFederation("metastoreFederationResource",
    backend_metastores=[{
        "metastore_type": "string",
        "name": "string",
        "rank": "string",
    }],
    federation_id="string",
    version="string",
    deletion_protection=False,
    labels={
        "string": "string",
    },
    location="string",
    project="string")
Copy
const metastoreFederationResource = new gcp.dataproc.MetastoreFederation("metastoreFederationResource", {
    backendMetastores: [{
        metastoreType: "string",
        name: "string",
        rank: "string",
    }],
    federationId: "string",
    version: "string",
    deletionProtection: false,
    labels: {
        string: "string",
    },
    location: "string",
    project: "string",
});
Copy
type: gcp:dataproc:MetastoreFederation
properties:
    backendMetastores:
        - metastoreType: string
          name: string
          rank: string
    deletionProtection: false
    federationId: string
    labels:
        string: string
    location: string
    project: string
    version: string
Copy

MetastoreFederation Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MetastoreFederation resource accepts the following input properties:

BackendMetastores This property is required. List<MetastoreFederationBackendMetastore>
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
FederationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the metastore federation. 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.
Version
This property is required.
Changes to this property will trigger replacement.
string
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
DeletionProtection bool
Labels Dictionary<string, string>
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Location Changes to this property will trigger replacement. string
The location where the metastore federation should reside.
Project Changes to this property will trigger replacement. string
BackendMetastores This property is required. []MetastoreFederationBackendMetastoreArgs
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
FederationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the metastore federation. 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.
Version
This property is required.
Changes to this property will trigger replacement.
string
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
DeletionProtection bool
Labels map[string]string
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Location Changes to this property will trigger replacement. string
The location where the metastore federation should reside.
Project Changes to this property will trigger replacement. string
backendMetastores This property is required. List<MetastoreFederationBackendMetastore>
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
federationId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the metastore federation. 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.
version
This property is required.
Changes to this property will trigger replacement.
String
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
deletionProtection Boolean
labels Map<String,String>
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. String
The location where the metastore federation should reside.
project Changes to this property will trigger replacement. String
backendMetastores This property is required. MetastoreFederationBackendMetastore[]
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
federationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the metastore federation. 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.
version
This property is required.
Changes to this property will trigger replacement.
string
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
deletionProtection boolean
labels {[key: string]: string}
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. string
The location where the metastore federation should reside.
project Changes to this property will trigger replacement. string
backend_metastores This property is required. Sequence[MetastoreFederationBackendMetastoreArgs]
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
federation_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the metastore federation. 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.
version
This property is required.
Changes to this property will trigger replacement.
str
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
deletion_protection bool
labels Mapping[str, str]
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. str
The location where the metastore federation should reside.
project Changes to this property will trigger replacement. str
backendMetastores This property is required. List<Property Map>
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
federationId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the metastore federation. 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.
version
This property is required.
Changes to this property will trigger replacement.
String
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
deletionProtection Boolean
labels Map<String>
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. String
The location where the metastore federation should reside.
project Changes to this property will trigger replacement. String

Outputs

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

CreateTime string
Output only. The time when the metastore federation was created.
EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
EndpointUri string
The URI of the endpoint used to access the metastore federation.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The relative resource name of the metastore federation.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
State string
The current state of the metastore federation.
StateMessage string
Additional information about the current state of the metastore federation, if available.
Uid string
The globally unique resource identifier of the metastore federation.
UpdateTime string
Output only. The time when the metastore federation was last updated.
CreateTime string
Output only. The time when the metastore federation was created.
EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
EndpointUri string
The URI of the endpoint used to access the metastore federation.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The relative resource name of the metastore federation.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
State string
The current state of the metastore federation.
StateMessage string
Additional information about the current state of the metastore federation, if available.
Uid string
The globally unique resource identifier of the metastore federation.
UpdateTime string
Output only. The time when the metastore federation was last updated.
createTime String
Output only. The time when the metastore federation was created.
effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
endpointUri String
The URI of the endpoint used to access the metastore federation.
id String
The provider-assigned unique ID for this managed resource.
name String
The relative resource name of the metastore federation.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
state String
The current state of the metastore federation.
stateMessage String
Additional information about the current state of the metastore federation, if available.
uid String
The globally unique resource identifier of the metastore federation.
updateTime String
Output only. The time when the metastore federation was last updated.
createTime string
Output only. The time when the metastore federation was created.
effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
endpointUri string
The URI of the endpoint used to access the metastore federation.
id string
The provider-assigned unique ID for this managed resource.
name string
The relative resource name of the metastore federation.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
state string
The current state of the metastore federation.
stateMessage string
Additional information about the current state of the metastore federation, if available.
uid string
The globally unique resource identifier of the metastore federation.
updateTime string
Output only. The time when the metastore federation was last updated.
create_time str
Output only. The time when the metastore federation was created.
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
endpoint_uri str
The URI of the endpoint used to access the metastore federation.
id str
The provider-assigned unique ID for this managed resource.
name str
The relative resource name of the metastore federation.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
state str
The current state of the metastore federation.
state_message str
Additional information about the current state of the metastore federation, if available.
uid str
The globally unique resource identifier of the metastore federation.
update_time str
Output only. The time when the metastore federation was last updated.
createTime String
Output only. The time when the metastore federation was created.
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
endpointUri String
The URI of the endpoint used to access the metastore federation.
id String
The provider-assigned unique ID for this managed resource.
name String
The relative resource name of the metastore federation.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
state String
The current state of the metastore federation.
stateMessage String
Additional information about the current state of the metastore federation, if available.
uid String
The globally unique resource identifier of the metastore federation.
updateTime String
Output only. The time when the metastore federation was last updated.

Look up Existing MetastoreFederation Resource

Get an existing MetastoreFederation 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?: MetastoreFederationState, opts?: CustomResourceOptions): MetastoreFederation
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend_metastores: Optional[Sequence[MetastoreFederationBackendMetastoreArgs]] = None,
        create_time: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        endpoint_uri: Optional[str] = None,
        federation_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        state: Optional[str] = None,
        state_message: Optional[str] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None,
        version: Optional[str] = None) -> MetastoreFederation
func GetMetastoreFederation(ctx *Context, name string, id IDInput, state *MetastoreFederationState, opts ...ResourceOption) (*MetastoreFederation, error)
public static MetastoreFederation Get(string name, Input<string> id, MetastoreFederationState? state, CustomResourceOptions? opts = null)
public static MetastoreFederation get(String name, Output<String> id, MetastoreFederationState state, CustomResourceOptions options)
resources:  _:    type: gcp:dataproc:MetastoreFederation    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
BackendMetastores List<MetastoreFederationBackendMetastore>
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
CreateTime string
Output only. The time when the metastore federation was created.
DeletionProtection bool
EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
EndpointUri string
The URI of the endpoint used to access the metastore federation.
FederationId Changes to this property will trigger replacement. string
The ID of the metastore federation. 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.
Labels Dictionary<string, string>
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Location Changes to this property will trigger replacement. string
The location where the metastore federation should reside.
Name string
The relative resource name of the metastore federation.
Project Changes to this property will trigger replacement. string
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
State string
The current state of the metastore federation.
StateMessage string
Additional information about the current state of the metastore federation, if available.
Uid string
The globally unique resource identifier of the metastore federation.
UpdateTime string
Output only. The time when the metastore federation was last updated.
Version Changes to this property will trigger replacement. string
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
BackendMetastores []MetastoreFederationBackendMetastoreArgs
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
CreateTime string
Output only. The time when the metastore federation was created.
DeletionProtection bool
EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
EndpointUri string
The URI of the endpoint used to access the metastore federation.
FederationId Changes to this property will trigger replacement. string
The ID of the metastore federation. 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.
Labels map[string]string
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Location Changes to this property will trigger replacement. string
The location where the metastore federation should reside.
Name string
The relative resource name of the metastore federation.
Project Changes to this property will trigger replacement. string
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
State string
The current state of the metastore federation.
StateMessage string
Additional information about the current state of the metastore federation, if available.
Uid string
The globally unique resource identifier of the metastore federation.
UpdateTime string
Output only. The time when the metastore federation was last updated.
Version Changes to this property will trigger replacement. string
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
backendMetastores List<MetastoreFederationBackendMetastore>
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
createTime String
Output only. The time when the metastore federation was created.
deletionProtection Boolean
effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
endpointUri String
The URI of the endpoint used to access the metastore federation.
federationId Changes to this property will trigger replacement. String
The ID of the metastore federation. 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.
labels Map<String,String>
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. String
The location where the metastore federation should reside.
name String
The relative resource name of the metastore federation.
project Changes to this property will trigger replacement. String
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
state String
The current state of the metastore federation.
stateMessage String
Additional information about the current state of the metastore federation, if available.
uid String
The globally unique resource identifier of the metastore federation.
updateTime String
Output only. The time when the metastore federation was last updated.
version Changes to this property will trigger replacement. String
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
backendMetastores MetastoreFederationBackendMetastore[]
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
createTime string
Output only. The time when the metastore federation was created.
deletionProtection boolean
effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
endpointUri string
The URI of the endpoint used to access the metastore federation.
federationId Changes to this property will trigger replacement. string
The ID of the metastore federation. 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.
labels {[key: string]: string}
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. string
The location where the metastore federation should reside.
name string
The relative resource name of the metastore federation.
project Changes to this property will trigger replacement. string
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
state string
The current state of the metastore federation.
stateMessage string
Additional information about the current state of the metastore federation, if available.
uid string
The globally unique resource identifier of the metastore federation.
updateTime string
Output only. The time when the metastore federation was last updated.
version Changes to this property will trigger replacement. string
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
backend_metastores Sequence[MetastoreFederationBackendMetastoreArgs]
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
create_time str
Output only. The time when the metastore federation was created.
deletion_protection bool
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
endpoint_uri str
The URI of the endpoint used to access the metastore federation.
federation_id Changes to this property will trigger replacement. str
The ID of the metastore federation. 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.
labels Mapping[str, str]
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. str
The location where the metastore federation should reside.
name str
The relative resource name of the metastore federation.
project Changes to this property will trigger replacement. str
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
state str
The current state of the metastore federation.
state_message str
Additional information about the current state of the metastore federation, if available.
uid str
The globally unique resource identifier of the metastore federation.
update_time str
Output only. The time when the metastore federation was last updated.
version Changes to this property will trigger replacement. str
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
backendMetastores List<Property Map>
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. Structure is documented below.
createTime String
Output only. The time when the metastore federation was created.
deletionProtection Boolean
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
endpointUri String
The URI of the endpoint used to access the metastore federation.
federationId Changes to this property will trigger replacement. String
The ID of the metastore federation. 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.
labels Map<String>
User-defined labels for the metastore federation. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
location Changes to this property will trigger replacement. String
The location where the metastore federation should reside.
name String
The relative resource name of the metastore federation.
project Changes to this property will trigger replacement. String
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
state String
The current state of the metastore federation.
stateMessage String
Additional information about the current state of the metastore federation, if available.
uid String
The globally unique resource identifier of the metastore federation.
updateTime String
Output only. The time when the metastore federation was last updated.
version Changes to this property will trigger replacement. String
The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.

Supporting Types

MetastoreFederationBackendMetastore
, MetastoreFederationBackendMetastoreArgs

MetastoreType This property is required. string
The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.

Name This property is required. string
The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below: Dataplex: projects/{projectId}/locations/{location}/lakes/{lake_id} BigQuery: projects/{projectId} Dataproc Metastore: projects/{projectId}/locations/{location}/services/{serviceId}
Rank This property is required. string
The identifier for this object. Format specified above.
MetastoreType This property is required. string
The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.

Name This property is required. string
The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below: Dataplex: projects/{projectId}/locations/{location}/lakes/{lake_id} BigQuery: projects/{projectId} Dataproc Metastore: projects/{projectId}/locations/{location}/services/{serviceId}
Rank This property is required. string
The identifier for this object. Format specified above.
metastoreType This property is required. String
The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.

name This property is required. String
The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below: Dataplex: projects/{projectId}/locations/{location}/lakes/{lake_id} BigQuery: projects/{projectId} Dataproc Metastore: projects/{projectId}/locations/{location}/services/{serviceId}
rank This property is required. String
The identifier for this object. Format specified above.
metastoreType This property is required. string
The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.

name This property is required. string
The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below: Dataplex: projects/{projectId}/locations/{location}/lakes/{lake_id} BigQuery: projects/{projectId} Dataproc Metastore: projects/{projectId}/locations/{location}/services/{serviceId}
rank This property is required. string
The identifier for this object. Format specified above.
metastore_type This property is required. str
The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.

name This property is required. str
The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below: Dataplex: projects/{projectId}/locations/{location}/lakes/{lake_id} BigQuery: projects/{projectId} Dataproc Metastore: projects/{projectId}/locations/{location}/services/{serviceId}
rank This property is required. str
The identifier for this object. Format specified above.
metastoreType This property is required. String
The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.

name This property is required. String
The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below: Dataplex: projects/{projectId}/locations/{location}/lakes/{lake_id} BigQuery: projects/{projectId} Dataproc Metastore: projects/{projectId}/locations/{location}/services/{serviceId}
rank This property is required. String
The identifier for this object. Format specified above.

Import

Federation can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/federations/{{federation_id}}

  • {{project}}/{{location}}/{{federation_id}}

  • {{location}}/{{federation_id}}

When using the pulumi import command, Federation can be imported using one of the formats above. For example:

$ pulumi import gcp:dataproc/metastoreFederation:MetastoreFederation default projects/{{project}}/locations/{{location}}/federations/{{federation_id}}
Copy
$ pulumi import gcp:dataproc/metastoreFederation:MetastoreFederation default {{project}}/{{location}}/{{federation_id}}
Copy
$ pulumi import gcp:dataproc/metastoreFederation:MetastoreFederation default {{location}}/{{federation_id}}
Copy

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

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.
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp