@pulumiverse/vercel 1.15.0 → 2.9.0-alpha.1747137905

package/getAccessGroupProject.d.ts

@@ -1,32 +1,102 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Provides information about an existing Access Group Project Assignment.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/accounts/team-members-and-roles/access-groups).
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getProject({
+ *     name: "my-existing-project",
+ * });
+ * const exampleGetAccessGroupProject = vercel.getAccessGroupProject({
+ *     accessGroupId: "ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+ *     projectId: exampleVercelProject.id,
+ * });
+ * ```
+ */
 export declare function getAccessGroupProject(args: GetAccessGroupProjectArgs, opts?: pulumi.InvokeOptions): Promise<GetAccessGroupProjectResult>;
 /**
  * A collection of arguments for invoking getAccessGroupProject.
  */
 export interface GetAccessGroupProjectArgs {
+    /**
+     * The Access Group ID.
+     */
     accessGroupId: string;
+    /**
+     * The Project ID.
+     */
     projectId: string;
+    /**
+     * The ID of the team the Access Group Project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     teamId?: string;
 }
 /**
  * A collection of values returned by getAccessGroupProject.
  */
 export interface GetAccessGroupProjectResult {
+    /**
+     * The Access Group ID.
+     */
     readonly accessGroupId: string;
     /**
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    /**
+     * The Project ID.
+     */
     readonly projectId: string;
+    /**
+     * The Access Group Project Role.
+     */
     readonly role: string;
+    /**
+     * The ID of the team the Access Group Project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     readonly teamId: string;
 }
+/**
+ * Provides information about an existing Access Group Project Assignment.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/accounts/team-members-and-roles/access-groups).
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getProject({
+ *     name: "my-existing-project",
+ * });
+ * const exampleGetAccessGroupProject = vercel.getAccessGroupProject({
+ *     accessGroupId: "ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+ *     projectId: exampleVercelProject.id,
+ * });
+ * ```
+ */
 export declare function getAccessGroupProjectOutput(args: GetAccessGroupProjectOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetAccessGroupProjectResult>;
 /**
  * A collection of arguments for invoking getAccessGroupProject.
  */
 export interface GetAccessGroupProjectOutputArgs {
+    /**
+     * The Access Group ID.
+     */
     accessGroupId: pulumi.Input<string>;
+    /**
+     * The Project ID.
+     */
     projectId: pulumi.Input<string>;
+    /**
+     * The ID of the team the Access Group Project should exist under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     teamId?: pulumi.Input<string>;
 }

package/getAccessGroupProject.js

@@ -5,6 +5,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAccessGroupProjectOutput = exports.getAccessGroupProject = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Provides information about an existing Access Group Project Assignment.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/accounts/team-members-and-roles/access-groups).
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getProject({
+ *     name: "my-existing-project",
+ * });
+ * const exampleGetAccessGroupProject = vercel.getAccessGroupProject({
+ *     accessGroupId: "ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+ *     projectId: exampleVercelProject.id,
+ * });
+ * ```
+ */
 function getAccessGroupProject(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("vercel:index/getAccessGroupProject:getAccessGroupProject", {
@@ -14,6 +34,26 @@ function getAccessGroupProject(args, opts) {
     }, opts);
 }
 exports.getAccessGroupProject = getAccessGroupProject;
+/**
+ * Provides information about an existing Access Group Project Assignment.
+ *
+ * For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/accounts/team-members-and-roles/access-groups).
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getProject({
+ *     name: "my-existing-project",
+ * });
+ * const exampleGetAccessGroupProject = vercel.getAccessGroupProject({
+ *     accessGroupId: "ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+ *     projectId: exampleVercelProject.id,
+ * });
+ * ```
+ */
 function getAccessGroupProjectOutput(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invokeOutput("vercel:index/getAccessGroupProject:getAccessGroupProject", {

package/getAccessGroupProject.js.map

@@ -1 +1 @@
-{"version":3,"file":"getAccessGroupProject.js","sourceRoot":"","sources":["../getAccessGroupProject.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,qBAAqB,CAAC,IAA+B,EAAE,IAA2B;IAC9F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0DAA0D,EAAE;QACrF,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,sDAOC;AAwBD,SAAgB,2BAA2B,CAAC,IAAqC,EAAE,IAA2B;IAC1G,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,0DAA0D,EAAE;QAC3F,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,kEAOC"}
+{"version":3,"file":"getAccessGroupProject.js","sourceRoot":"","sources":["../getAccessGroupProject.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,qBAAqB,CAAC,IAA+B,EAAE,IAA2B;IAC9F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,0DAA0D,EAAE;QACrF,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,sDAOC;AA6CD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,2BAA2B,CAAC,IAAqC,EAAE,IAA2B;IAC1G,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,0DAA0D,EAAE;QAC3F,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,kEAOC"}

package/getAlias.d.ts

@@ -1,26 +1,60 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Provides information about an existing Alias resource.
+ *
+ * An Alias allows a `vercel.Deployment` to be accessed through a different URL.
+ */
 export declare function getAlias(args: GetAliasArgs, opts?: pulumi.InvokeOptions): Promise<GetAliasResult>;
 /**
  * A collection of arguments for invoking getAlias.
  */
 export interface GetAliasArgs {
+    /**
+     * The Alias or Alias ID to be retrieved.
+     */
     alias: string;
+    /**
+     * The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     teamId?: string;
 }
 /**
  * A collection of values returned by getAlias.
  */
 export interface GetAliasResult {
+    /**
+     * The Alias or Alias ID to be retrieved.
+     */
     readonly alias: string;
+    /**
+     * The ID of the Deployment the Alias is associated with.
+     */
     readonly deploymentId: string;
+    /**
+     * The ID of this resource.
+     */
     readonly id: string;
+    /**
+     * The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     readonly teamId: string;
 }
+/**
+ * Provides information about an existing Alias resource.
+ *
+ * An Alias allows a `vercel.Deployment` to be accessed through a different URL.
+ */
 export declare function getAliasOutput(args: GetAliasOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetAliasResult>;
 /**
  * A collection of arguments for invoking getAlias.
  */
 export interface GetAliasOutputArgs {
+    /**
+     * The Alias or Alias ID to be retrieved.
+     */
     alias: pulumi.Input<string>;
+    /**
+     * The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     teamId?: pulumi.Input<string>;
 }

package/getAlias.js

@@ -5,6 +5,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAliasOutput = exports.getAlias = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Provides information about an existing Alias resource.
+ *
+ * An Alias allows a `vercel.Deployment` to be accessed through a different URL.
+ */
 function getAlias(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("vercel:index/getAlias:getAlias", {
@@ -13,6 +18,11 @@ function getAlias(args, opts) {
     }, opts);
 }
 exports.getAlias = getAlias;
+/**
+ * Provides information about an existing Alias resource.
+ *
+ * An Alias allows a `vercel.Deployment` to be accessed through a different URL.
+ */
 function getAliasOutput(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invokeOutput("vercel:index/getAlias:getAlias", {

package/getAlias.js.map

@@ -1 +1 @@
-{"version":3,"file":"getAlias.js","sourceRoot":"","sources":["../getAlias.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,QAAQ,CAAC,IAAkB,EAAE,IAA2B;IACpE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gCAAgC,EAAE;QAC3D,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,4BAMC;AAmBD,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,gCAAgC,EAAE;QACjE,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,wCAMC"}
+{"version":3,"file":"getAlias.js","sourceRoot":"","sources":["../getAlias.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,IAAkB,EAAE,IAA2B;IACpE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gCAAgC,EAAE;QAC3D,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,4BAMC;AAqCD;;;;GAIG;AACH,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,gCAAgC,EAAE;QACjE,OAAO,EAAE,IAAI,CAAC,KAAK;QACnB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,wCAMC"}

package/getAttackChallengeMode.d.ts

@@ -1,26 +1,82 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Provides an Attack Challenge Mode resource.
+ *
+ * Attack Challenge Mode prevent malicious traffic by showing a verification challenge for every visitor.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getAttackChallengeMode({
+ *     projectId: exampleVercelProject.id,
+ * });
+ * ```
+ */
 export declare function getAttackChallengeMode(args: GetAttackChallengeModeArgs, opts?: pulumi.InvokeOptions): Promise<GetAttackChallengeModeResult>;
 /**
  * A collection of arguments for invoking getAttackChallengeMode.
  */
 export interface GetAttackChallengeModeArgs {
+    /**
+     * The ID of the Project to adjust the CPU for.
+     */
     projectId: string;
+    /**
+     * The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     teamId?: string;
 }
 /**
  * A collection of values returned by getAttackChallengeMode.
  */
 export interface GetAttackChallengeModeResult {
+    /**
+     * Whether Attack Challenge Mode is enabled or not.
+     */
     readonly enabled: boolean;
+    /**
+     * The resource identifier.
+     */
     readonly id: string;
+    /**
+     * The ID of the Project to adjust the CPU for.
+     */
     readonly projectId: string;
+    /**
+     * The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     readonly teamId: string;
 }
+/**
+ * Provides an Attack Challenge Mode resource.
+ *
+ * Attack Challenge Mode prevent malicious traffic by showing a verification challenge for every visitor.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getAttackChallengeMode({
+ *     projectId: exampleVercelProject.id,
+ * });
+ * ```
+ */
 export declare function getAttackChallengeModeOutput(args: GetAttackChallengeModeOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetAttackChallengeModeResult>;
 /**
  * A collection of arguments for invoking getAttackChallengeMode.
  */
 export interface GetAttackChallengeModeOutputArgs {
+    /**
+     * The ID of the Project to adjust the CPU for.
+     */
     projectId: pulumi.Input<string>;
+    /**
+     * The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     teamId?: pulumi.Input<string>;
 }

package/getAttackChallengeMode.js

@@ -5,6 +5,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAttackChallengeModeOutput = exports.getAttackChallengeMode = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Provides an Attack Challenge Mode resource.
+ *
+ * Attack Challenge Mode prevent malicious traffic by showing a verification challenge for every visitor.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getAttackChallengeMode({
+ *     projectId: exampleVercelProject.id,
+ * });
+ * ```
+ */
 function getAttackChallengeMode(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("vercel:index/getAttackChallengeMode:getAttackChallengeMode", {
@@ -13,6 +29,22 @@ function getAttackChallengeMode(args, opts) {
     }, opts);
 }
 exports.getAttackChallengeMode = getAttackChallengeMode;
+/**
+ * Provides an Attack Challenge Mode resource.
+ *
+ * Attack Challenge Mode prevent malicious traffic by showing a verification challenge for every visitor.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getAttackChallengeMode({
+ *     projectId: exampleVercelProject.id,
+ * });
+ * ```
+ */
 function getAttackChallengeModeOutput(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invokeOutput("vercel:index/getAttackChallengeMode:getAttackChallengeMode", {

package/getAttackChallengeMode.js.map

@@ -1 +1 @@
-{"version":3,"file":"getAttackChallengeMode.js","sourceRoot":"","sources":["../getAttackChallengeMode.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,SAAgB,sBAAsB,CAAC,IAAgC,EAAE,IAA2B;IAChG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,4DAA4D,EAAE;QACvF,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,wDAMC;AAmBD,SAAgB,4BAA4B,CAAC,IAAsC,EAAE,IAA2B;IAC5G,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,4DAA4D,EAAE;QAC7F,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,oEAMC"}
+{"version":3,"file":"getAttackChallengeMode.js","sourceRoot":"","sources":["../getAttackChallengeMode.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,sBAAsB,CAAC,IAAgC,EAAE,IAA2B;IAChG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,4DAA4D,EAAE;QACvF,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,wDAMC;AAqCD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,4BAA4B,CAAC,IAAsC,EAAE,IAA2B;IAC5G,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,4DAA4D,EAAE;QAC7F,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,oEAMC"}

package/getCustomEnvironment.d.ts

@@ -1,31 +1,107 @@
 import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "./types/output";
+/**
+ * Provides information about an existing CustomEnvironment resource.
+ *
+ * An CustomEnvironment allows a `vercel.Deployment` to be accessed through a different URL.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getProject({
+ *     name: "example-project-with-custom-env",
+ * });
+ * const exampleGetCustomEnvironment = example.then(example => vercel.getCustomEnvironment({
+ *     projectId: example.id,
+ *     name: "example-custom-env",
+ * }));
+ * ```
+ */
 export declare function getCustomEnvironment(args: GetCustomEnvironmentArgs, opts?: pulumi.InvokeOptions): Promise<GetCustomEnvironmentResult>;
 /**
  * A collection of arguments for invoking getCustomEnvironment.
  */
 export interface GetCustomEnvironmentArgs {
+    /**
+     * The name of the environment.
+     */
     name: string;
+    /**
+     * The ID of the existing Vercel Project.
+     */
     projectId: string;
+    /**
+     * The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     teamId?: string;
 }
 /**
  * A collection of values returned by getCustomEnvironment.
  */
 export interface GetCustomEnvironmentResult {
+    /**
+     * The branch tracking configuration for the environment. When enabled, each qualifying merge will generate a deployment.
+     */
     readonly branchTracking: outputs.GetCustomEnvironmentBranchTracking;
+    /**
+     * A description of what the environment is.
+     */
     readonly description: string;
+    /**
+     * The ID of the environment.
+     */
     readonly id: string;
+    /**
+     * The name of the environment.
+     */
     readonly name: string;
+    /**
+     * The ID of the existing Vercel Project.
+     */
     readonly projectId: string;
+    /**
+     * The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     readonly teamId: string;
 }
+/**
+ * Provides information about an existing CustomEnvironment resource.
+ *
+ * An CustomEnvironment allows a `vercel.Deployment` to be accessed through a different URL.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getProject({
+ *     name: "example-project-with-custom-env",
+ * });
+ * const exampleGetCustomEnvironment = example.then(example => vercel.getCustomEnvironment({
+ *     projectId: example.id,
+ *     name: "example-custom-env",
+ * }));
+ * ```
+ */
 export declare function getCustomEnvironmentOutput(args: GetCustomEnvironmentOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetCustomEnvironmentResult>;
 /**
  * A collection of arguments for invoking getCustomEnvironment.
  */
 export interface GetCustomEnvironmentOutputArgs {
+    /**
+     * The name of the environment.
+     */
     name: pulumi.Input<string>;
+    /**
+     * The ID of the existing Vercel Project.
+     */
     projectId: pulumi.Input<string>;
+    /**
+     * The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
+     */
     teamId?: pulumi.Input<string>;
 }

package/getCustomEnvironment.js

@@ -5,6 +5,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCustomEnvironmentOutput = exports.getCustomEnvironment = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
+/**
+ * Provides information about an existing CustomEnvironment resource.
+ *
+ * An CustomEnvironment allows a `vercel.Deployment` to be accessed through a different URL.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getProject({
+ *     name: "example-project-with-custom-env",
+ * });
+ * const exampleGetCustomEnvironment = example.then(example => vercel.getCustomEnvironment({
+ *     projectId: example.id,
+ *     name: "example-custom-env",
+ * }));
+ * ```
+ */
 function getCustomEnvironment(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invoke("vercel:index/getCustomEnvironment:getCustomEnvironment", {
@@ -14,6 +34,26 @@ function getCustomEnvironment(args, opts) {
     }, opts);
 }
 exports.getCustomEnvironment = getCustomEnvironment;
+/**
+ * Provides information about an existing CustomEnvironment resource.
+ *
+ * An CustomEnvironment allows a `vercel.Deployment` to be accessed through a different URL.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getProject({
+ *     name: "example-project-with-custom-env",
+ * });
+ * const exampleGetCustomEnvironment = example.then(example => vercel.getCustomEnvironment({
+ *     projectId: example.id,
+ *     name: "example-custom-env",
+ * }));
+ * ```
+ */
 function getCustomEnvironmentOutput(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
     return pulumi.runtime.invokeOutput("vercel:index/getCustomEnvironment:getCustomEnvironment", {

package/getCustomEnvironment.js.map

@@ -1 +1 @@
-{"version":3,"file":"getCustomEnvironment.js","sourceRoot":"","sources":["../getCustomEnvironment.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC,SAAgB,oBAAoB,CAAC,IAA8B,EAAE,IAA2B;IAC5F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,wDAAwD,EAAE;QACnF,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,oDAOC;AAsBD,SAAgB,0BAA0B,CAAC,IAAoC,EAAE,IAA2B;IACxG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,wDAAwD,EAAE;QACzF,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,gEAOC"}
+{"version":3,"file":"getCustomEnvironment.js","sourceRoot":"","sources":["../getCustomEnvironment.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,oBAAoB,CAAC,IAA8B,EAAE,IAA2B;IAC5F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,wDAAwD,EAAE;QACnF,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,oDAOC;AAiDD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,0BAA0B,CAAC,IAAoC,EAAE,IAA2B;IACxG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,wDAAwD,EAAE;QACzF,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,gEAOC"}

package/getDeployment.d.ts

@@ -1,29 +1,94 @@
 import * as pulumi from "@pulumi/pulumi";
+/**
+ * Provides information about an existing Deployment.
+ *
+ * A Deployment is the result of building your Project and making it available through a live URL.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getDeployment({
+ *     id: "https://my-vercel-project.vercel.app",
+ * });
+ * ```
+ */
 export declare function getDeployment(args: GetDeploymentArgs, opts?: pulumi.InvokeOptions): Promise<GetDeploymentResult>;
 /**
  * A collection of arguments for invoking getDeployment.
  */
 export interface GetDeploymentArgs {
+    /**
+     * The ID or URL of the Deployment to read.
+     */
     id: string;
+    /**
+     * The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
+     */
     teamId?: string;
 }
 /**
  * A collection of values returned by getDeployment.
  */
 export interface GetDeploymentResult {
+    /**
+     * A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.
+     */
     readonly domains: string[];
+    /**
+     * The ID or URL of the Deployment to read.
+     */
     readonly id: string;
+    /**
+     * true if the deployment is a production deployment, meaning production aliases will be assigned.
+     */
     readonly production: boolean;
+    /**
+     * The project ID to add the deployment to.
+     */
     readonly projectId: string;
+    /**
+     * The branch or commit hash that has been deployed. Note this will only work if the project is configured to use a Git repository.
+     */
     readonly ref: string;
+    /**
+     * The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
+     */
     readonly teamId: string;
+    /**
+     * A unique URL that is automatically generated for a deployment.
+     */
     readonly url: string;
 }
+/**
+ * Provides information about an existing Deployment.
+ *
+ * A Deployment is the result of building your Project and making it available through a live URL.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as vercel from "@pulumi/vercel";
+ *
+ * const example = vercel.getDeployment({
+ *     id: "https://my-vercel-project.vercel.app",
+ * });
+ * ```
+ */
 export declare function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetDeploymentResult>;
 /**
  * A collection of arguments for invoking getDeployment.
  */
 export interface GetDeploymentOutputArgs {
+    /**
+     * The ID or URL of the Deployment to read.
+     */
     id: pulumi.Input<string>;
+    /**
+     * The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
+     */
     teamId?: pulumi.Input<string>;
 }