@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
277 lines (276 loc) • 11.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* DnsAuthorization represents a HTTP-reachable backend for a DnsAuthorization.
*
* ## Example Usage
*
* ### Certificate Manager Dns Authorization Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.certificatemanager.DnsAuthorization("default", {
* name: "dns-auth",
* location: "global",
* description: "The default dns",
* domain: "subdomain.hashicorptest.com",
* });
* export const recordNameToInsert = _default.dnsResourceRecords.apply(dnsResourceRecords => dnsResourceRecords[0].name);
* export const recordTypeToInsert = _default.dnsResourceRecords.apply(dnsResourceRecords => dnsResourceRecords[0].type);
* export const recordDataToInsert = _default.dnsResourceRecords.apply(dnsResourceRecords => dnsResourceRecords[0].data);
* ```
* ### Certificate Manager Dns Authorization Regional
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.certificatemanager.DnsAuthorization("default", {
* name: "dns-auth",
* location: "us-central1",
* description: "reginal dns",
* type: "PER_PROJECT_RECORD",
* domain: "subdomain.hashicorptest.com",
* });
* ```
*
* ## Import
*
* DnsAuthorization can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/dnsAuthorizations/{{name}}`
*
* * `{{project}}/{{location}}/{{name}}`
*
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, DnsAuthorization can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:certificatemanager/dnsAuthorization:DnsAuthorization default projects/{{project}}/locations/{{location}}/dnsAuthorizations/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:certificatemanager/dnsAuthorization:DnsAuthorization default {{project}}/{{location}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:certificatemanager/dnsAuthorization:DnsAuthorization default {{location}}/{{name}}
* ```
*/
export declare class DnsAuthorization extends pulumi.CustomResource {
/**
* Get an existing DnsAuthorization resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DnsAuthorizationState, opts?: pulumi.CustomResourceOptions): DnsAuthorization;
/**
* Returns true if the given object is an instance of DnsAuthorization. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DnsAuthorization;
/**
* A human-readable description of the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The structure describing the DNS Resource Record that needs to be added
* to DNS configuration for the authorization to be usable by
* certificate.
* Structure is documented below.
*/
readonly dnsResourceRecords: pulumi.Output<outputs.certificatemanager.DnsAuthorizationDnsResourceRecord[]>;
/**
* A domain which is being authorized. A DnsAuthorization resource covers a
* single domain and its wildcard, e.g. authorization for "example.com" can
* be used to issue certificates for "example.com" and "*.example.com".
*/
readonly domain: pulumi.Output<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Set of label tags associated with the DNS Authorization resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The Certificate Manager location. If not specified, "global" is used.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Name of the resource; provided by the client when the resource is created.
* The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter,
* and all following characters must be a dash, underscore, letter or digit.
*
*
* - - -
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* type of DNS authorization. If unset during the resource creation, FIXED_RECORD will
* be used for global resources, and PER_PROJECT_RECORD will be used for other locations.
* FIXED_RECORD DNS authorization uses DNS-01 validation method
* PER_PROJECT_RECORD DNS authorization allows for independent management
* of Google-managed certificates with DNS authorization across multiple
* projects.
* Possible values are: `FIXED_RECORD`, `PER_PROJECT_RECORD`.
*/
readonly type: pulumi.Output<string>;
/**
* Create a DnsAuthorization resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DnsAuthorizationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DnsAuthorization resources.
*/
export interface DnsAuthorizationState {
/**
* A human-readable description of the resource.
*/
description?: pulumi.Input<string>;
/**
* The structure describing the DNS Resource Record that needs to be added
* to DNS configuration for the authorization to be usable by
* certificate.
* Structure is documented below.
*/
dnsResourceRecords?: pulumi.Input<pulumi.Input<inputs.certificatemanager.DnsAuthorizationDnsResourceRecord>[]>;
/**
* A domain which is being authorized. A DnsAuthorization resource covers a
* single domain and its wildcard, e.g. authorization for "example.com" can
* be used to issue certificates for "example.com" and "*.example.com".
*/
domain?: pulumi.Input<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Set of label tags associated with the DNS Authorization resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The Certificate Manager location. If not specified, "global" is used.
*/
location?: pulumi.Input<string>;
/**
* Name of the resource; provided by the client when the resource is created.
* The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter,
* and all following characters must be a dash, underscore, letter or digit.
*
*
* - - -
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* type of DNS authorization. If unset during the resource creation, FIXED_RECORD will
* be used for global resources, and PER_PROJECT_RECORD will be used for other locations.
* FIXED_RECORD DNS authorization uses DNS-01 validation method
* PER_PROJECT_RECORD DNS authorization allows for independent management
* of Google-managed certificates with DNS authorization across multiple
* projects.
* Possible values are: `FIXED_RECORD`, `PER_PROJECT_RECORD`.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DnsAuthorization resource.
*/
export interface DnsAuthorizationArgs {
/**
* A human-readable description of the resource.
*/
description?: pulumi.Input<string>;
/**
* A domain which is being authorized. A DnsAuthorization resource covers a
* single domain and its wildcard, e.g. authorization for "example.com" can
* be used to issue certificates for "example.com" and "*.example.com".
*/
domain: pulumi.Input<string>;
/**
* Set of label tags associated with the DNS Authorization resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The Certificate Manager location. If not specified, "global" is used.
*/
location?: pulumi.Input<string>;
/**
* Name of the resource; provided by the client when the resource is created.
* The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter,
* and all following characters must be a dash, underscore, letter or digit.
*
*
* - - -
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* type of DNS authorization. If unset during the resource creation, FIXED_RECORD will
* be used for global resources, and PER_PROJECT_RECORD will be used for other locations.
* FIXED_RECORD DNS authorization uses DNS-01 validation method
* PER_PROJECT_RECORD DNS authorization allows for independent management
* of Google-managed certificates with DNS authorization across multiple
* projects.
* Possible values are: `FIXED_RECORD`, `PER_PROJECT_RECORD`.
*/
type?: pulumi.Input<string>;
}