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

com.pulumi.gcp.firebase.kotlin.AppCheckDebugToken.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 8.12.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.firebase.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

/**
 * Builder for [AppCheckDebugToken].
 */
@PulumiTagMarker
public class AppCheckDebugTokenResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: AppCheckDebugTokenArgs = AppCheckDebugTokenArgs()

    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 AppCheckDebugTokenArgsBuilder.() -> Unit) {
        val builder = AppCheckDebugTokenArgsBuilder()
        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(): AppCheckDebugToken {
        val builtJavaResource = com.pulumi.gcp.firebase.AppCheckDebugToken(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return AppCheckDebugToken(builtJavaResource)
    }
}

/**
 * A debug token is a secret used during the development or integration testing of
 * an app. It essentially allows the development or integration testing to bypass
 * app attestation while still allowing App Check to enforce protection on supported
 * production Firebase services.
 * To get more information about DebugToken, see:
 * * [API documentation](https://firebase.google.com/docs/reference/appcheck/rest/v1/projects.apps.debugTokens)
 * * How-to Guides
 *     * [Official Documentation](https://firebase.google.com/docs/app-check)
 * ## Example Usage
 * ### Firebase App Check Debug Token Basic
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * import * as time from "@pulumi/time";
 * const _default = new gcp.firebase.WebApp("default", {
 *     project: "my-project-name",
 *     displayName: "Web App for debug token",
 * });
 * // It takes a while for App Check to recognize the new app
 * // If your app already exists, you don't have to wait 30 seconds.
 * const wait30s = new time.index.Sleep("wait_30s", {createDuration: "30s"});
 * const defaultAppCheckDebugToken = new gcp.firebase.AppCheckDebugToken("default", {
 *     project: "my-project-name",
 *     appId: _default.appId,
 *     displayName: "Debug Token",
 *     token: "00000000-AAAA-BBBB-CCCC-000000000000",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * import pulumi_time as time
 * default = gcp.firebase.WebApp("default",
 *     project="my-project-name",
 *     display_name="Web App for debug token")
 * # It takes a while for App Check to recognize the new app
 * # If your app already exists, you don't have to wait 30 seconds.
 * wait30s = time.index.Sleep("wait_30s", create_duration=30s)
 * default_app_check_debug_token = gcp.firebase.AppCheckDebugToken("default",
 *     project="my-project-name",
 *     app_id=default.app_id,
 *     display_name="Debug Token",
 *     token="00000000-AAAA-BBBB-CCCC-000000000000")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * using Time = Pulumi.Time;
 * return await Deployment.RunAsync(() =>
 * {
 *     var @default = new Gcp.Firebase.WebApp("default", new()
 *     {
 *         Project = "my-project-name",
 *         DisplayName = "Web App for debug token",
 *     });
 *     // It takes a while for App Check to recognize the new app
 *     // If your app already exists, you don't have to wait 30 seconds.
 *     var wait30s = new Time.Index.Sleep("wait_30s", new()
 *     {
 *         CreateDuration = "30s",
 *     });
 *     var defaultAppCheckDebugToken = new Gcp.Firebase.AppCheckDebugToken("default", new()
 *     {
 *         Project = "my-project-name",
 *         AppId = @default.AppId,
 *         DisplayName = "Debug Token",
 *         Token = "00000000-AAAA-BBBB-CCCC-000000000000",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/firebase"
 * 	"github.com/pulumi/pulumi-time/sdk/go/time"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := firebase.NewWebApp(ctx, "default", &firebase.WebAppArgs{
 * 			Project:     pulumi.String("my-project-name"),
 * 			DisplayName: pulumi.String("Web App for debug token"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		// It takes a while for App Check to recognize the new app
 * 		// If your app already exists, you don't have to wait 30 seconds.
 * 		_, err = time.NewSleep(ctx, "wait_30s", &time.SleepArgs{
 * 			CreateDuration: "30s",
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = firebase.NewAppCheckDebugToken(ctx, "default", &firebase.AppCheckDebugTokenArgs{
 * 			Project:     pulumi.String("my-project-name"),
 * 			AppId:       _default.AppId,
 * 			DisplayName: pulumi.String("Debug Token"),
 * 			Token:       pulumi.String("00000000-AAAA-BBBB-CCCC-000000000000"),
 * 		})
 * 		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.firebase.WebApp;
 * import com.pulumi.gcp.firebase.WebAppArgs;
 * import com.pulumi.time.sleep;
 * import com.pulumi.time.SleepArgs;
 * import com.pulumi.gcp.firebase.AppCheckDebugToken;
 * import com.pulumi.gcp.firebase.AppCheckDebugTokenArgs;
 * 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 WebApp("default", WebAppArgs.builder()
 *             .project("my-project-name")
 *             .displayName("Web App for debug token")
 *             .build());
 *         // It takes a while for App Check to recognize the new app
 *         // If your app already exists, you don't have to wait 30 seconds.
 *         var wait30s = new Sleep("wait30s", SleepArgs.builder()
 *             .createDuration("30s")
 *             .build());
 *         var defaultAppCheckDebugToken = new AppCheckDebugToken("defaultAppCheckDebugToken", AppCheckDebugTokenArgs.builder()
 *             .project("my-project-name")
 *             .appId(default_.appId())
 *             .displayName("Debug Token")
 *             .token("00000000-AAAA-BBBB-CCCC-000000000000")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   default:
 *     type: gcp:firebase:WebApp
 *     properties:
 *       project: my-project-name
 *       displayName: Web App for debug token
 *   # It takes a while for App Check to recognize the new app
 *   # If your app already exists, you don't have to wait 30 seconds.
 *   wait30s:
 *     type: time:sleep
 *     name: wait_30s
 *     properties:
 *       createDuration: 30s
 *   defaultAppCheckDebugToken:
 *     type: gcp:firebase:AppCheckDebugToken
 *     name: default
 *     properties:
 *       project: my-project-name
 *       appId: ${default.appId}
 *       displayName: Debug Token
 *       token: 00000000-AAAA-BBBB-CCCC-000000000000
 * ```
 * 
 * ## Import
 * DebugToken can be imported using any of these accepted formats:
 * * `projects/{{project}}/apps/{{app_id}}/debugTokens/{{debug_token_id}}`
 * * `{{project}}/{{app_id}}/{{debug_token_id}}`
 * * `{{app_id}}/{{debug_token_id}}`
 * When using the `pulumi import` command, DebugToken can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:firebase/appCheckDebugToken:AppCheckDebugToken default projects/{{project}}/apps/{{app_id}}/debugTokens/{{debug_token_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:firebase/appCheckDebugToken:AppCheckDebugToken default {{project}}/{{app_id}}/{{debug_token_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:firebase/appCheckDebugToken:AppCheckDebugToken default {{app_id}}/{{debug_token_id}}
 * ```
 */
public class AppCheckDebugToken internal constructor(
    override val javaResource: com.pulumi.gcp.firebase.AppCheckDebugToken,
) : KotlinCustomResource(javaResource, AppCheckDebugTokenMapper) {
    /**
     * The ID of a
     * [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id),
     * [Apple App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.iosApps#IosApp.FIELDS.app_id),
     * or [Android App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.androidApps#AndroidApp.FIELDS.app_id)
     * - - -
     */
    public val appId: Output
        get() = javaResource.appId().applyValue({ args0 -> args0 })

    /**
     * The last segment of the resource name of the debug token.
     */
    public val debugTokenId: Output
        get() = javaResource.debugTokenId().applyValue({ args0 -> args0 })

    /**
     * A human readable display name used to identify this debug token.
     */
    public val displayName: Output
        get() = javaResource.displayName().applyValue({ args0 -> args0 })

    /**
     * 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 })

    /**
     * The secret token itself. Must be provided during creation, and must be a UUID4,
     * case insensitive. You may use a method of your choice such as random/random_uuid
     * to generate the token.
     * This field is immutable once set, and cannot be updated. You can, however, delete
     * this debug token to revoke it.
     * For security reasons, this field will never be populated in any response.
     * **Note**: This property is sensitive and will not be displayed in the plan.
     */
    public val token: Output
        get() = javaResource.token().applyValue({ args0 -> args0 })
}

public object AppCheckDebugTokenMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.firebase.AppCheckDebugToken::class == javaResource::class

    override fun map(javaResource: Resource): AppCheckDebugToken = AppCheckDebugToken(
        javaResource as
            com.pulumi.gcp.firebase.AppCheckDebugToken,
    )
}

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

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




© 2015 - 2025 Weber Informatics LLC | Privacy Policy