Docs
Packagesgcp.dataproc.MetastoreFederation
Explore with Pulumi AI
Import
Federation can be imported using any of these accepted formats
$ 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}}
Example Usage
Dataproc Metastore Federation Basic
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var defaultMetastoreService = new Gcp.Dataproc.MetastoreService("defaultMetastoreService", new()
{
ServiceId = "",
Location = "us-central1",
Tier = "DEVELOPER",
HiveMetastoreConfig = new Gcp.Dataproc.Inputs.MetastoreServiceHiveMetastoreConfigArgs
{
Version = "3.1.2",
EndpointProtocol = "GRPC",
},
}, new CustomResourceOptions
{
Provider = google_beta,
});
var defaultMetastoreFederation = new Gcp.Dataproc.MetastoreFederation("defaultMetastoreFederation", new()
{
Location = "us-central1",
FederationId = "",
Version = "3.1.2",
BackendMetastores = new[]
{
new Gcp.Dataproc.Inputs.MetastoreFederationBackendMetastoreArgs
{
Rank = "1",
Name = defaultMetastoreService.Id,
MetastoreType = "DATAPROC_METASTORE",
},
},
}, new CustomResourceOptions
{
Provider = google_beta,
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/dataproc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
defaultMetastoreService, err := dataproc.NewMetastoreService(ctx, "defaultMetastoreService", &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"),
},
}, pulumi.Provider(google_beta))
if err != nil {
return err
}
_, err = dataproc.NewMetastoreFederation(ctx, "defaultMetastoreFederation", &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"),
},
},
}, pulumi.Provider(google_beta))
if err != nil {
return err
}
return nil
})
}
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 com.pulumi.resources.CustomResourceOptions;
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(), CustomResourceOptions.builder()
.provider(google_beta)
.build());
var defaultMetastoreFederation = new MetastoreFederation("defaultMetastoreFederation", MetastoreFederationArgs.builder()
.location("us-central1")
.federationId("")
.version("3.1.2")
.backendMetastores(MetastoreFederationBackendMetastoreArgs.builder()
.rank("1")
.name(defaultMetastoreService.id())
.metastoreType("DATAPROC_METASTORE")
.build())
.build(), CustomResourceOptions.builder()
.provider(google_beta)
.build());
}
}
import pulumi
import pulumi_gcp as gcp
default_metastore_service = gcp.dataproc.MetastoreService("defaultMetastoreService",
service_id="",
location="us-central1",
tier="DEVELOPER",
hive_metastore_config=gcp.dataproc.MetastoreServiceHiveMetastoreConfigArgs(
version="3.1.2",
endpoint_protocol="GRPC",
),
opts=pulumi.ResourceOptions(provider=google_beta))
default_metastore_federation = gcp.dataproc.MetastoreFederation("defaultMetastoreFederation",
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",
)],
opts=pulumi.ResourceOptions(provider=google_beta))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const defaultMetastoreService = new gcp.dataproc.MetastoreService("defaultMetastoreService", {
serviceId: "",
location: "us-central1",
tier: "DEVELOPER",
hiveMetastoreConfig: {
version: "3.1.2",
endpointProtocol: "GRPC",
},
}, {
provider: google_beta,
});
const defaultMetastoreFederation = new gcp.dataproc.MetastoreFederation("defaultMetastoreFederation", {
location: "us-central1",
federationId: "",
version: "3.1.2",
backendMetastores: [{
rank: "1",
name: defaultMetastoreService.id,
metastoreType: "DATAPROC_METASTORE",
}],
}, {
provider: google_beta,
});
resources:
defaultMetastoreFederation:
type: gcp:dataproc:MetastoreFederation
properties:
location: us-central1
federationId:
version: 3.1.2
backendMetastores:
- rank: '1'
name: ${defaultMetastoreService.id}
metastoreType: DATAPROC_METASTORE
options:
provider: ${["google-beta"]}
defaultMetastoreService:
type: gcp:dataproc:MetastoreService
properties:
serviceId:
location: us-central1
tier: DEVELOPER
hiveMetastoreConfig:
version: 3.1.2
endpointProtocol: GRPC
options:
provider: ${["google-beta"]}
Dataproc Metastore Federation Bigquery
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var defaultMetastoreService = new Gcp.Dataproc.MetastoreService("defaultMetastoreService", new()
{
ServiceId = "",
Location = "us-central1",
Tier = "DEVELOPER",
HiveMetastoreConfig = new Gcp.Dataproc.Inputs.MetastoreServiceHiveMetastoreConfigArgs
{
Version = "3.1.2",
EndpointProtocol = "GRPC",
},
}, new CustomResourceOptions
{
Provider = google_beta,
});
var project = Gcp.Organizations.GetProject.Invoke();
var defaultMetastoreFederation = new Gcp.Dataproc.MetastoreFederation("defaultMetastoreFederation", 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",
},
},
}, new CustomResourceOptions
{
Provider = google_beta,
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/dataproc"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
defaultMetastoreService, err := dataproc.NewMetastoreService(ctx, "defaultMetastoreService", &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"),
},
}, pulumi.Provider(google_beta))
if err != nil {
return err
}
project, err := organizations.LookupProject(ctx, nil, nil)
if err != nil {
return err
}
_, err = dataproc.NewMetastoreFederation(ctx, "defaultMetastoreFederation", &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"),
},
},
}, pulumi.Provider(google_beta))
if err != nil {
return err
}
return nil
})
}
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 com.pulumi.resources.CustomResourceOptions;
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(), CustomResourceOptions.builder()
.provider(google_beta)
.build());
final var project = OrganizationsFunctions.getProject();
var defaultMetastoreFederation = new MetastoreFederation("defaultMetastoreFederation", 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(), CustomResourceOptions.builder()
.provider(google_beta)
.build());
}
}
import pulumi
import pulumi_gcp as gcp
default_metastore_service = gcp.dataproc.MetastoreService("defaultMetastoreService",
service_id="",
location="us-central1",
tier="DEVELOPER",
hive_metastore_config=gcp.dataproc.MetastoreServiceHiveMetastoreConfigArgs(
version="3.1.2",
endpoint_protocol="GRPC",
),
opts=pulumi.ResourceOptions(provider=google_beta))
project = gcp.organizations.get_project()
default_metastore_federation = gcp.dataproc.MetastoreFederation("defaultMetastoreFederation",
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",
),
],
opts=pulumi.ResourceOptions(provider=google_beta))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const defaultMetastoreService = new gcp.dataproc.MetastoreService("defaultMetastoreService", {
serviceId: "",
location: "us-central1",
tier: "DEVELOPER",
hiveMetastoreConfig: {
version: "3.1.2",
endpointProtocol: "GRPC",
},
}, {
provider: google_beta,
});
const project = gcp.organizations.getProject({});
const defaultMetastoreFederation = new gcp.dataproc.MetastoreFederation("defaultMetastoreFederation", {
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",
},
],
}, {
provider: google_beta,
});
resources:
defaultMetastoreFederation:
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
options:
provider: ${["google-beta"]}
defaultMetastoreService:
type: gcp:dataproc:MetastoreService
properties:
serviceId:
location: us-central1
tier: DEVELOPER
hiveMetastoreConfig:
version: 3.1.2
endpointProtocol: GRPC
options:
provider: ${["google-beta"]}
variables:
project:
fn::invoke:
Function: gcp:organizations:getProject
Arguments: {}
Create MetastoreFederation Resource
new MetastoreFederation(name: string, args: MetastoreFederationArgs, opts?: CustomResourceOptions);@overload
def MetastoreFederation(resource_name: str,
opts: Optional[ResourceOptions] = None,
backend_metastores: Optional[Sequence[MetastoreFederationBackendMetastoreArgs]] = None,
federation_id: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
project: Optional[str] = None,
version: Optional[str] = None)
@overload
def MetastoreFederation(resource_name: str,
args: MetastoreFederationArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Backend
Metastores List<MetastoreFederation Backend Metastore> 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 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.
- Location string
The location where the metastore federation should reside.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Backend
Metastores []MetastoreFederation Backend Metastore Args 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 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.
- Location string
The location where the metastore federation should reside.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- backend
Metastores List<MetastoreFederation Backend Metastore> 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 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.
- location String
The location where the metastore federation should reside.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- backend
Metastores MetastoreFederation Backend Metastore[] 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 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.
- location string
The location where the metastore federation should reside.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- backend_
metastores Sequence[MetastoreFederation Backend Metastore Args] 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.
- location str
The location where the metastore federation should reside.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- backend
Metastores 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.
- federation
Id 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.
- location String
The location where the metastore federation should reside.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the MetastoreFederation resource produces the following output properties:
- Endpoint
Uri 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 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}
- State string
The current state of the metastore federation.
- State
Message string Additional information about the current state of the metastore federation, if available.
- Uid string
The globally unique resource identifier of the metastore federation.
- Endpoint
Uri 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 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}
- State string
The current state of the metastore federation.
- State
Message string Additional information about the current state of the metastore federation, if available.
- Uid string
The globally unique resource identifier of the metastore federation.
- endpoint
Uri 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 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}
- state String
The current state of the metastore federation.
- state
Message String Additional information about the current state of the metastore federation, if available.
- uid String
The globally unique resource identifier of the metastore federation.
- endpoint
Uri 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 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}
- state string
The current state of the metastore federation.
- state
Message string Additional information about the current state of the metastore federation, if available.
- uid string
The globally unique resource identifier of the metastore federation.
- 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 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}
- 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.
- endpoint
Uri 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 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}
- state String
The current state of the metastore federation.
- state
Message 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,
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,
state: Optional[str] = None,
state_message: Optional[str] = None,
uid: Optional[str] = None,
version: Optional[str] = None) -> MetastoreFederationfunc 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.
- Backend
Metastores List<MetastoreFederation Backend Metastore> 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.
- Endpoint
Uri string The URI of the endpoint used to access the metastore federation.
- Federation
Id 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.
- Location string
The location where the metastore federation should reside.
- 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}
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- State string
The current state of the metastore federation.
- State
Message 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 []MetastoreFederation Backend Metastore Args 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.
- Endpoint
Uri string The URI of the endpoint used to access the metastore federation.
- Federation
Id 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.
- Location string
The location where the metastore federation should reside.
- 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}
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- State string
The current state of the metastore federation.
- State
Message 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 List<MetastoreFederation Backend Metastore> 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.
- endpoint
Uri String The URI of the endpoint used to access the metastore federation.
- federation
Id 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.
- location String
The location where the metastore federation should reside.
- 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}
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- state String
The current state of the metastore federation.
- state
Message 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 MetastoreFederation Backend Metastore[] 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.
- endpoint
Uri string The URI of the endpoint used to access the metastore federation.
- federation
Id 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.
- location string
The location where the metastore federation should reside.
- 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}
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- state string
The current state of the metastore federation.
- state
Message 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[MetastoreFederation Backend Metastore Args] 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.
- 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.
- location str
The location where the metastore federation should reside.
- 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}
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- backend
Metastores 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.
- endpoint
Uri String The URI of the endpoint used to access the metastore federation.
- federation
Id 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.
- location String
The location where the metastore federation should reside.
- 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}
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- state String
The current state of the metastore federation.
- state
Message 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
- Metastore
Type 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 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 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 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.
- metastore
Type 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.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-betaTerraform Provider.