@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
142 lines (141 loc) • 4.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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
* * [Getting Started](https://developers.google.com/site-verification/v1/getting_started)
*
* ## Example Usage
*
* ### Site Verification Via Site META Tag
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.siteverification.getToken({
* type: "SITE",
* identifier: "https://www.example.com",
* verificationMethod: "META",
* });
* ```
*
* ### Site Verification Via DNS TXT Record
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.siteverification.getToken({
* type: "INET_DOMAIN",
* identifier: "www.example.com",
* verificationMethod: "DNS_TXT",
* });
* ```
*/
export declare function getToken(args: GetTokenArgs, opts?: pulumi.InvokeOptions): Promise<GetTokenResult>;
/**
* A collection of arguments for invoking getToken.
*/
export interface GetTokenArgs {
/**
* 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;
/**
* The type of resource to be verified, either a domain or a web site.
* Possible values are: `INET_DOMAIN`, `SITE`.
*/
type: string;
/**
* 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;
}
/**
* A collection of values returned by getToken.
*/
export interface GetTokenResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly identifier: string;
/**
* The generated token for use in subsequent verification steps.
*/
readonly token: string;
readonly type: string;
readonly verificationMethod: string;
}
/**
* 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
* * [Getting Started](https://developers.google.com/site-verification/v1/getting_started)
*
* ## Example Usage
*
* ### Site Verification Via Site META Tag
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.siteverification.getToken({
* type: "SITE",
* identifier: "https://www.example.com",
* verificationMethod: "META",
* });
* ```
*
* ### Site Verification Via DNS TXT Record
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.siteverification.getToken({
* type: "INET_DOMAIN",
* identifier: "www.example.com",
* verificationMethod: "DNS_TXT",
* });
* ```
*/
export declare function getTokenOutput(args: GetTokenOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTokenResult>;
/**
* A collection of arguments for invoking getToken.
*/
export interface GetTokenOutputArgs {
/**
* 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.Input<string>;
/**
* The type of resource to be verified, either a domain or a web site.
* Possible values are: `INET_DOMAIN`, `SITE`.
*/
type: pulumi.Input<string>;
/**
* 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.Input<string>;
}