siteverification

package
v8.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 1, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetTokenArgs 

type GetTokenArgs struct {
	// The site identifier. If the type is set to SITE, the identifier is a URL. If the type is
	// set to INET_DOMAIN, the identifier is a domain name.
	Identifier string `pulumi:"identifier"`
	// The type of resource to be verified, either a domain or a web site.
	// Possible values are: `INET_DOMAIN`, `SITE`.
	Type string `pulumi:"type"`
	// 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`.
	//
	// ***
	VerificationMethod string `pulumi:"verificationMethod"`
}

A collection of arguments for invoking getToken.

type GetTokenOutputArgs 

type GetTokenOutputArgs struct {
	// The site identifier. If the type is set to SITE, the identifier is a URL. If the type is
	// set to INET_DOMAIN, the identifier is a domain name.
	Identifier pulumi.StringInput `pulumi:"identifier"`
	// The type of resource to be verified, either a domain or a web site.
	// Possible values are: `INET_DOMAIN`, `SITE`.
	Type pulumi.StringInput `pulumi:"type"`
	// 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`.
	//
	// ***
	VerificationMethod pulumi.StringInput `pulumi:"verificationMethod"`
}

A collection of arguments for invoking getToken.

func (GetTokenOutputArgs) ElementType 

func (GetTokenOutputArgs) ElementType() reflect.Type

type GetTokenResult 

type GetTokenResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id         string `pulumi:"id"`
	Identifier string `pulumi:"identifier"`
	// The generated token for use in subsequent verification steps.
	Token              string `pulumi:"token"`
	Type               string `pulumi:"type"`
	VerificationMethod string `pulumi:"verificationMethod"`
}

A collection of values returned by getToken.

func GetToken 

func GetToken(ctx *pulumi.Context, args *GetTokenArgs, opts ...pulumi.InvokeOption) (*GetTokenResult, error)

## subcategory: "Site Verification"

description: |- 

A verification token is used to demonstrate ownership of a website or domain.

---

siteverification.getToken

A verification token is used to demonstrate ownership of a website or domain.

To get more information about Token, see:

* [API documentation](https://developers.google.com/site-verification/v1) * How-to Guides

## Example Usage

### Site Verification Via Site META Tag

```go package main

import ( 

"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 {
		_, err := siteverification.GetToken(ctx, &siteverification.GetTokenArgs{
			Type:               "SITE",
			Identifier:         "https://www.example.com",
			VerificationMethod: "META",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Site Verification Via DNS TXT Record

```go package main

import ( 

"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 {
		_, err := siteverification.GetToken(ctx, &siteverification.GetTokenArgs{
			Type:               "INET_DOMAIN",
			Identifier:         "www.example.com",
			VerificationMethod: "DNS_TXT",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetTokenResultOutput 

type GetTokenResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getToken.

func GetTokenOutput 

func GetTokenOutput(ctx *pulumi.Context, args GetTokenOutputArgs, opts ...pulumi.InvokeOption) GetTokenResultOutput

func (GetTokenResultOutput) ElementType 

func (GetTokenResultOutput) ElementType() reflect.Type

func (GetTokenResultOutput) Id 

func (o GetTokenResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetTokenResultOutput) Identifier 

func (o GetTokenResultOutput) Identifier() pulumi.StringOutput

func (GetTokenResultOutput) ToGetTokenResultOutput 

func (o GetTokenResultOutput) ToGetTokenResultOutput() GetTokenResultOutput

func (GetTokenResultOutput) ToGetTokenResultOutputWithContext 

func (o GetTokenResultOutput) ToGetTokenResultOutputWithContext(ctx context.Context) GetTokenResultOutput

func (GetTokenResultOutput) Token 

func (o GetTokenResultOutput) Token() pulumi.StringOutput

The generated token for use in subsequent verification steps.

func (GetTokenResultOutput) Type 

func (o GetTokenResultOutput) Type() pulumi.StringOutput

func (GetTokenResultOutput) VerificationMethod 

func (o GetTokenResultOutput) VerificationMethod() pulumi.StringOutput

type WebResource added in v8.3.0 

type WebResource struct {
	pulumi.CustomResourceState

	// 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.
	Owners pulumi.StringArrayOutput `pulumi:"owners"`
	// Container for the address and type of a site for which a verification token will be verified.
	// Structure is documented below.
	Site WebResourceSiteOutput `pulumi:"site"`
	// 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`.
	VerificationMethod pulumi.StringOutput `pulumi:"verificationMethod"`
	// The string used to identify this web resource.
	WebResourceId pulumi.StringOutput `pulumi:"webResourceId"`
}

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

## Example Usage

### Site Verification Domain Record

```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
	})
}

```

## 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}} ```

func GetWebResource added in v8.3.0 

func GetWebResource(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *WebResourceState, opts ...pulumi.ResourceOption) (*WebResource, error)

GetWebResource gets an existing WebResource resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewWebResource added in v8.3.0 

func NewWebResource(ctx *pulumi.Context,
	name string, args *WebResourceArgs, opts ...pulumi.ResourceOption) (*WebResource, error)

NewWebResource registers a new resource with the given unique name, arguments, and options.

func (*WebResource) ElementType added in v8.3.0 

func (*WebResource) ElementType() reflect.Type

func (*WebResource) ToWebResourceOutput added in v8.3.0 

func (i *WebResource) ToWebResourceOutput() WebResourceOutput

func (*WebResource) ToWebResourceOutputWithContext added in v8.3.0 

func (i *WebResource) ToWebResourceOutputWithContext(ctx context.Context) WebResourceOutput

type WebResourceArgs added in v8.3.0 

type WebResourceArgs struct {
	// Container for the address and type of a site for which a verification token will be verified.
	// Structure is documented below.
	Site WebResourceSiteInput
	// 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`.
	VerificationMethod pulumi.StringInput
}

The set of arguments for constructing a WebResource resource.

func (WebResourceArgs) ElementType added in v8.3.0 

func (WebResourceArgs) ElementType() reflect.Type

type WebResourceArray added in v8.3.0 

type WebResourceArray []WebResourceInput

func (WebResourceArray) ElementType added in v8.3.0 

func (WebResourceArray) ElementType() reflect.Type

func (WebResourceArray) ToWebResourceArrayOutput added in v8.3.0 

func (i WebResourceArray) ToWebResourceArrayOutput() WebResourceArrayOutput

func (WebResourceArray) ToWebResourceArrayOutputWithContext added in v8.3.0 

func (i WebResourceArray) ToWebResourceArrayOutputWithContext(ctx context.Context) WebResourceArrayOutput

type WebResourceArrayInput added in v8.3.0 

type WebResourceArrayInput interface {
	pulumi.Input

	ToWebResourceArrayOutput() WebResourceArrayOutput
	ToWebResourceArrayOutputWithContext(context.Context) WebResourceArrayOutput
}

WebResourceArrayInput is an input type that accepts WebResourceArray and WebResourceArrayOutput values. You can construct a concrete instance of `WebResourceArrayInput` via: 

WebResourceArray{ WebResourceArgs{...} }

type WebResourceArrayOutput added in v8.3.0 

type WebResourceArrayOutput struct{ *pulumi.OutputState }

func (WebResourceArrayOutput) ElementType added in v8.3.0 

func (WebResourceArrayOutput) ElementType() reflect.Type

func (WebResourceArrayOutput) Index added in v8.3.0 

func (o WebResourceArrayOutput) Index(i pulumi.IntInput) WebResourceOutput

func (WebResourceArrayOutput) ToWebResourceArrayOutput added in v8.3.0 

func (o WebResourceArrayOutput) ToWebResourceArrayOutput() WebResourceArrayOutput

func (WebResourceArrayOutput) ToWebResourceArrayOutputWithContext added in v8.3.0 

func (o WebResourceArrayOutput) ToWebResourceArrayOutputWithContext(ctx context.Context) WebResourceArrayOutput

type WebResourceInput added in v8.3.0 

type WebResourceInput interface {
	pulumi.Input

	ToWebResourceOutput() WebResourceOutput
	ToWebResourceOutputWithContext(ctx context.Context) WebResourceOutput
}

type WebResourceMap added in v8.3.0 

type WebResourceMap map[string]WebResourceInput

func (WebResourceMap) ElementType added in v8.3.0 

func (WebResourceMap) ElementType() reflect.Type

func (WebResourceMap) ToWebResourceMapOutput added in v8.3.0 

func (i WebResourceMap) ToWebResourceMapOutput() WebResourceMapOutput

func (WebResourceMap) ToWebResourceMapOutputWithContext added in v8.3.0 

func (i WebResourceMap) ToWebResourceMapOutputWithContext(ctx context.Context) WebResourceMapOutput

type WebResourceMapInput added in v8.3.0 

type WebResourceMapInput interface {
	pulumi.Input

	ToWebResourceMapOutput() WebResourceMapOutput
	ToWebResourceMapOutputWithContext(context.Context) WebResourceMapOutput
}

WebResourceMapInput is an input type that accepts WebResourceMap and WebResourceMapOutput values. You can construct a concrete instance of `WebResourceMapInput` via: 

WebResourceMap{ "key": WebResourceArgs{...} }

type WebResourceMapOutput added in v8.3.0 

type WebResourceMapOutput struct{ *pulumi.OutputState }

func (WebResourceMapOutput) ElementType added in v8.3.0 

func (WebResourceMapOutput) ElementType() reflect.Type

func (WebResourceMapOutput) MapIndex added in v8.3.0 

func (o WebResourceMapOutput) MapIndex(k pulumi.StringInput) WebResourceOutput

func (WebResourceMapOutput) ToWebResourceMapOutput added in v8.3.0 

func (o WebResourceMapOutput) ToWebResourceMapOutput() WebResourceMapOutput

func (WebResourceMapOutput) ToWebResourceMapOutputWithContext added in v8.3.0 

func (o WebResourceMapOutput) ToWebResourceMapOutputWithContext(ctx context.Context) WebResourceMapOutput

type WebResourceOutput added in v8.3.0 

type WebResourceOutput struct{ *pulumi.OutputState }

func (WebResourceOutput) ElementType added in v8.3.0 

func (WebResourceOutput) ElementType() reflect.Type

func (WebResourceOutput) Owners added in v8.3.0 

func (o WebResourceOutput) Owners() pulumi.StringArrayOutput

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.

func (WebResourceOutput) Site added in v8.3.0 

func (o WebResourceOutput) Site() WebResourceSiteOutput

Container for the address and type of a site for which a verification token will be verified. Structure is documented below.

func (WebResourceOutput) ToWebResourceOutput added in v8.3.0 

func (o WebResourceOutput) ToWebResourceOutput() WebResourceOutput

func (WebResourceOutput) ToWebResourceOutputWithContext added in v8.3.0 

func (o WebResourceOutput) ToWebResourceOutputWithContext(ctx context.Context) WebResourceOutput

func (WebResourceOutput) VerificationMethod added in v8.3.0 

func (o WebResourceOutput) VerificationMethod() pulumi.StringOutput

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`.

func (WebResourceOutput) WebResourceId added in v8.3.0 

func (o WebResourceOutput) WebResourceId() pulumi.StringOutput

The string used to identify this web resource.

type WebResourceSite added in v8.3.0 

type WebResourceSite struct {
	// The site identifier. If the type is set to SITE, the identifier is a URL. If the type is
	// set to INET_DOMAIN, the identifier is a domain name.
	//
	// ***
	Identifier string `pulumi:"identifier"`
	// The type of resource to be verified.
	// Possible values are: `INET_DOMAIN`, `SITE`.
	Type string `pulumi:"type"`
}

type WebResourceSiteArgs added in v8.3.0 

type WebResourceSiteArgs struct {
	// The site identifier. If the type is set to SITE, the identifier is a URL. If the type is
	// set to INET_DOMAIN, the identifier is a domain name.
	//
	// ***
	Identifier pulumi.StringInput `pulumi:"identifier"`
	// The type of resource to be verified.
	// Possible values are: `INET_DOMAIN`, `SITE`.
	Type pulumi.StringInput `pulumi:"type"`
}

func (WebResourceSiteArgs) ElementType added in v8.3.0 

func (WebResourceSiteArgs) ElementType() reflect.Type

func (WebResourceSiteArgs) ToWebResourceSiteOutput added in v8.3.0 

func (i WebResourceSiteArgs) ToWebResourceSiteOutput() WebResourceSiteOutput

func (WebResourceSiteArgs) ToWebResourceSiteOutputWithContext added in v8.3.0 

func (i WebResourceSiteArgs) ToWebResourceSiteOutputWithContext(ctx context.Context) WebResourceSiteOutput

func (WebResourceSiteArgs) ToWebResourceSitePtrOutput added in v8.3.0 

func (i WebResourceSiteArgs) ToWebResourceSitePtrOutput() WebResourceSitePtrOutput

func (WebResourceSiteArgs) ToWebResourceSitePtrOutputWithContext added in v8.3.0 

func (i WebResourceSiteArgs) ToWebResourceSitePtrOutputWithContext(ctx context.Context) WebResourceSitePtrOutput

type WebResourceSiteInput added in v8.3.0 

type WebResourceSiteInput interface {
	pulumi.Input

	ToWebResourceSiteOutput() WebResourceSiteOutput
	ToWebResourceSiteOutputWithContext(context.Context) WebResourceSiteOutput
}

WebResourceSiteInput is an input type that accepts WebResourceSiteArgs and WebResourceSiteOutput values. You can construct a concrete instance of `WebResourceSiteInput` via: 

WebResourceSiteArgs{...}

type WebResourceSiteOutput added in v8.3.0 

type WebResourceSiteOutput struct{ *pulumi.OutputState }

func (WebResourceSiteOutput) ElementType added in v8.3.0 

func (WebResourceSiteOutput) ElementType() reflect.Type

func (WebResourceSiteOutput) Identifier added in v8.3.0 

func (o WebResourceSiteOutput) Identifier() pulumi.StringOutput

The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the identifier is a domain name.

***

func (WebResourceSiteOutput) ToWebResourceSiteOutput added in v8.3.0 

func (o WebResourceSiteOutput) ToWebResourceSiteOutput() WebResourceSiteOutput

func (WebResourceSiteOutput) ToWebResourceSiteOutputWithContext added in v8.3.0 

func (o WebResourceSiteOutput) ToWebResourceSiteOutputWithContext(ctx context.Context) WebResourceSiteOutput

func (WebResourceSiteOutput) ToWebResourceSitePtrOutput added in v8.3.0 

func (o WebResourceSiteOutput) ToWebResourceSitePtrOutput() WebResourceSitePtrOutput

func (WebResourceSiteOutput) ToWebResourceSitePtrOutputWithContext added in v8.3.0 

func (o WebResourceSiteOutput) ToWebResourceSitePtrOutputWithContext(ctx context.Context) WebResourceSitePtrOutput

func (WebResourceSiteOutput) Type added in v8.3.0 

func (o WebResourceSiteOutput) Type() pulumi.StringOutput

The type of resource to be verified. Possible values are: `INET_DOMAIN`, `SITE`.

type WebResourceSitePtrInput added in v8.3.0 

type WebResourceSitePtrInput interface {
	pulumi.Input

	ToWebResourceSitePtrOutput() WebResourceSitePtrOutput
	ToWebResourceSitePtrOutputWithContext(context.Context) WebResourceSitePtrOutput
}

WebResourceSitePtrInput is an input type that accepts WebResourceSiteArgs, WebResourceSitePtr and WebResourceSitePtrOutput values. You can construct a concrete instance of `WebResourceSitePtrInput` via: 

        WebResourceSiteArgs{...}

or:

        nil

func WebResourceSitePtr added in v8.3.0 

func WebResourceSitePtr(v *WebResourceSiteArgs) WebResourceSitePtrInput

type WebResourceSitePtrOutput added in v8.3.0 

type WebResourceSitePtrOutput struct{ *pulumi.OutputState }

func (WebResourceSitePtrOutput) Elem added in v8.3.0 

func (o WebResourceSitePtrOutput) Elem() WebResourceSiteOutput

func (WebResourceSitePtrOutput) ElementType added in v8.3.0 

func (WebResourceSitePtrOutput) ElementType() reflect.Type

func (WebResourceSitePtrOutput) Identifier added in v8.3.0 

func (o WebResourceSitePtrOutput) Identifier() pulumi.StringPtrOutput

The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the identifier is a domain name.

***

func (WebResourceSitePtrOutput) ToWebResourceSitePtrOutput added in v8.3.0 

func (o WebResourceSitePtrOutput) ToWebResourceSitePtrOutput() WebResourceSitePtrOutput

func (WebResourceSitePtrOutput) ToWebResourceSitePtrOutputWithContext added in v8.3.0 

func (o WebResourceSitePtrOutput) ToWebResourceSitePtrOutputWithContext(ctx context.Context) WebResourceSitePtrOutput

func (WebResourceSitePtrOutput) Type added in v8.3.0 

func (o WebResourceSitePtrOutput) Type() pulumi.StringPtrOutput

The type of resource to be verified. Possible values are: `INET_DOMAIN`, `SITE`.

type WebResourceState added in v8.3.0 

type WebResourceState struct {
	// 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.
	Owners pulumi.StringArrayInput
	// Container for the address and type of a site for which a verification token will be verified.
	// Structure is documented below.
	Site WebResourceSitePtrInput
	// 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`.
	VerificationMethod pulumi.StringPtrInput
	// The string used to identify this web resource.
	WebResourceId pulumi.StringPtrInput
}

func (WebResourceState) ElementType added in v8.3.0 

func (WebResourceState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.