Google Cloud v8.25.1, Apr 9 25

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi

gcp.compute.ProjectMetadata

Explore with Pulumi AI

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi

Note: This resource manages all project-level metadata including project-level ssh keys. Keys unset in config but set on the server will be removed. If you want to manage only single key/value pairs within the project metadata rather than the entire set, then use google_compute_project_metadata_item.

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

const _default = new gcp.compute.ProjectMetadata("default", {metadata: {
    foo: "bar",
    fizz: "buzz",
    "13": "42",
}});

import pulumi
import pulumi_gcp as gcp

default = gcp.compute.ProjectMetadata("default", metadata={
    "foo": "bar",
    "fizz": "buzz",
    "13": "42",
})

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewProjectMetadata(ctx, "default", &compute.ProjectMetadataArgs{
			Metadata: pulumi.StringMap{
				"foo":  pulumi.String("bar"),
				"fizz": pulumi.String("buzz"),
				"13":   pulumi.String("42"),
			},
		})
		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 @default = new Gcp.Compute.ProjectMetadata("default", new()
    {
        Metadata = 
        {
            { "foo", "bar" },
            { "fizz", "buzz" },
            { "13", "42" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ProjectMetadata;
import com.pulumi.gcp.compute.ProjectMetadataArgs;
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 default_ = new ProjectMetadata("default", ProjectMetadataArgs.builder()
            .metadata(Map.ofEntries(
                Map.entry("foo", "bar"),
                Map.entry("fizz", "buzz"),
                Map.entry("13", "42")
            ))
            .build());

    }
}

resources:
  default:
    type: gcp:compute:ProjectMetadata
    properties:
      metadata:
        foo: bar
        fizz: buzz
        '13': '42'

Adding An SSH Key

TypeScript
Python
Go
C#
Java
YAML

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

//A key set in project metadata is propagated to every instance in the project.
//This resource configuration is prone to causing frequent diffs as Google adds SSH Keys when the SSH Button is pressed in the console.
//It is better to use OS Login instead.
const mySshKey = new gcp.compute.ProjectMetadata("my_ssh_key", {metadata: {
    "ssh-keys": `      dev:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT dev
      foo:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT bar
`,
}});

import pulumi
import pulumi_gcp as gcp

#A key set in project metadata is propagated to every instance in the project.
#This resource configuration is prone to causing frequent diffs as Google adds SSH Keys when the SSH Button is pressed in the console.
#It is better to use OS Login instead.
my_ssh_key = gcp.compute.ProjectMetadata("my_ssh_key", metadata={
    "ssh-keys": """      dev:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT dev
      foo:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT bar
""",
})

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// A key set in project metadata is propagated to every instance in the project.
		// This resource configuration is prone to causing frequent diffs as Google adds SSH Keys when the SSH Button is pressed in the console.
		// It is better to use OS Login instead.
		_, err := compute.NewProjectMetadata(ctx, "my_ssh_key", &compute.ProjectMetadataArgs{
			Metadata: pulumi.StringMap{
				"ssh-keys": pulumi.String("      dev:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT dev\n      foo:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT bar\n"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    //A key set in project metadata is propagated to every instance in the project.
    //This resource configuration is prone to causing frequent diffs as Google adds SSH Keys when the SSH Button is pressed in the console.
    //It is better to use OS Login instead.
    var mySshKey = new Gcp.Compute.ProjectMetadata("my_ssh_key", new()
    {
        Metadata = 
        {
            { "ssh-keys", @"      dev:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT dev
      foo:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT bar
" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ProjectMetadata;
import com.pulumi.gcp.compute.ProjectMetadataArgs;
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) {
        //A key set in project metadata is propagated to every instance in the project.
        //This resource configuration is prone to causing frequent diffs as Google adds SSH Keys when the SSH Button is pressed in the console.
        //It is better to use OS Login instead.
        var mySshKey = new ProjectMetadata("mySshKey", ProjectMetadataArgs.builder()
            .metadata(Map.of("ssh-keys", """
      dev:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT dev
      foo:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT bar
            """))
            .build());

    }
}

resources:
  # /*
  # A key set in project metadata is propagated to every instance in the project.
  # This resource configuration is prone to causing frequent diffs as Google adds SSH Keys when the SSH Button is pressed in the console.
  # It is better to use OS Login instead.
  # */
  mySshKey:
    type: gcp:compute:ProjectMetadata
    name: my_ssh_key
    properties:
      metadata:
        ssh-keys: |2
                dev:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT dev
                foo:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT bar

Create ProjectMetadata Resource

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

Constructor syntax

TypeScript
Python
Go
C#
Java
YAML

new ProjectMetadata(name: string, args: ProjectMetadataArgs, opts?: CustomResourceOptions);

@overload
def ProjectMetadata(resource_name: str,
                    args: ProjectMetadataArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ProjectMetadata(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    metadata: Optional[Mapping[str, str]] = None,
                    project: Optional[str] = None)

func NewProjectMetadata(ctx *Context, name string, args ProjectMetadataArgs, opts ...ResourceOption) (*ProjectMetadata, error)

public ProjectMetadata(string name, ProjectMetadataArgs args, CustomResourceOptions? opts = null)

public ProjectMetadata(String name, ProjectMetadataArgs args)
public ProjectMetadata(String name, ProjectMetadataArgs args, CustomResourceOptions options)

type: gcp:compute:ProjectMetadata
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 ProjectMetadataArgs: 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 ProjectMetadataArgs: 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 ProjectMetadataArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProjectMetadataArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ProjectMetadataArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var projectMetadataResource = new Gcp.Compute.ProjectMetadata("projectMetadataResource", new()
{
    Metadata = 
    {
        { "string", "string" },
    },
    Project = "string",
});

example, err := compute.NewProjectMetadata(ctx, "projectMetadataResource", &compute.ProjectMetadataArgs{
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

var projectMetadataResource = new ProjectMetadata("projectMetadataResource", ProjectMetadataArgs.builder()
    .metadata(Map.of("string", "string"))
    .project("string")
    .build());

project_metadata_resource = gcp.compute.ProjectMetadata("projectMetadataResource",
    metadata={
        "string": "string",
    },
    project="string")

const projectMetadataResource = new gcp.compute.ProjectMetadata("projectMetadataResource", {
    metadata: {
        string: "string",
    },
    project: "string",
});

type: gcp:compute:ProjectMetadata
properties:
    metadata:
        string: string
    project: string

ProjectMetadata 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 ProjectMetadata resource accepts the following input properties:

Metadata Dictionary<string, string>: A series of key value pairs.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Metadata map[string]string: A series of key value pairs.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

metadata Map<String,String>: A series of key value pairs.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

metadata {[key: string]: string}: A series of key value pairs.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

metadata Mapping[str, str]: A series of key value pairs.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

metadata Map<String>: A series of key value pairs.
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 ProjectMetadata resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing ProjectMetadata Resource

Get an existing ProjectMetadata resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: ProjectMetadataState, opts?: CustomResourceOptions): ProjectMetadata

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        metadata: Optional[Mapping[str, str]] = None,
        project: Optional[str] = None) -> ProjectMetadata

func GetProjectMetadata(ctx *Context, name string, id IDInput, state *ProjectMetadataState, opts ...ResourceOption) (*ProjectMetadata, error)

public static ProjectMetadata Get(string name, Input<string> id, ProjectMetadataState? state, CustomResourceOptions? opts = null)

public static ProjectMetadata get(String name, Output<String> id, ProjectMetadataState state, CustomResourceOptions options)

resources:  _:    type: gcp:compute:ProjectMetadata    get:      id: ${id}

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:

Metadata Dictionary<string, string>: A series of key value pairs.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Metadata map[string]string: A series of key value pairs.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

metadata Map<String,String>: A series of key value pairs.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

metadata {[key: string]: string}: A series of key value pairs.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

metadata Mapping[str, str]: A series of key value pairs.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

metadata Map<String>: A series of key value pairs.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Import

Project metadata can be imported using the project ID:

{{project_id}}

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

$ pulumi import gcp:compute/projectMetadata:ProjectMetadata default {{project_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.

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.compute.ProjectMetadata

On this page

On this page

Example Usage

Adding An SSH Key

Create ProjectMetadata Resource

Constructor syntax

Parameters

Constructor example

ProjectMetadata Resource Properties

Inputs

Outputs

Look up Existing ProjectMetadata Resource

Import

Package Details

On this page

On this page