com.pulumi.gcp.siteverification.kotlin.WebResource.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.siteverification.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.siteverification.kotlin.outputs.WebResourceSite
import com.pulumi.gcp.siteverification.kotlin.outputs.WebResourceSite.Companion.toKotlin
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.List
/**
* Builder for [WebResource].
*/
@PulumiTagMarker
public class WebResourceResourceBuilder internal constructor() {
public var name: String? = null
public var args: WebResourceArgs = WebResourceArgs()
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 WebResourceArgsBuilder.() -> Unit) {
val builder = WebResourceArgsBuilder()
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(): WebResource {
val builtJavaResource = com.pulumi.gcp.siteverification.WebResource(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return WebResource(builtJavaResource)
}
}
/**
* A web resource is a website or domain with verified ownership. Once your
* ownership is verified you will be able to manage your website in the
* [Google Search Console](https://www.google.com/webmasters/tools/).
* > **Note:** The verification data (DNS `TXT` record, HTML file, `meta` tag, etc.)
* must already exist before the web resource is created, and must be deleted before
* the web resource is destroyed. The Google Site Verification API checks that the
* verification data exists at creation time and does not exist at destruction time
* and will fail if the required condition is not met.
* To get more information about WebResource, see:
* * [API documentation](https://developers.google.com/site-verification/v1)
* * How-to Guides
* * [Getting Started](https://developers.google.com/site-verification/v1/getting_started)
* ## Example Usage
* ### Site Verification Domain Record
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const token = gcp.siteverification.getToken({
* type: "INET_DOMAIN",
* identifier: "www.example.com",
* verificationMethod: "DNS_TXT",
* });
* const example = new gcp.dns.RecordSet("example", {
* managedZone: "example.com",
* name: "www.example.com.",
* type: "TXT",
* rrdatas: [token.then(token => token.token)],
* ttl: 86400,
* });
* const exampleWebResource = new gcp.siteverification.WebResource("example", {
* site: {
* type: token.then(token => token.type),
* identifier: token.then(token => token.identifier),
* },
* verificationMethod: token.then(token => token.verificationMethod),
* }, {
* dependsOn: [example],
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* token = gcp.siteverification.get_token(type="INET_DOMAIN",
* identifier="www.example.com",
* verification_method="DNS_TXT")
* example = gcp.dns.RecordSet("example",
* managed_zone="example.com",
* name="www.example.com.",
* type="TXT",
* rrdatas=[token.token],
* ttl=86400)
* example_web_resource = gcp.siteverification.WebResource("example",
* site={
* "type": token.type,
* "identifier": token.identifier,
* },
* verification_method=token.verification_method,
* opts = pulumi.ResourceOptions(depends_on=[example]))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var token = Gcp.SiteVerification.GetToken.Invoke(new()
* {
* Type = "INET_DOMAIN",
* Identifier = "www.example.com",
* VerificationMethod = "DNS_TXT",
* });
* var example = new Gcp.Dns.RecordSet("example", new()
* {
* ManagedZone = "example.com",
* Name = "www.example.com.",
* Type = "TXT",
* Rrdatas = new[]
* {
* token.Apply(getTokenResult => getTokenResult.Token),
* },
* Ttl = 86400,
* });
* var exampleWebResource = new Gcp.SiteVerification.WebResource("example", new()
* {
* Site = new Gcp.SiteVerification.Inputs.WebResourceSiteArgs
* {
* Type = token.Apply(getTokenResult => getTokenResult.Type),
* Identifier = token.Apply(getTokenResult => getTokenResult.Identifier),
* },
* VerificationMethod = token.Apply(getTokenResult => getTokenResult.VerificationMethod),
* }, new CustomResourceOptions
* {
* DependsOn =
* {
* example,
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/dns"
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/siteverification"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* token, err := siteverification.GetToken(ctx, &siteverification.GetTokenArgs{
* Type: "INET_DOMAIN",
* Identifier: "www.example.com",
* VerificationMethod: "DNS_TXT",
* }, nil)
* if err != nil {
* return err
* }
* example, err := dns.NewRecordSet(ctx, "example", &dns.RecordSetArgs{
* ManagedZone: pulumi.String("example.com"),
* Name: pulumi.String("www.example.com."),
* Type: pulumi.String("TXT"),
* Rrdatas: pulumi.StringArray{
* pulumi.String(token.Token),
* },
* Ttl: pulumi.Int(86400),
* })
* if err != nil {
* return err
* }
* _, err = siteverification.NewWebResource(ctx, "example", &siteverification.WebResourceArgs{
* Site: &siteverification.WebResourceSiteArgs{
* Type: pulumi.String(token.Type),
* Identifier: pulumi.String(token.Identifier),
* },
* VerificationMethod: pulumi.String(token.VerificationMethod),
* }, pulumi.DependsOn([]pulumi.Resource{
* example,
* }))
* 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.siteverification.SiteverificationFunctions;
* import com.pulumi.gcp.siteverification.inputs.GetTokenArgs;
* import com.pulumi.gcp.dns.RecordSet;
* import com.pulumi.gcp.dns.RecordSetArgs;
* import com.pulumi.gcp.siteverification.WebResource;
* import com.pulumi.gcp.siteverification.WebResourceArgs;
* import com.pulumi.gcp.siteverification.inputs.WebResourceSiteArgs;
* import com.pulumi.resources.CustomResourceOptions;
* 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) {
* final var token = SiteverificationFunctions.getToken(GetTokenArgs.builder()
* .type("INET_DOMAIN")
* .identifier("www.example.com")
* .verificationMethod("DNS_TXT")
* .build());
* var example = new RecordSet("example", RecordSetArgs.builder()
* .managedZone("example.com")
* .name("www.example.com.")
* .type("TXT")
* .rrdatas(token.applyValue(getTokenResult -> getTokenResult.token()))
* .ttl(86400)
* .build());
* var exampleWebResource = new WebResource("exampleWebResource", WebResourceArgs.builder()
* .site(WebResourceSiteArgs.builder()
* .type(token.applyValue(getTokenResult -> getTokenResult.type()))
* .identifier(token.applyValue(getTokenResult -> getTokenResult.identifier()))
* .build())
* .verificationMethod(token.applyValue(getTokenResult -> getTokenResult.verificationMethod()))
* .build(), CustomResourceOptions.builder()
* .dependsOn(example)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: gcp:dns:RecordSet
* properties:
* managedZone: example.com
* name: www.example.com.
* type: TXT
* rrdatas:
* - ${token.token}
* ttl: 86400
* exampleWebResource:
* type: gcp:siteverification:WebResource
* name: example
* properties:
* site:
* type: ${token.type}
* identifier: ${token.identifier}
* verificationMethod: ${token.verificationMethod}
* options:
* dependsOn:
* - ${example}
* variables:
* token:
* fn::invoke:
* function: gcp:siteverification:getToken
* arguments:
* type: INET_DOMAIN
* identifier: www.example.com
* verificationMethod: DNS_TXT
* ```
*
* ## Import
* WebResource can be imported using any of these accepted formats:
* * `webResource/{{web_resource_id}}`
* * `{{web_resource_id}}`
* When using the `pulumi import` command, WebResource can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:siteverification/webResource:WebResource default webResource/{{web_resource_id}}
* ```
* ```sh
* $ pulumi import gcp:siteverification/webResource:WebResource default {{web_resource_id}}
* ```
*/
public class WebResource internal constructor(
override val javaResource: com.pulumi.gcp.siteverification.WebResource,
) : KotlinCustomResource(javaResource, WebResourceMapper) {
/**
* The email addresses of all direct, verified owners of this exact property. Indirect owners —
* for example verified owners of the containing domain—are not included in this list.
*/
public val owners: Output>
get() = javaResource.owners().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* Container for the address and type of a site for which a verification token will be verified.
* Structure is documented below.
*/
public val site: Output
get() = javaResource.site().applyValue({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
/**
* The verification method for the Site Verification system to use to verify
* this site or domain.
* Possible values are: `ANALYTICS`, `DNS_CNAME`, `DNS_TXT`, `FILE`, `META`, `TAG_MANAGER`.
*/
public val verificationMethod: Output
get() = javaResource.verificationMethod().applyValue({ args0 -> args0 })
/**
* The string used to identify this web resource.
*/
public val webResourceId: Output
get() = javaResource.webResourceId().applyValue({ args0 -> args0 })
}
public object WebResourceMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.siteverification.WebResource::class == javaResource::class
override fun map(javaResource: Resource): WebResource = WebResource(
javaResource as
com.pulumi.gcp.siteverification.WebResource,
)
}
/**
* @see [WebResource].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [WebResource].
*/
public suspend fun webResource(name: String, block: suspend WebResourceResourceBuilder.() -> Unit): WebResource {
val builder = WebResourceResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [WebResource].
* @param name The _unique_ name of the resulting resource.
*/
public fun webResource(name: String): WebResource {
val builder = WebResourceResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy