com.pulumi.gcp.compute.kotlin.ProjectMetadata.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.compute.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [ProjectMetadata].
*/
@PulumiTagMarker
public class ProjectMetadataResourceBuilder internal constructor() {
public var name: String? = null
public var args: ProjectMetadataArgs = ProjectMetadataArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend ProjectMetadataArgsBuilder.() -> Unit) {
val builder = ProjectMetadataArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): ProjectMetadata {
val builtJavaResource = com.pulumi.gcp.compute.ProjectMetadata(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ProjectMetadata(builtJavaResource)
}
}
/**
* /*
* Authoritatively manages metadata common to all instances for a project in GCE. For more information see
* [the official documentation](https://cloud.google.com/compute/docs/storing-retrieving-metadata)
* and
* [API](https://cloud.google.com/compute/docs/reference/latest/projects/setCommonInstanceMetadata).
* > **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.
* ## Example Usage
*
* ```typescript
* 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",
* }});
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* default = gcp.compute.ProjectMetadata("default", metadata={
* "foo": "bar",
* "fizz": "buzz",
* "13": "42",
* })
* ```
* ```csharp
* 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" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* resources:
* default:
* type: gcp:compute:ProjectMetadata
* properties:
* metadata:
* foo: bar
* fizz: buzz
* '13': '42'
* ```
*
* ### Adding An SSH Key
*
* ```typescript
* 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
* `,
* }});
* ```
* ```python
* 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
* """,
* })
* ```
* ```csharp
* 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
* " },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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
* ```
*
* ## 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:
* ```sh
* $ pulumi import gcp:compute/projectMetadata:ProjectMetadata default {{project_id}}
* ```
* */
*/
public class ProjectMetadata internal constructor(
override val javaResource: com.pulumi.gcp.compute.ProjectMetadata,
) : KotlinCustomResource(javaResource, ProjectMetadataMapper) {
/**
* A series of key value pairs.
* - - -
*/
public val metadata: Output>
get() = javaResource.metadata().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The ID of the project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
}
public object ProjectMetadataMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.compute.ProjectMetadata::class == javaResource::class
override fun map(javaResource: Resource): ProjectMetadata = ProjectMetadata(
javaResource as
com.pulumi.gcp.compute.ProjectMetadata,
)
}
/**
* @see [ProjectMetadata].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ProjectMetadata].
*/
public suspend fun projectMetadata(
name: String,
block: suspend ProjectMetadataResourceBuilder.() -> Unit,
): ProjectMetadata {
val builder = ProjectMetadataResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ProjectMetadata].
* @param name The _unique_ name of the resulting resource.
*/
public fun projectMetadata(name: String): ProjectMetadata {
val builder = ProjectMetadataResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy