1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. dataproc
  5. MetastoreFederation
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.dataproc.MetastoreFederation

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    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: "",
        location: "us-central1",
        tier: "DEVELOPER",
        hiveMetastoreConfig: {
            version: "3.1.2",
            endpointProtocol: "GRPC",
        },
    });
    const _default = new gcp.dataproc.MetastoreFederation("default", {
        location: "us-central1",
        federationId: "",
        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="",
        location="us-central1",
        tier="DEVELOPER",
        hive_metastore_config=gcp.dataproc.MetastoreServiceHiveMetastoreConfigArgs(
            version="3.1.2",
            endpoint_protocol="GRPC",
        ))
    default = gcp.dataproc.MetastoreFederation("default",
        location="us-central1",
        federation_id="",
        version="3.1.2",
        backend_metastores=[gcp.dataproc.MetastoreFederationBackendMetastoreArgs(
            rank="1",
            name=default_metastore_service.id,
            metastore_type="DATAPROC_METASTORE",
        )])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/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(""),
    			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
    		}
    		_, err = dataproc.NewMetastoreFederation(ctx, "default", &dataproc.MetastoreFederationArgs{
    			Location:     pulumi.String("us-central1"),
    			FederationId: pulumi.String(""),
    			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
    	})
    }
    
    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 = "",
            Location = "us-central1",
            Tier = "DEVELOPER",
            HiveMetastoreConfig = new Gcp.Dataproc.Inputs.MetastoreServiceHiveMetastoreConfigArgs
            {
                Version = "3.1.2",
                EndpointProtocol = "GRPC",
            },
        });
    
        var @default = new Gcp.Dataproc.MetastoreFederation("default", new()
        {
            Location = "us-central1",
            FederationId = "",
            Version = "3.1.2",
            BackendMetastores = new[]
            {
                new Gcp.Dataproc.Inputs.MetastoreFederationBackendMetastoreArgs
                {
                    Rank = "1",
                    Name = defaultMetastoreService.Id,
                    MetastoreType = "DATAPROC_METASTORE",
                },
            },
        });
    
    });
    
    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("")
                .location("us-central1")
                .tier("DEVELOPER")
                .hiveMetastoreConfig(MetastoreServiceHiveMetastoreConfigArgs.builder()
                    .version("3.1.2")
                    .endpointProtocol("GRPC")
                    .build())
                .build());
    
            var default_ = new MetastoreFederation("default", MetastoreFederationArgs.builder()
                .location("us-central1")
                .federationId("")
                .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:
          version: 3.1.2
          backendMetastores:
            - rank: '1'
              name: ${defaultMetastoreService.id}
              metastoreType: DATAPROC_METASTORE
      defaultMetastoreService:
        type: gcp:dataproc:MetastoreService
        name: default
        properties:
          serviceId:
          location: us-central1
          tier: DEVELOPER
          hiveMetastoreConfig:
            version: 3.1.2
            endpointProtocol: GRPC
    

    Dataproc Metastore Federation Bigquery

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const defaultMetastoreService = new gcp.dataproc.MetastoreService("default", {
        serviceId: "",
        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: "",
        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="",
        location="us-central1",
        tier="DEVELOPER",
        hive_metastore_config=gcp.dataproc.MetastoreServiceHiveMetastoreConfigArgs(
            version="3.1.2",
            endpoint_protocol="GRPC",
        ))
    project = gcp.organizations.get_project()
    default = gcp.dataproc.MetastoreFederation("default",
        location="us-central1",
        federation_id="",
        version="3.1.2",
        backend_metastores=[
            gcp.dataproc.MetastoreFederationBackendMetastoreArgs(
                rank="2",
                name=project.id,
                metastore_type="BIGQUERY",
            ),
            gcp.dataproc.MetastoreFederationBackendMetastoreArgs(
                rank="1",
                name=default_metastore_service.id,
                metastore_type="DATAPROC_METASTORE",
            ),
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/dataproc"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/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(""),
    			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, nil, nil)
    		if err != nil {
    			return err
    		}
    		_, err = dataproc.NewMetastoreFederation(ctx, "default", &dataproc.MetastoreFederationArgs{
    			Location:     pulumi.String("us-central1"),
    			FederationId: pulumi.String(""),
    			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
    	})
    }
    
    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 = "",
            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 = "",
            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 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("")
                .location("us-central1")
                .tier("DEVELOPER")
                .hiveMetastoreConfig(MetastoreServiceHiveMetastoreConfigArgs.builder()
                    .version("3.1.2")
                    .endpointProtocol("GRPC")
                    .build())
                .build());
    
            final var project = OrganizationsFunctions.getProject();
    
            var default_ = new MetastoreFederation("default", MetastoreFederationArgs.builder()
                .location("us-central1")
                .federationId("")
                .version("3.1.2")
                .backendMetastores(            
                    MetastoreFederationBackendMetastoreArgs.builder()
                        .rank("2")
                        .name(project.applyValue(getProjectResult -> getProjectResult.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:
          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:
          location: us-central1
          tier: DEVELOPER
          hiveMetastoreConfig:
            version: 3.1.2
            endpointProtocol: GRPC
    variables:
      project:
        fn::invoke:
          Function: gcp:organizations:getProject
          Arguments: {}
    

    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,
                            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 string
    The unique name of the resource.
    args MetastoreFederationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args MetastoreFederationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetastoreFederationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetastoreFederationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        Project = "string",
    });
    
    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"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Location: pulumi.String("string"),
    	Project:  pulumi.String("string"),
    })
    
    var metastoreFederationResource = new MetastoreFederation("metastoreFederationResource", MetastoreFederationArgs.builder()
        .backendMetastores(MetastoreFederationBackendMetastoreArgs.builder()
            .metastoreType("string")
            .name("string")
            .rank("string")
            .build())
        .federationId("string")
        .version("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .project("string")
        .build());
    
    metastore_federation_resource = gcp.dataproc.MetastoreFederation("metastoreFederationResource",
        backend_metastores=[gcp.dataproc.MetastoreFederationBackendMetastoreArgs(
            metastore_type="string",
            name="string",
            rank="string",
        )],
        federation_id="string",
        version="string",
        labels={
            "string": "string",
        },
        location="string",
        project="string")
    
    const metastoreFederationResource = new gcp.dataproc.MetastoreFederation("metastoreFederationResource", {
        backendMetastores: [{
            metastoreType: "string",
            name: "string",
            rank: "string",
        }],
        federationId: "string",
        version: "string",
        labels: {
            string: "string",
        },
        location: "string",
        project: "string",
    });
    
    type: gcp:dataproc:MetastoreFederation
    properties:
        backendMetastores:
            - metastoreType: string
              name: string
              rank: string
        federationId: string
        labels:
            string: string
        location: string
        project: string
        version: string
    

    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

    The MetastoreFederation resource accepts the following input properties:

    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.
    FederationId 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 string
    The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
    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 string
    The location where the metastore federation should reside.
    Project string
    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.
    FederationId 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 string
    The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
    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 string
    The location where the metastore federation should reside.
    Project string
    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.
    federationId 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 String
    The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
    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 String
    The location where the metastore federation should reside.
    project String
    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.
    federationId 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 string
    The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
    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 string
    The location where the metastore federation should reside.
    project string
    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.
    federation_id 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 str
    The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
    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 str
    The location where the metastore federation should reside.
    project str
    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.
    federationId 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 String
    The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
    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 String
    The location where the metastore federation should reside.
    project String

    Outputs

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

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

    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,
            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,
            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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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.
    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 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 string
    The location where the metastore federation should reside.
    Name string
    The relative resource name of the metastore federation.
    Project 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.
    Version 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.
    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 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 string
    The location where the metastore federation should reside.
    Name string
    The relative resource name of the metastore federation.
    Project 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.
    Version 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.
    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 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 String
    The location where the metastore federation should reside.
    name String
    The relative resource name of the metastore federation.
    project 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.
    version 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.
    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 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 string
    The location where the metastore federation should reside.
    name string
    The relative resource name of the metastore federation.
    project 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.
    version 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.
    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 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 str
    The location where the metastore federation should reside.
    name str
    The relative resource name of the metastore federation.
    project 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.
    version 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.
    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 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 String
    The location where the metastore federation should reside.
    name String
    The relative resource name of the metastore federation.
    project 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.
    version 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 string
    The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.


    Name 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 string
    The identifier for this object. Format specified above.
    MetastoreType string
    The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.


    Name 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 string
    The identifier for this object. Format specified above.
    metastoreType String
    The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.


    name 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 String
    The identifier for this object. Format specified above.
    metastoreType string
    The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.


    name 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 string
    The identifier for this object. Format specified above.
    metastore_type str
    The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.


    name 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 str
    The identifier for this object. Format specified above.
    metastoreType String
    The type of the backend metastore. Possible values are: METASTORE_TYPE_UNSPECIFIED, DATAPROC_METASTORE, BIGQUERY.


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

    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.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi