@pulumi/cloudflare 4.7.0 → 4.8.0

package/getZone.d.ts

@@ -1,99 +1,27 @@
 import * as pulumi from "@pulumi/pulumi";
-/**
- * Use this data source to look up [zone] info. This is the singular alternative
- * to `cloudflare.getZones`.
- *
- * > **Note** Cloudflare zone names **are not unique**. It is possible for multiple
- *   accounts to have the same zone created but in different states. If you are
- *   using this setup, it is advised to use the `accountId` attribute on this
- *   resource or swap to `cloudflare.getZones` to further filter the results.
- *
- * ## Example Usage
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * // You can also lookup by zone_id if you prefer.
- * const example = pulumi.output(cloudflare.getZone({
- *     zoneId: "0b6d347b01d437a092be84c2edfce72c",
- * }));
- * ```
- * ### Example usage with other resources
- *
- * The example below fetches the zone information for example.com and then is
- * referenced in the `cloudflare.Record` section.
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * const exampleZone = cloudflare.getZone({
- *     name: "example.com",
- * });
- * const exampleRecord = new cloudflare.Record("exampleRecord", {
- *     zoneId: exampleZone.then(exampleZone => exampleZone.id),
- *     name: "www",
- *     value: "203.0.113.1",
- *     type: "A",
- *     proxied: true,
- * });
- * ```
- */
 export declare function getZone(args?: GetZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetZoneResult>;
 /**
  * A collection of arguments for invoking getZone.
  */
 export interface GetZoneArgs {
-    /**
-     * The account ID associated with the zone.
-     */
     accountId?: string;
-    /**
-     * The name of the zone. Conflicts with `"zoneId"`.
-     */
     name?: string;
-    /**
-     * The zone ID. Conflicts with `"name"`.
-     */
     zoneId?: string;
 }
 /**
  * A collection of values returned by getZone.
  */
 export interface GetZoneResult {
-    /**
-     * The account ID associated with the zone.
-     */
     readonly accountId: string;
     /**
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
-    /**
-     * The name of the zone.
-     */
     readonly name: string;
-    /**
-     * Cloudflare assigned name servers. This is only populated for zones that use Cloudflare DNS.
-     */
     readonly nameServers: string[];
-    /**
-     * `true` if cloudflare is enabled on the zone, otherwise `false`.
-     */
     readonly paused: boolean;
-    /**
-     * The name of the plan associated with the zone.
-     */
     readonly plan: string;
-    /**
-     * Status of the zone. Values can be: `"active"`, `"pending"`, `"initializing"`, `"moved"`, `"deleted"`,
-     * or `"deactivated"`.
-     */
     readonly status: string;
-    /**
-     * List of Vanity Nameservers (if set).
-     */
     readonly vanityNameServers: string[];
     readonly zoneId: string;
 }
@@ -102,16 +30,7 @@ export declare function getZoneOutput(args?: GetZoneOutputArgs, opts?: pulumi.In
  * A collection of arguments for invoking getZone.
  */
 export interface GetZoneOutputArgs {
-    /**
-     * The account ID associated with the zone.
-     */
     accountId?: pulumi.Input<string>;
-    /**
-     * The name of the zone. Conflicts with `"zoneId"`.
-     */
     name?: pulumi.Input<string>;
-    /**
-     * The zone ID. Conflicts with `"name"`.
-     */
     zoneId?: pulumi.Input<string>;
 }

package/getZone.js

@@ -5,47 +5,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getZoneOutput = exports.getZone = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
-/**
- * Use this data source to look up [zone] info. This is the singular alternative
- * to `cloudflare.getZones`.
- *
- * > **Note** Cloudflare zone names **are not unique**. It is possible for multiple
- *   accounts to have the same zone created but in different states. If you are
- *   using this setup, it is advised to use the `accountId` attribute on this
- *   resource or swap to `cloudflare.getZones` to further filter the results.
- *
- * ## Example Usage
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * // You can also lookup by zone_id if you prefer.
- * const example = pulumi.output(cloudflare.getZone({
- *     zoneId: "0b6d347b01d437a092be84c2edfce72c",
- * }));
- * ```
- * ### Example usage with other resources
- *
- * The example below fetches the zone information for example.com and then is
- * referenced in the `cloudflare.Record` section.
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * const exampleZone = cloudflare.getZone({
- *     name: "example.com",
- * });
- * const exampleRecord = new cloudflare.Record("exampleRecord", {
- *     zoneId: exampleZone.then(exampleZone => exampleZone.id),
- *     name: "www",
- *     value: "203.0.113.1",
- *     type: "A",
- *     proxied: true,
- * });
- * ```
- */
 function getZone(args, opts) {
     args = args || {};
     if (!opts) {

package/getZone.js.map

@@ -1 +1 @@
-{"version":3,"file":"getZone.js","sourceRoot":"","sources":["../getZone.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,SAAgB,OAAO,CAAC,IAAkB,EAAE,IAA2B;IACnE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kCAAkC,EAAE;QAC7D,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAZD,0BAYC;AA4DD,SAAgB,aAAa,CAAC,IAAwB,EAAE,IAA2B;IAC/E,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC3D,CAAC;AAFD,sCAEC"}
+{"version":3,"file":"getZone.js","sourceRoot":"","sources":["../getZone.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,OAAO,CAAC,IAAkB,EAAE,IAA2B;IACnE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kCAAkC,EAAE;QAC7D,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAZD,0BAYC;AA6BD,SAAgB,aAAa,CAAC,IAAwB,EAAE,IAA2B;IAC/E,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC3D,CAAC;AAFD,sCAEC"}

package/getZoneDnssec.d.ts

@@ -1,75 +1,28 @@
 import * as pulumi from "@pulumi/pulumi";
-/**
- * Use this data source to look up [Zone][1] DNSSEC settings.
- *
- * ## Example Usage
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * const example = pulumi.output(cloudflare.getZoneDnssec({
- *     zoneId: "<zone_id>",
- * }));
- * ```
- */
 export declare function getZoneDnssec(args: GetZoneDnssecArgs, opts?: pulumi.InvokeOptions): Promise<GetZoneDnssecResult>;
 /**
  * A collection of arguments for invoking getZoneDnssec.
  */
 export interface GetZoneDnssecArgs {
-    /**
-     * The zone id for the zone.
-     */
     zoneId: string;
 }
 /**
  * A collection of values returned by getZoneDnssec.
  */
 export interface GetZoneDnssecResult {
-    /**
-     * Zone DNSSEC algorithm.
-     */
     readonly algorithm: string;
-    /**
-     * Zone DNSSEC digest.
-     */
     readonly digest: string;
-    /**
-     * Digest algorithm use for Zone DNSSEC.
-     */
     readonly digestAlgorithm: string;
-    /**
-     * Digest Type for Zone DNSSEC.
-     */
     readonly digestType: string;
-    /**
-     * DS for the Zone DNSSEC.
-     */
     readonly ds: string;
-    /**
-     * Zone DNSSEC flags.
-     */
     readonly flags: number;
     /**
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
-    /**
-     * Key Tag for the Zone DNSSEC.
-     */
     readonly keyTag: number;
-    /**
-     * Key type used for Zone DNSSEC.
-     */
     readonly keyType: string;
-    /**
-     * Public Key for the Zone DNSSEC.
-     */
     readonly publicKey: string;
-    /**
-     * The status of the Zone DNSSEC.
-     */
     readonly status: string;
     readonly zoneId: string;
 }
@@ -78,8 +31,5 @@ export declare function getZoneDnssecOutput(args: GetZoneDnssecOutputArgs, opts?
  * A collection of arguments for invoking getZoneDnssec.
  */
 export interface GetZoneDnssecOutputArgs {
-    /**
-     * The zone id for the zone.
-     */
     zoneId: pulumi.Input<string>;
 }

package/getZoneDnssec.js

@@ -5,20 +5,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getZoneDnssecOutput = exports.getZoneDnssec = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
-/**
- * Use this data source to look up [Zone][1] DNSSEC settings.
- *
- * ## Example Usage
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * const example = pulumi.output(cloudflare.getZoneDnssec({
- *     zoneId: "<zone_id>",
- * }));
- * ```
- */
 function getZoneDnssec(args, opts) {
     if (!opts) {
         opts = {};

package/getZoneDnssec.js.map

@@ -1 +1 @@
-{"version":3,"file":"getZoneDnssec.js","sourceRoot":"","sources":["../getZoneDnssec.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;GAaG;AACH,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAA2B;IAC9E,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8CAA8C,EAAE;QACzE,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,sCASC;AA+DD,SAAgB,mBAAmB,CAAC,IAA6B,EAAE,IAA2B;IAC1F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"getZoneDnssec.js","sourceRoot":"","sources":["../getZoneDnssec.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAA2B;IAC9E,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,8CAA8C,EAAE;QACzE,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,sCASC;AA8BD,SAAgB,mBAAmB,CAAC,IAA6B,EAAE,IAA2B;IAC1F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACjE,CAAC;AAFD,kDAEC"}

package/getZones.d.ts

@@ -1,84 +1,10 @@
 import * as pulumi from "@pulumi/pulumi";
 import { input as inputs, output as outputs } from "./types";
-/**
- * Use this data source to look up [Zone](https://api.cloudflare.com/#zone-properties) records.
- *
- * ## Example Usage
- *
- * Given you have the following zones in Cloudflare.
- *
- * - example.com
- * - example.net
- * - not-example.com
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * // Look for a single zone that you know exists using an exact match.
- * // API request will be for zones?name=example.com. Will not match not-example.com
- * // or example.net.
- * const example = pulumi.output(cloudflare.getZones({
- *     filter: {
- *         name: "example.com",
- *     },
- * }));
- * ```
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * // Look for all zones which include "example".
- * // API request will be for zones?name=contains:example. Will return all three
- * // zones.
- * const example = pulumi.output(cloudflare.getZones({
- *     filter: {
- *         lookupType: "contains",
- *         name: "example",
- *     },
- * }));
- * ```
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * // Look for all zones which include "example" but start with "not-".
- * // API request will be for zones?name=contains:example. Will perform client side
- * // filtering using the provided regex and will only match the single zone,
- * // not-example.com.
- * const example = pulumi.output(cloudflare.getZones({
- *     filter: {
- *         lookupType: "contains",
- *         match: "^not-",
- *         name: "example",
- *     },
- * }));
- * ```
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * // Look for all active zones in an account
- * const example = pulumi.output(cloudflare.getZones({
- *     filter: {
- *         accountId: "1d5fdc9e88c8a8c4518b068cd94331fe",
- *         status: "active",
- *     },
- * }));
- * ```
- */
 export declare function getZones(args: GetZonesArgs, opts?: pulumi.InvokeOptions): Promise<GetZonesResult>;
 /**
  * A collection of arguments for invoking getZones.
  */
 export interface GetZonesArgs {
-    /**
-     * One or more values used to look up zone records. If more than one value is given all
-     * values must match in order to be included, see below for full list.
-     */
     filter: inputs.GetZonesFilter;
 }
 /**
@@ -90,9 +16,6 @@ export interface GetZonesResult {
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
-    /**
-     * A list of zone objects. Object format:
-     */
     readonly zones: outputs.GetZonesZone[];
 }
 export declare function getZonesOutput(args: GetZonesOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetZonesResult>;
@@ -100,9 +23,5 @@ export declare function getZonesOutput(args: GetZonesOutputArgs, opts?: pulumi.I
  * A collection of arguments for invoking getZones.
  */
 export interface GetZonesOutputArgs {
-    /**
-     * One or more values used to look up zone records. If more than one value is given all
-     * values must match in order to be included, see below for full list.
-     */
     filter: pulumi.Input<inputs.GetZonesFilterArgs>;
 }

package/getZones.js

@@ -5,76 +5,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getZonesOutput = exports.getZones = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
-/**
- * Use this data source to look up [Zone](https://api.cloudflare.com/#zone-properties) records.
- *
- * ## Example Usage
- *
- * Given you have the following zones in Cloudflare.
- *
- * - example.com
- * - example.net
- * - not-example.com
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * // Look for a single zone that you know exists using an exact match.
- * // API request will be for zones?name=example.com. Will not match not-example.com
- * // or example.net.
- * const example = pulumi.output(cloudflare.getZones({
- *     filter: {
- *         name: "example.com",
- *     },
- * }));
- * ```
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * // Look for all zones which include "example".
- * // API request will be for zones?name=contains:example. Will return all three
- * // zones.
- * const example = pulumi.output(cloudflare.getZones({
- *     filter: {
- *         lookupType: "contains",
- *         name: "example",
- *     },
- * }));
- * ```
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * // Look for all zones which include "example" but start with "not-".
- * // API request will be for zones?name=contains:example. Will perform client side
- * // filtering using the provided regex and will only match the single zone,
- * // not-example.com.
- * const example = pulumi.output(cloudflare.getZones({
- *     filter: {
- *         lookupType: "contains",
- *         match: "^not-",
- *         name: "example",
- *     },
- * }));
- * ```
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as cloudflare from "@pulumi/cloudflare";
- *
- * // Look for all active zones in an account
- * const example = pulumi.output(cloudflare.getZones({
- *     filter: {
- *         accountId: "1d5fdc9e88c8a8c4518b068cd94331fe",
- *         status: "active",
- *     },
- * }));
- * ```
- */
 function getZones(args, opts) {
     if (!opts) {
         opts = {};

package/getZones.js.map

@@ -1 +1 @@
-{"version":3,"file":"getZones.js","sourceRoot":"","sources":["../getZones.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAEzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AACH,SAAgB,QAAQ,CAAC,IAAkB,EAAE,IAA2B;IACpE,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,oCAAoC,EAAE;QAC/D,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,4BASC;AA4BD,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC5D,CAAC;AAFD,wCAEC"}
+{"version":3,"file":"getZones.js","sourceRoot":"","sources":["../getZones.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAEzC,yCAAyC;AAEzC,SAAgB,QAAQ,CAAC,IAAkB,EAAE,IAA2B;IACpE,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,oCAAoC,EAAE;QAC/D,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AATD,4BASC;AAqBD,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC5D,CAAC;AAFD,wCAEC"}