All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.compute.kotlin.SshPublicKey.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.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 [SshPublicKey].
 */
@PulumiTagMarker
public class SshPublicKeyResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: SshPublicKeyArgs = SshPublicKeyArgs()

    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 SshPublicKeyArgsBuilder.() -> Unit) {
        val builder = SshPublicKeyArgsBuilder()
        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(): SshPublicKey {
        val builtJavaResource = com.pulumi.azure.compute.SshPublicKey(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return SshPublicKey(builtJavaResource)
    }
}

/**
 * Manages a SSH Public Key.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * import * as std from "@pulumi/std";
 * const example = new azure.compute.SshPublicKey("example", {
 *     name: "example",
 *     resourceGroupName: "example",
 *     location: "West Europe",
 *     publicKey: std.file({
 *         input: "~/.ssh/id_rsa.pub",
 *     }).then(invoke => invoke.result),
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * import pulumi_std as std
 * example = azure.compute.SshPublicKey("example",
 *     name="example",
 *     resource_group_name="example",
 *     location="West Europe",
 *     public_key=std.file(input="~/.ssh/id_rsa.pub").result)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * using Std = Pulumi.Std;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Compute.SshPublicKey("example", new()
 *     {
 *         Name = "example",
 *         ResourceGroupName = "example",
 *         Location = "West Europe",
 *         PublicKey = Std.File.Invoke(new()
 *         {
 *             Input = "~/.ssh/id_rsa.pub",
 *         }).Apply(invoke => invoke.Result),
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
 * 	"github.com/pulumi/pulumi-std/sdk/go/std"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		invokeFile, err := std.File(ctx, &std.FileArgs{
 * 			Input: "~/.ssh/id_rsa.pub",
 * 		}, nil)
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = compute.NewSshPublicKey(ctx, "example", &compute.SshPublicKeyArgs{
 * 			Name:              pulumi.String("example"),
 * 			ResourceGroupName: pulumi.String("example"),
 * 			Location:          pulumi.String("West Europe"),
 * 			PublicKey:         pulumi.String(invokeFile.Result),
 * 		})
 * 		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.azure.compute.SshPublicKey;
 * import com.pulumi.azure.compute.SshPublicKeyArgs;
 * 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 example = new SshPublicKey("example", SshPublicKeyArgs.builder()
 *             .name("example")
 *             .resourceGroupName("example")
 *             .location("West Europe")
 *             .publicKey(StdFunctions.file(FileArgs.builder()
 *                 .input("~/.ssh/id_rsa.pub")
 *                 .build()).result())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:compute:SshPublicKey
 *     properties:
 *       name: example
 *       resourceGroupName: example
 *       location: West Europe
 *       publicKey:
 *         fn::invoke:
 *           Function: std:file
 *           Arguments:
 *             input: ~/.ssh/id_rsa.pub
 *           Return: result
 * ```
 * 
 * ## Import
 * SSH Public Keys can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:compute/sshPublicKey:SshPublicKey example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName1
 * ```
 */
public class SshPublicKey internal constructor(
    override val javaResource: com.pulumi.azure.compute.SshPublicKey,
) : KotlinCustomResource(javaResource, SshPublicKeyMapper) {
    /**
     * The Azure Region where the SSH Public Key should exist. Changing this forces a new SSH Public Key to be created.
     */
    public val location: Output
        get() = javaResource.location().applyValue({ args0 -> args0 })

    /**
     * The name which should be used for this SSH Public Key. Changing this forces a new SSH Public Key to be created.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * SSH public key used to authenticate to a virtual machine through ssh. the provided public key needs to be at least 2048-bit and in ssh-rsa format.
     */
    public val publicKey: Output
        get() = javaResource.publicKey().applyValue({ args0 -> args0 })

    /**
     * The name of the Resource Group where the SSH Public Key should exist. Changing this forces a new SSH Public Key to be created.
     */
    public val resourceGroupName: Output
        get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })

    /**
     * A mapping of tags which should be assigned to the SSH Public Key.
     */
    public val tags: Output>?
        get() = javaResource.tags().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })
}

public object SshPublicKeyMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.compute.SshPublicKey::class == javaResource::class

    override fun map(javaResource: Resource): SshPublicKey = SshPublicKey(
        javaResource as
            com.pulumi.azure.compute.SshPublicKey,
    )
}

/**
 * @see [SshPublicKey].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [SshPublicKey].
 */
public suspend fun sshPublicKey(
    name: String,
    block: suspend SshPublicKeyResourceBuilder.() -> Unit,
): SshPublicKey {
    val builder = SshPublicKeyResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [SshPublicKey].
 * @param name The _unique_ name of the resulting resource.
 */
public fun sshPublicKey(name: String): SshPublicKey {
    val builder = SshPublicKeyResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy