MetastoreFederation class

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",
    }],
});

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",
    }])

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",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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().ToIDOutput().ToStringOutput(),
					MetastoreType: pulumi.String("DATAPROC_METASTORE"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_dataproc_metastorefederation" "default" {
  location      = "us-central1"
  federation_id = "metastore-fed"
  version       = "3.1.2"
  backend_metastores {
    rank           = "1"
    name           = gcp_dataproc_metastoreservice.default.id
    metastore_type = "DATAPROC_METASTORE"
  }
}
resource "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
}

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.ArrayList;
import java.util.Arrays;
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());

    }
}

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

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",
        },
    ],
});

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",
        },
    ])

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",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/dataproc"
	"github.com/pulumi/pulumi-gcp/sdk/v9/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().ToIDOutput().ToStringOutput(),
					MetastoreType: pulumi.String("DATAPROC_METASTORE"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_organizations_getproject" "project" {
}

resource "gcp_dataproc_metastorefederation" "default" {
  location      = "us-central1"
  federation_id = "metastore-fed"
  version       = "3.1.2"
  backend_metastores {
    rank           = "2"
    name           = data.gcp_organizations_getproject.project.id
    metastore_type = "BIGQUERY"
  }
  backend_metastores {
    rank           = "1"
    name           = gcp_dataproc_metastoreservice.default.id
    metastore_type = "DATAPROC_METASTORE"
  }
}
resource "gcp_dataproc_metastoreservice" "default" {
  service_id = "metastore-service"
  location   = "us-central1"
  tier       = "DEVELOPER"
  hive_metastore_config = {
    version           = "3.1.2"
    endpoint_protocol = "GRPC"
  }
}

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.ArrayList;
import java.util.Arrays;
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());

    }
}

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: {}

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}}
$ pulumi import gcp:dataproc/metastoreFederation:MetastoreFederation default {{project}}/{{location}}/{{federation_id}}
$ pulumi import gcp:dataproc/metastoreFederation:MetastoreFederation default {{location}}/{{federation_id}}

Constructors

MetastoreFederation(String name, {MetastoreFederationArgs? args, CustomResourceOptions? options})

Creates a new MetastoreFederation. name The Pulumi resource name. args Arguments used to configure this MetastoreFederation. The set of arguments for MetastoreFederation. options Resource options controlling this resource's behavior.

MetastoreFederation.reference(String urn)

Creates a typed reference to an existing MetastoreFederation resource.

Properties

backendMetastores ↔ Output<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.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Output only. The time when the metastore federation was created.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

deletionProtection ↔ Output<bool?>

Whether Terraform will be prevented from destroying the federation. Defaults to false. When the field is set to true in Terraform state, a pulumi up or terraform destroy that would delete the federation will fail.

late, final

effectiveLabels ↔ Output<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.

late, final

endpointUri ↔ Output<String>

The URI of the endpoint used to access the metastore federation.

late, final

federationId ↔ Output<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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<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 effectiveLabels for all of the labels present on the resource.

late, final

location ↔ Output<String?>

The location where the metastore federation should reside.

late, final

name ↔ Output<String>

The relative resource name of the metastore federation.

late, final

project ↔ Output<String>

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

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

The current state of the metastore federation.

late, final

stateMessage ↔ Output<String>

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

late, final

tags ↔ Output<Map<String, String>?>

A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

The globally unique resource identifier of the metastore federation.

late, final

updateTime ↔ Output<String>

Output only. The time when the metastore federation was last updated.

late, final

urn ↔ Output<String>

late, final, inherited

version ↔ Output<String>

The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {MetastoreFederationState? state, CustomResourceOptions? options}) → MetastoreFederation

Gets an existing MetastoreFederation resource's state with the given name and id.