Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. metastore
  5. metastore/v1alpha
  6. Federation

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.metastore/v1alpha.Federation

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a metastore federation in a project and location.

Create Federation Resource

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

Constructor syntax

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

@overload
def Federation(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               federation_id: Optional[str] = None,
               backend_metastores: Optional[Mapping[str, str]] = None,
               labels: Optional[Mapping[str, str]] = None,
               location: Optional[str] = None,
               name: Optional[str] = None,
               project: Optional[str] = None,
               request_id: Optional[str] = None,
               version: Optional[str] = None)
func NewFederation(ctx *Context, name string, args FederationArgs, opts ...ResourceOption) (*Federation, error)
public Federation(string name, FederationArgs args, CustomResourceOptions? opts = null)
public Federation(String name, FederationArgs args)
public Federation(String name, FederationArgs args, CustomResourceOptions options)

type: google-native:metastore/v1alpha:Federation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var google_nativeFederationResource = new GoogleNative.Metastore.V1Alpha.Federation("google-nativeFederationResource", new()
{
    FederationId = "string",
    BackendMetastores = 
    {
        { "string", "string" },
    },
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    Project = "string",
    RequestId = "string",
    Version = "string",
});
Copy
example, err := metastorev1alpha.NewFederation(ctx, "google-nativeFederationResource", &metastorev1alpha.FederationArgs{
	FederationId: pulumi.String("string"),
	BackendMetastores: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location:  pulumi.String("string"),
	Name:      pulumi.String("string"),
	Project:   pulumi.String("string"),
	RequestId: pulumi.String("string"),
	Version:   pulumi.String("string"),
})
Copy
var google_nativeFederationResource = new Federation("google-nativeFederationResource", FederationArgs.builder()
    .federationId("string")
    .backendMetastores(Map.of("string", "string"))
    .labels(Map.of("string", "string"))
    .location("string")
    .name("string")
    .project("string")
    .requestId("string")
    .version("string")
    .build());
Copy
google_native_federation_resource = google_native.metastore.v1alpha.Federation("google-nativeFederationResource",
    federation_id="string",
    backend_metastores={
        "string": "string",
    },
    labels={
        "string": "string",
    },
    location="string",
    name="string",
    project="string",
    request_id="string",
    version="string")
Copy
const google_nativeFederationResource = new google_native.metastore.v1alpha.Federation("google-nativeFederationResource", {
    federationId: "string",
    backendMetastores: {
        string: "string",
    },
    labels: {
        string: "string",
    },
    location: "string",
    name: "string",
    project: "string",
    requestId: "string",
    version: "string",
});
Copy
type: google-native:metastore/v1alpha:Federation
properties:
    backendMetastores:
        string: string
    federationId: string
    labels:
        string: string
    location: string
    name: string
    project: string
    requestId: string
    version: string
Copy

Federation Resource Properties

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

Inputs

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

The Federation resource accepts the following input properties:

FederationId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
BackendMetastores Dictionary<string, string>
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.
Labels Dictionary<string, string>
User-defined labels for the metastore federation.
Location Changes to this property will trigger replacement. string
Name string
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
Project Changes to this property will trigger replacement. string
RequestId string
Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
Version string
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
FederationId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
BackendMetastores map[string]string
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.
Labels map[string]string
User-defined labels for the metastore federation.
Location Changes to this property will trigger replacement. string
Name string
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
Project Changes to this property will trigger replacement. string
RequestId string
Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
Version string
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
federationId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
backendMetastores Map<String,String>
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.
labels Map<String,String>
User-defined labels for the metastore federation.
location Changes to this property will trigger replacement. String
name String
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
project Changes to this property will trigger replacement. String
requestId String
Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
version String
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
federationId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
backendMetastores {[key: string]: string}
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.
labels {[key: string]: string}
User-defined labels for the metastore federation.
location Changes to this property will trigger replacement. string
name string
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
project Changes to this property will trigger replacement. string
requestId string
Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
version string
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
federation_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
backend_metastores Mapping[str, str]
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.
labels Mapping[str, str]
User-defined labels for the metastore federation.
location Changes to this property will trigger replacement. str
name str
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
project Changes to this property will trigger replacement. str
request_id str
Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
version str
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
federationId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
backendMetastores Map<String>
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.
labels Map<String>
User-defined labels for the metastore federation.
location Changes to this property will trigger replacement. String
name String
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
project Changes to this property will trigger replacement. String
requestId String
Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
version String
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.

Outputs

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

CreateTime string
The time when the metastore federation was created.
EndpointUri string
The federation endpoint.
Id string
The provider-assigned unique ID for this managed resource.
State string
The current state of the federation.
StateMessage string
Additional information about the current state of the metastore federation, if available.
Uid string
The globally unique resource identifier of the metastore federation.
UpdateTime string
The time when the metastore federation was last updated.
CreateTime string
The time when the metastore federation was created.
EndpointUri string
The federation endpoint.
Id string
The provider-assigned unique ID for this managed resource.
State string
The current state of the federation.
StateMessage string
Additional information about the current state of the metastore federation, if available.
Uid string
The globally unique resource identifier of the metastore federation.
UpdateTime string
The time when the metastore federation was last updated.
createTime String
The time when the metastore federation was created.
endpointUri String
The federation endpoint.
id String
The provider-assigned unique ID for this managed resource.
state String
The current state of the federation.
stateMessage String
Additional information about the current state of the metastore federation, if available.
uid String
The globally unique resource identifier of the metastore federation.
updateTime String
The time when the metastore federation was last updated.
createTime string
The time when the metastore federation was created.
endpointUri string
The federation endpoint.
id string
The provider-assigned unique ID for this managed resource.
state string
The current state of the federation.
stateMessage string
Additional information about the current state of the metastore federation, if available.
uid string
The globally unique resource identifier of the metastore federation.
updateTime string
The time when the metastore federation was last updated.
create_time str
The time when the metastore federation was created.
endpoint_uri str
The federation endpoint.
id str
The provider-assigned unique ID for this managed resource.
state str
The current state of the federation.
state_message str
Additional information about the current state of the metastore federation, if available.
uid str
The globally unique resource identifier of the metastore federation.
update_time str
The time when the metastore federation was last updated.
createTime String
The time when the metastore federation was created.
endpointUri String
The federation endpoint.
id String
The provider-assigned unique ID for this managed resource.
state String
The current state of the federation.
stateMessage String
Additional information about the current state of the metastore federation, if available.
uid String
The globally unique resource identifier of the metastore federation.
updateTime String
The time when the metastore federation was last updated.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native