vercel

package
v1.3.0 Latest Latest
Warning

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

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

Documentation

Overview

Package vercel exports types, functions, subpackages for provisioning vercel resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Alias 

type Alias struct {
	pulumi.CustomResourceState

	// The Alias we want to assign to the deployment defined in the URL.
	Alias pulumi.StringOutput `pulumi:"alias"`
	// The id of the Deployment the Alias should be associated with.
	DeploymentId pulumi.StringOutput `pulumi:"deploymentId"`
	// 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.StringOutput `pulumi:"teamId"`
}

Provides an Alias resource.

An Alias allows a `Deployment` to be accessed through a different URL.

func GetAlias 

func GetAlias(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AliasState, opts ...pulumi.ResourceOption) (*Alias, error)

GetAlias gets an existing Alias 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 NewAlias 

func NewAlias(ctx *pulumi.Context,
	name string, args *AliasArgs, opts ...pulumi.ResourceOption) (*Alias, error)

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

func (*Alias) ElementType 

func (*Alias) ElementType() reflect.Type

func (*Alias) ToAliasOutput 

func (i *Alias) ToAliasOutput() AliasOutput

func (*Alias) ToAliasOutputWithContext 

func (i *Alias) ToAliasOutputWithContext(ctx context.Context) AliasOutput

type AliasArgs 

type AliasArgs struct {
	// The Alias we want to assign to the deployment defined in the URL.
	Alias pulumi.StringInput
	// The id of the Deployment the Alias should be associated with.
	DeploymentId pulumi.StringInput
	// 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.StringPtrInput
}

The set of arguments for constructing a Alias resource.

func (AliasArgs) ElementType 

func (AliasArgs) ElementType() reflect.Type

type AliasArray 

type AliasArray []AliasInput

func (AliasArray) ElementType 

func (AliasArray) ElementType() reflect.Type

func (AliasArray) ToAliasArrayOutput 

func (i AliasArray) ToAliasArrayOutput() AliasArrayOutput

func (AliasArray) ToAliasArrayOutputWithContext 

func (i AliasArray) ToAliasArrayOutputWithContext(ctx context.Context) AliasArrayOutput

type AliasArrayInput 

type AliasArrayInput interface {
	pulumi.Input

	ToAliasArrayOutput() AliasArrayOutput
	ToAliasArrayOutputWithContext(context.Context) AliasArrayOutput
}

AliasArrayInput is an input type that accepts AliasArray and AliasArrayOutput values. You can construct a concrete instance of `AliasArrayInput` via: 

AliasArray{ AliasArgs{...} }

type AliasArrayOutput 

type AliasArrayOutput struct{ *pulumi.OutputState }

func (AliasArrayOutput) ElementType 

func (AliasArrayOutput) ElementType() reflect.Type

func (AliasArrayOutput) Index 

func (o AliasArrayOutput) Index(i pulumi.IntInput) AliasOutput

func (AliasArrayOutput) ToAliasArrayOutput 

func (o AliasArrayOutput) ToAliasArrayOutput() AliasArrayOutput

func (AliasArrayOutput) ToAliasArrayOutputWithContext 

func (o AliasArrayOutput) ToAliasArrayOutputWithContext(ctx context.Context) AliasArrayOutput

type AliasInput 

type AliasInput interface {
	pulumi.Input

	ToAliasOutput() AliasOutput
	ToAliasOutputWithContext(ctx context.Context) AliasOutput
}

type AliasMap 

type AliasMap map[string]AliasInput

func (AliasMap) ElementType 

func (AliasMap) ElementType() reflect.Type

func (AliasMap) ToAliasMapOutput 

func (i AliasMap) ToAliasMapOutput() AliasMapOutput

func (AliasMap) ToAliasMapOutputWithContext 

func (i AliasMap) ToAliasMapOutputWithContext(ctx context.Context) AliasMapOutput

type AliasMapInput 

type AliasMapInput interface {
	pulumi.Input

	ToAliasMapOutput() AliasMapOutput
	ToAliasMapOutputWithContext(context.Context) AliasMapOutput
}

AliasMapInput is an input type that accepts AliasMap and AliasMapOutput values. You can construct a concrete instance of `AliasMapInput` via: 

AliasMap{ "key": AliasArgs{...} }

type AliasMapOutput 

type AliasMapOutput struct{ *pulumi.OutputState }

func (AliasMapOutput) ElementType 

func (AliasMapOutput) ElementType() reflect.Type

func (AliasMapOutput) MapIndex 

func (o AliasMapOutput) MapIndex(k pulumi.StringInput) AliasOutput

func (AliasMapOutput) ToAliasMapOutput 

func (o AliasMapOutput) ToAliasMapOutput() AliasMapOutput

func (AliasMapOutput) ToAliasMapOutputWithContext 

func (o AliasMapOutput) ToAliasMapOutputWithContext(ctx context.Context) AliasMapOutput

type AliasOutput 

type AliasOutput struct{ *pulumi.OutputState }

func (AliasOutput) Alias 

func (o AliasOutput) Alias() pulumi.StringOutput

The Alias we want to assign to the deployment defined in the URL.

func (AliasOutput) DeploymentId 

func (o AliasOutput) DeploymentId() pulumi.StringOutput

The id of the Deployment the Alias should be associated with.

func (AliasOutput) ElementType 

func (AliasOutput) ElementType() reflect.Type

func (AliasOutput) TeamId 

func (o AliasOutput) TeamId() pulumi.StringOutput

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.

func (AliasOutput) ToAliasOutput 

func (o AliasOutput) ToAliasOutput() AliasOutput

func (AliasOutput) ToAliasOutputWithContext 

func (o AliasOutput) ToAliasOutputWithContext(ctx context.Context) AliasOutput

type AliasState 

type AliasState struct {
	// The Alias we want to assign to the deployment defined in the URL.
	Alias pulumi.StringPtrInput
	// The id of the Deployment the Alias should be associated with.
	DeploymentId pulumi.StringPtrInput
	// 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.StringPtrInput
}

func (AliasState) ElementType 

func (AliasState) ElementType() reflect.Type

type Deployment 

type Deployment struct {
	pulumi.CustomResourceState

	// Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are
	// retained indefinitely. Note that deleted deployments are not recoverable.
	DeleteOnDestroy pulumi.BoolPtrOutput `pulumi:"deleteOnDestroy"`
	// A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.
	Domains pulumi.StringArrayOutput `pulumi:"domains"`
	// A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the `Project` resource.
	Environment pulumi.StringMapOutput `pulumi:"environment"`
	// A map of files to be uploaded for the deployment. This should be provided by a `getProjectDirectory` or `getFile` data source. Required if `gitSource` is not set.
	Files pulumi.StringMapOutput `pulumi:"files"`
	// If specified then the `pathPrefix` will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading `../`s will be stripped.
	PathPrefix pulumi.StringPtrOutput `pulumi:"pathPrefix"`
	// true if the deployment is a production deployment, meaning production aliases will be assigned.
	Production pulumi.BoolOutput `pulumi:"production"`
	// The project ID to add the deployment to.
	ProjectId pulumi.StringOutput `pulumi:"projectId"`
	// Project settings that will be applied to the deployment.
	ProjectSettings DeploymentProjectSettingsPtrOutput `pulumi:"projectSettings"`
	// The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if `ref` is not set.
	Ref pulumi.StringPtrOutput `pulumi:"ref"`
	// The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.
	TeamId pulumi.StringOutput `pulumi:"teamId"`
	// A unique URL that is automatically generated for a deployment.
	Url pulumi.StringOutput `pulumi:"url"`
}

func GetDeployment 

func GetDeployment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DeploymentState, opts ...pulumi.ResourceOption) (*Deployment, error)

GetDeployment gets an existing Deployment 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 NewDeployment 

func NewDeployment(ctx *pulumi.Context,
	name string, args *DeploymentArgs, opts ...pulumi.ResourceOption) (*Deployment, error)

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

func (*Deployment) ElementType 

func (*Deployment) ElementType() reflect.Type

func (*Deployment) ToDeploymentOutput 

func (i *Deployment) ToDeploymentOutput() DeploymentOutput

func (*Deployment) ToDeploymentOutputWithContext 

func (i *Deployment) ToDeploymentOutputWithContext(ctx context.Context) DeploymentOutput

type DeploymentArgs 

type DeploymentArgs struct {
	// Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are
	// retained indefinitely. Note that deleted deployments are not recoverable.
	DeleteOnDestroy pulumi.BoolPtrInput
	// A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the `Project` resource.
	Environment pulumi.StringMapInput
	// A map of files to be uploaded for the deployment. This should be provided by a `getProjectDirectory` or `getFile` data source. Required if `gitSource` is not set.
	Files pulumi.StringMapInput
	// If specified then the `pathPrefix` will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading `../`s will be stripped.
	PathPrefix pulumi.StringPtrInput
	// true if the deployment is a production deployment, meaning production aliases will be assigned.
	Production pulumi.BoolPtrInput
	// The project ID to add the deployment to.
	ProjectId pulumi.StringInput
	// Project settings that will be applied to the deployment.
	ProjectSettings DeploymentProjectSettingsPtrInput
	// The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if `ref` is not set.
	Ref pulumi.StringPtrInput
	// The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.
	TeamId pulumi.StringPtrInput
}

The set of arguments for constructing a Deployment resource.

func (DeploymentArgs) ElementType 

func (DeploymentArgs) ElementType() reflect.Type

type DeploymentArray 

type DeploymentArray []DeploymentInput

func (DeploymentArray) ElementType 

func (DeploymentArray) ElementType() reflect.Type

func (DeploymentArray) ToDeploymentArrayOutput 

func (i DeploymentArray) ToDeploymentArrayOutput() DeploymentArrayOutput

func (DeploymentArray) ToDeploymentArrayOutputWithContext 

func (i DeploymentArray) ToDeploymentArrayOutputWithContext(ctx context.Context) DeploymentArrayOutput

type DeploymentArrayInput 

type DeploymentArrayInput interface {
	pulumi.Input

	ToDeploymentArrayOutput() DeploymentArrayOutput
	ToDeploymentArrayOutputWithContext(context.Context) DeploymentArrayOutput
}

DeploymentArrayInput is an input type that accepts DeploymentArray and DeploymentArrayOutput values. You can construct a concrete instance of `DeploymentArrayInput` via: 

DeploymentArray{ DeploymentArgs{...} }

type DeploymentArrayOutput 

type DeploymentArrayOutput struct{ *pulumi.OutputState }

func (DeploymentArrayOutput) ElementType 

func (DeploymentArrayOutput) ElementType() reflect.Type

func (DeploymentArrayOutput) Index 

func (o DeploymentArrayOutput) Index(i pulumi.IntInput) DeploymentOutput

func (DeploymentArrayOutput) ToDeploymentArrayOutput 

func (o DeploymentArrayOutput) ToDeploymentArrayOutput() DeploymentArrayOutput

func (DeploymentArrayOutput) ToDeploymentArrayOutputWithContext 

func (o DeploymentArrayOutput) ToDeploymentArrayOutputWithContext(ctx context.Context) DeploymentArrayOutput

type DeploymentInput 

type DeploymentInput interface {
	pulumi.Input

	ToDeploymentOutput() DeploymentOutput
	ToDeploymentOutputWithContext(ctx context.Context) DeploymentOutput
}

type DeploymentMap 

type DeploymentMap map[string]DeploymentInput

func (DeploymentMap) ElementType 

func (DeploymentMap) ElementType() reflect.Type

func (DeploymentMap) ToDeploymentMapOutput 

func (i DeploymentMap) ToDeploymentMapOutput() DeploymentMapOutput

func (DeploymentMap) ToDeploymentMapOutputWithContext 

func (i DeploymentMap) ToDeploymentMapOutputWithContext(ctx context.Context) DeploymentMapOutput

type DeploymentMapInput 

type DeploymentMapInput interface {
	pulumi.Input

	ToDeploymentMapOutput() DeploymentMapOutput
	ToDeploymentMapOutputWithContext(context.Context) DeploymentMapOutput
}

DeploymentMapInput is an input type that accepts DeploymentMap and DeploymentMapOutput values. You can construct a concrete instance of `DeploymentMapInput` via: 

DeploymentMap{ "key": DeploymentArgs{...} }

type DeploymentMapOutput 

type DeploymentMapOutput struct{ *pulumi.OutputState }

func (DeploymentMapOutput) ElementType 

func (DeploymentMapOutput) ElementType() reflect.Type

func (DeploymentMapOutput) MapIndex 

func (o DeploymentMapOutput) MapIndex(k pulumi.StringInput) DeploymentOutput

func (DeploymentMapOutput) ToDeploymentMapOutput 

func (o DeploymentMapOutput) ToDeploymentMapOutput() DeploymentMapOutput

func (DeploymentMapOutput) ToDeploymentMapOutputWithContext 

func (o DeploymentMapOutput) ToDeploymentMapOutputWithContext(ctx context.Context) DeploymentMapOutput

type DeploymentOutput 

type DeploymentOutput struct{ *pulumi.OutputState }

func (DeploymentOutput) DeleteOnDestroy 

func (o DeploymentOutput) DeleteOnDestroy() pulumi.BoolPtrOutput

Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are retained indefinitely. Note that deleted deployments are not recoverable.

func (DeploymentOutput) Domains 

func (o DeploymentOutput) Domains() pulumi.StringArrayOutput

A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.

func (DeploymentOutput) ElementType 

func (DeploymentOutput) ElementType() reflect.Type

func (DeploymentOutput) Environment 

func (o DeploymentOutput) Environment() pulumi.StringMapOutput

A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the `Project` resource.

func (DeploymentOutput) Files 

func (o DeploymentOutput) Files() pulumi.StringMapOutput

A map of files to be uploaded for the deployment. This should be provided by a `getProjectDirectory` or `getFile` data source. Required if `gitSource` is not set.

func (DeploymentOutput) PathPrefix 

func (o DeploymentOutput) PathPrefix() pulumi.StringPtrOutput

If specified then the `pathPrefix` will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading `../`s will be stripped.

func (DeploymentOutput) Production 

func (o DeploymentOutput) Production() pulumi.BoolOutput

true if the deployment is a production deployment, meaning production aliases will be assigned.

func (DeploymentOutput) ProjectId 

func (o DeploymentOutput) ProjectId() pulumi.StringOutput

The project ID to add the deployment to.

func (DeploymentOutput) ProjectSettings 

func (o DeploymentOutput) ProjectSettings() DeploymentProjectSettingsPtrOutput

Project settings that will be applied to the deployment.

func (DeploymentOutput) Ref 

func (o DeploymentOutput) Ref() pulumi.StringPtrOutput

The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if `ref` is not set.

func (DeploymentOutput) TeamId 

func (o DeploymentOutput) TeamId() pulumi.StringOutput

The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.

func (DeploymentOutput) ToDeploymentOutput 

func (o DeploymentOutput) ToDeploymentOutput() DeploymentOutput

func (DeploymentOutput) ToDeploymentOutputWithContext 

func (o DeploymentOutput) ToDeploymentOutputWithContext(ctx context.Context) DeploymentOutput

func (DeploymentOutput) Url 

func (o DeploymentOutput) Url() pulumi.StringOutput

A unique URL that is automatically generated for a deployment.

type DeploymentProjectSettings 

type DeploymentProjectSettings struct {
	// The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.
	BuildCommand *string `pulumi:"buildCommand"`
	// The framework that is being used for this deployment. If omitted, no framework is selected.
	Framework *string `pulumi:"framework"`
	// The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.
	InstallCommand *string `pulumi:"installCommand"`
	// The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.
	OutputDirectory *string `pulumi:"outputDirectory"`
	// The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.
	RootDirectory *string `pulumi:"rootDirectory"`
}

type DeploymentProjectSettingsArgs 

type DeploymentProjectSettingsArgs struct {
	// The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.
	BuildCommand pulumi.StringPtrInput `pulumi:"buildCommand"`
	// The framework that is being used for this deployment. If omitted, no framework is selected.
	Framework pulumi.StringPtrInput `pulumi:"framework"`
	// The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.
	InstallCommand pulumi.StringPtrInput `pulumi:"installCommand"`
	// The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.
	OutputDirectory pulumi.StringPtrInput `pulumi:"outputDirectory"`
	// The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.
	RootDirectory pulumi.StringPtrInput `pulumi:"rootDirectory"`
}

func (DeploymentProjectSettingsArgs) ElementType 

func (DeploymentProjectSettingsArgs) ElementType() reflect.Type

func (DeploymentProjectSettingsArgs) ToDeploymentProjectSettingsOutput 

func (i DeploymentProjectSettingsArgs) ToDeploymentProjectSettingsOutput() DeploymentProjectSettingsOutput

func (DeploymentProjectSettingsArgs) ToDeploymentProjectSettingsOutputWithContext 

func (i DeploymentProjectSettingsArgs) ToDeploymentProjectSettingsOutputWithContext(ctx context.Context) DeploymentProjectSettingsOutput

func (DeploymentProjectSettingsArgs) ToDeploymentProjectSettingsPtrOutput 

func (i DeploymentProjectSettingsArgs) ToDeploymentProjectSettingsPtrOutput() DeploymentProjectSettingsPtrOutput

func (DeploymentProjectSettingsArgs) ToDeploymentProjectSettingsPtrOutputWithContext 

func (i DeploymentProjectSettingsArgs) ToDeploymentProjectSettingsPtrOutputWithContext(ctx context.Context) DeploymentProjectSettingsPtrOutput

type DeploymentProjectSettingsInput 

type DeploymentProjectSettingsInput interface {
	pulumi.Input

	ToDeploymentProjectSettingsOutput() DeploymentProjectSettingsOutput
	ToDeploymentProjectSettingsOutputWithContext(context.Context) DeploymentProjectSettingsOutput
}

DeploymentProjectSettingsInput is an input type that accepts DeploymentProjectSettingsArgs and DeploymentProjectSettingsOutput values. You can construct a concrete instance of `DeploymentProjectSettingsInput` via: 

DeploymentProjectSettingsArgs{...}

type DeploymentProjectSettingsOutput 

type DeploymentProjectSettingsOutput struct{ *pulumi.OutputState }

func (DeploymentProjectSettingsOutput) BuildCommand 

func (o DeploymentProjectSettingsOutput) BuildCommand() pulumi.StringPtrOutput

The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.

func (DeploymentProjectSettingsOutput) ElementType 

func (DeploymentProjectSettingsOutput) ElementType() reflect.Type

func (DeploymentProjectSettingsOutput) Framework 

func (o DeploymentProjectSettingsOutput) Framework() pulumi.StringPtrOutput

The framework that is being used for this deployment. If omitted, no framework is selected.

func (DeploymentProjectSettingsOutput) InstallCommand 

func (o DeploymentProjectSettingsOutput) InstallCommand() pulumi.StringPtrOutput

The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.

func (DeploymentProjectSettingsOutput) OutputDirectory 

func (o DeploymentProjectSettingsOutput) OutputDirectory() pulumi.StringPtrOutput

The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.

func (DeploymentProjectSettingsOutput) RootDirectory 

func (o DeploymentProjectSettingsOutput) RootDirectory() pulumi.StringPtrOutput

The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.

func (DeploymentProjectSettingsOutput) ToDeploymentProjectSettingsOutput 

func (o DeploymentProjectSettingsOutput) ToDeploymentProjectSettingsOutput() DeploymentProjectSettingsOutput

func (DeploymentProjectSettingsOutput) ToDeploymentProjectSettingsOutputWithContext 

func (o DeploymentProjectSettingsOutput) ToDeploymentProjectSettingsOutputWithContext(ctx context.Context) DeploymentProjectSettingsOutput

func (DeploymentProjectSettingsOutput) ToDeploymentProjectSettingsPtrOutput 

func (o DeploymentProjectSettingsOutput) ToDeploymentProjectSettingsPtrOutput() DeploymentProjectSettingsPtrOutput

func (DeploymentProjectSettingsOutput) ToDeploymentProjectSettingsPtrOutputWithContext 

func (o DeploymentProjectSettingsOutput) ToDeploymentProjectSettingsPtrOutputWithContext(ctx context.Context) DeploymentProjectSettingsPtrOutput

type DeploymentProjectSettingsPtrInput 

type DeploymentProjectSettingsPtrInput interface {
	pulumi.Input

	ToDeploymentProjectSettingsPtrOutput() DeploymentProjectSettingsPtrOutput
	ToDeploymentProjectSettingsPtrOutputWithContext(context.Context) DeploymentProjectSettingsPtrOutput
}

DeploymentProjectSettingsPtrInput is an input type that accepts DeploymentProjectSettingsArgs, DeploymentProjectSettingsPtr and DeploymentProjectSettingsPtrOutput values. You can construct a concrete instance of `DeploymentProjectSettingsPtrInput` via: 

        DeploymentProjectSettingsArgs{...}

or:

        nil

func DeploymentProjectSettingsPtr 

func DeploymentProjectSettingsPtr(v *DeploymentProjectSettingsArgs) DeploymentProjectSettingsPtrInput

type DeploymentProjectSettingsPtrOutput 

type DeploymentProjectSettingsPtrOutput struct{ *pulumi.OutputState }

func (DeploymentProjectSettingsPtrOutput) BuildCommand 

func (o DeploymentProjectSettingsPtrOutput) BuildCommand() pulumi.StringPtrOutput

The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.

func (DeploymentProjectSettingsPtrOutput) Elem 

func (o DeploymentProjectSettingsPtrOutput) Elem() DeploymentProjectSettingsOutput

func (DeploymentProjectSettingsPtrOutput) ElementType 

func (DeploymentProjectSettingsPtrOutput) ElementType() reflect.Type

func (DeploymentProjectSettingsPtrOutput) Framework 

func (o DeploymentProjectSettingsPtrOutput) Framework() pulumi.StringPtrOutput

The framework that is being used for this deployment. If omitted, no framework is selected.

func (DeploymentProjectSettingsPtrOutput) InstallCommand 

func (o DeploymentProjectSettingsPtrOutput) InstallCommand() pulumi.StringPtrOutput

The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.

func (DeploymentProjectSettingsPtrOutput) OutputDirectory 

func (o DeploymentProjectSettingsPtrOutput) OutputDirectory() pulumi.StringPtrOutput

The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.

func (DeploymentProjectSettingsPtrOutput) RootDirectory 

func (o DeploymentProjectSettingsPtrOutput) RootDirectory() pulumi.StringPtrOutput

The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.

func (DeploymentProjectSettingsPtrOutput) ToDeploymentProjectSettingsPtrOutput 

func (o DeploymentProjectSettingsPtrOutput) ToDeploymentProjectSettingsPtrOutput() DeploymentProjectSettingsPtrOutput

func (DeploymentProjectSettingsPtrOutput) ToDeploymentProjectSettingsPtrOutputWithContext 

func (o DeploymentProjectSettingsPtrOutput) ToDeploymentProjectSettingsPtrOutputWithContext(ctx context.Context) DeploymentProjectSettingsPtrOutput

type DeploymentState 

type DeploymentState struct {
	// Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are
	// retained indefinitely. Note that deleted deployments are not recoverable.
	DeleteOnDestroy pulumi.BoolPtrInput
	// A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.
	Domains pulumi.StringArrayInput
	// A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the `Project` resource.
	Environment pulumi.StringMapInput
	// A map of files to be uploaded for the deployment. This should be provided by a `getProjectDirectory` or `getFile` data source. Required if `gitSource` is not set.
	Files pulumi.StringMapInput
	// If specified then the `pathPrefix` will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading `../`s will be stripped.
	PathPrefix pulumi.StringPtrInput
	// true if the deployment is a production deployment, meaning production aliases will be assigned.
	Production pulumi.BoolPtrInput
	// The project ID to add the deployment to.
	ProjectId pulumi.StringPtrInput
	// Project settings that will be applied to the deployment.
	ProjectSettings DeploymentProjectSettingsPtrInput
	// The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if `ref` is not set.
	Ref pulumi.StringPtrInput
	// The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.
	TeamId pulumi.StringPtrInput
	// A unique URL that is automatically generated for a deployment.
	Url pulumi.StringPtrInput
}

func (DeploymentState) ElementType 

func (DeploymentState) ElementType() reflect.Type

type DnsRecord 

type DnsRecord struct {
	pulumi.CustomResourceState

	// A comment explaining what the DNS record is for.
	Comment pulumi.StringOutput `pulumi:"comment"`
	// The domain name, or zone, that the DNS record should be created beneath.
	Domain pulumi.StringOutput `pulumi:"domain"`
	// The priority of the MX record. The priority specifies the sequence that an email server receives emails. A smaller value indicates a higher priority.
	MxPriority pulumi.IntPtrOutput `pulumi:"mxPriority"`
	// The subdomain name of the record. This should be an empty string if the rercord is for the root domain.
	Name pulumi.StringOutput `pulumi:"name"`
	// Settings for an SRV record.
	Srv DnsRecordSrvPtrOutput `pulumi:"srv"`
	// The team ID that the domain and DNS records belong to. Required when configuring a team resource if a default team has not been set in the provider.
	TeamId pulumi.StringOutput `pulumi:"teamId"`
	// The TTL value in seconds. Must be a number between 60 and 2147483647. If unspecified, it will default to 60 seconds.
	Ttl pulumi.IntOutput `pulumi:"ttl"`
	// The type of DNS record. Available types: `A`, `AAAA`, `ALIAS`, `CAA`, `CNAME`, `MX`, `NS`, `SRV`, `TXT`.
	Type pulumi.StringOutput `pulumi:"type"`
	// The value of the DNS record. The format depends on the 'type' property.
	// For an 'A' record, this should be a valid IPv4 address.
	// For an 'AAAA' record, this should be an IPv6 address.
	// For 'ALIAS' records, this should be a hostname.
	// For 'CAA' records, this should specify specify which Certificate Authorities (CAs) are allowed to issue certificates for the domain.
	// For 'CNAME' records, this should be a different domain name.
	// For 'MX' records, this should specify the mail server responsible for accepting messages on behalf of the domain name.
	// For 'TXT' records, this can contain arbitrary text.
	Value pulumi.StringPtrOutput `pulumi:"value"`
}

Provides a DNS Record resource.

DNS records are instructions that live in authoritative DNS servers and provide information about a domain.

> The `value` field must be specified on all DNS record types except `SRV`. When using `SRV` DNS records, the `srv` field must be specified.

For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/concepts/projects/custom-domains#dns-records)

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-vercel/sdk/go/vercel"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vercel.NewDnsRecord(ctx, "dnsRecord", &vercel.DnsRecordArgs{
			Domain: pulumi.String("example.com"),
			Ttl:    pulumi.Int(60),
			Type:   pulumi.String("A"),
			Value:  pulumi.String("192.168.0.1"),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewDnsRecord(ctx, "aaaa", &vercel.DnsRecordArgs{
			Domain: pulumi.String("example.com"),
			Ttl:    pulumi.Int(60),
			Type:   pulumi.String("AAAA"),
			Value:  pulumi.String("::0"),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewDnsRecord(ctx, "alias", &vercel.DnsRecordArgs{
			Domain: pulumi.String("example.com"),
			Ttl:    pulumi.Int(60),
			Type:   pulumi.String("ALIAS"),
			Value:  pulumi.String("example2.com."),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewDnsRecord(ctx, "caa", &vercel.DnsRecordArgs{
			Domain: pulumi.String("example.com"),
			Ttl:    pulumi.Int(60),
			Type:   pulumi.String("CAA"),
			Value:  pulumi.String("1 issue \"letsencrypt.org\""),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewDnsRecord(ctx, "cname", &vercel.DnsRecordArgs{
			Domain: pulumi.String("example.com"),
			Ttl:    pulumi.Int(60),
			Type:   pulumi.String("CNAME"),
			Value:  pulumi.String("example2.com."),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewDnsRecord(ctx, "mx", &vercel.DnsRecordArgs{
			Domain:     pulumi.String("example.com"),
			MxPriority: pulumi.Int(333),
			Ttl:        pulumi.Int(60),
			Type:       pulumi.String("MX"),
			Value:      pulumi.String("example2.com."),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewDnsRecord(ctx, "srv", &vercel.DnsRecordArgs{
			Domain: pulumi.String("example.com"),
			Srv: &vercel.DnsRecordSrvArgs{
				Port:     pulumi.Int(6000),
				Priority: pulumi.Int(127),
				Target:   pulumi.String("example2.com."),
				Weight:   pulumi.Int(60),
			},
			Ttl:  pulumi.Int(60),
			Type: pulumi.String("SRV"),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewDnsRecord(ctx, "txt", &vercel.DnsRecordArgs{
			Domain: pulumi.String("example.com"),
			Ttl:    pulumi.Int(60),
			Type:   pulumi.String("TXT"),
			Value:  pulumi.String("some text value"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

If importing into a personal account, or with a team configured on

the provider, simply use the record id.

- record_id is hard to find, but can be taken from the network tab, inside developer tools, on the domains page.

```sh $ pulumi import vercel:index/dnsRecord:DnsRecord example rec_xxxxxxxxxxxxxxxxxxxxxxxxxxxx ```

Alternatively, you can import via the team_id and record_id.

- team_id can be found in the team `settings` tab in the Vercel UI.

- record_id is hard to find, but can be taken from the network tab, inside developer tools, on the domains page.

```sh $ pulumi import vercel:index/dnsRecord:DnsRecord example team_xxxxxxxxxxxxxxxxxxxxxxxx/rec_xxxxxxxxxxxxxxxxxxxxxxxxxxxx ```

func GetDnsRecord 

func GetDnsRecord(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DnsRecordState, opts ...pulumi.ResourceOption) (*DnsRecord, error)

GetDnsRecord gets an existing DnsRecord 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 NewDnsRecord 

func NewDnsRecord(ctx *pulumi.Context,
	name string, args *DnsRecordArgs, opts ...pulumi.ResourceOption) (*DnsRecord, error)

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

func (*DnsRecord) ElementType 

func (*DnsRecord) ElementType() reflect.Type

func (*DnsRecord) ToDnsRecordOutput 

func (i *DnsRecord) ToDnsRecordOutput() DnsRecordOutput

func (*DnsRecord) ToDnsRecordOutputWithContext 

func (i *DnsRecord) ToDnsRecordOutputWithContext(ctx context.Context) DnsRecordOutput

type DnsRecordArgs 

type DnsRecordArgs struct {
	// A comment explaining what the DNS record is for.
	Comment pulumi.StringPtrInput
	// The domain name, or zone, that the DNS record should be created beneath.
	Domain pulumi.StringInput
	// The priority of the MX record. The priority specifies the sequence that an email server receives emails. A smaller value indicates a higher priority.
	MxPriority pulumi.IntPtrInput
	// The subdomain name of the record. This should be an empty string if the rercord is for the root domain.
	Name pulumi.StringPtrInput
	// Settings for an SRV record.
	Srv DnsRecordSrvPtrInput
	// The team ID that the domain and DNS records belong to. Required when configuring a team resource if a default team has not been set in the provider.
	TeamId pulumi.StringPtrInput
	// The TTL value in seconds. Must be a number between 60 and 2147483647. If unspecified, it will default to 60 seconds.
	Ttl pulumi.IntPtrInput
	// The type of DNS record. Available types: `A`, `AAAA`, `ALIAS`, `CAA`, `CNAME`, `MX`, `NS`, `SRV`, `TXT`.
	Type pulumi.StringInput
	// The value of the DNS record. The format depends on the 'type' property.
	// For an 'A' record, this should be a valid IPv4 address.
	// For an 'AAAA' record, this should be an IPv6 address.
	// For 'ALIAS' records, this should be a hostname.
	// For 'CAA' records, this should specify specify which Certificate Authorities (CAs) are allowed to issue certificates for the domain.
	// For 'CNAME' records, this should be a different domain name.
	// For 'MX' records, this should specify the mail server responsible for accepting messages on behalf of the domain name.
	// For 'TXT' records, this can contain arbitrary text.
	Value pulumi.StringPtrInput
}

The set of arguments for constructing a DnsRecord resource.

func (DnsRecordArgs) ElementType 

func (DnsRecordArgs) ElementType() reflect.Type

type DnsRecordArray 

type DnsRecordArray []DnsRecordInput

func (DnsRecordArray) ElementType 

func (DnsRecordArray) ElementType() reflect.Type

func (DnsRecordArray) ToDnsRecordArrayOutput 

func (i DnsRecordArray) ToDnsRecordArrayOutput() DnsRecordArrayOutput

func (DnsRecordArray) ToDnsRecordArrayOutputWithContext 

func (i DnsRecordArray) ToDnsRecordArrayOutputWithContext(ctx context.Context) DnsRecordArrayOutput

type DnsRecordArrayInput 

type DnsRecordArrayInput interface {
	pulumi.Input

	ToDnsRecordArrayOutput() DnsRecordArrayOutput
	ToDnsRecordArrayOutputWithContext(context.Context) DnsRecordArrayOutput
}

DnsRecordArrayInput is an input type that accepts DnsRecordArray and DnsRecordArrayOutput values. You can construct a concrete instance of `DnsRecordArrayInput` via: 

DnsRecordArray{ DnsRecordArgs{...} }

type DnsRecordArrayOutput 

type DnsRecordArrayOutput struct{ *pulumi.OutputState }

func (DnsRecordArrayOutput) ElementType 

func (DnsRecordArrayOutput) ElementType() reflect.Type

func (DnsRecordArrayOutput) Index 

func (o DnsRecordArrayOutput) Index(i pulumi.IntInput) DnsRecordOutput

func (DnsRecordArrayOutput) ToDnsRecordArrayOutput 

func (o DnsRecordArrayOutput) ToDnsRecordArrayOutput() DnsRecordArrayOutput

func (DnsRecordArrayOutput) ToDnsRecordArrayOutputWithContext 

func (o DnsRecordArrayOutput) ToDnsRecordArrayOutputWithContext(ctx context.Context) DnsRecordArrayOutput

type DnsRecordInput 

type DnsRecordInput interface {
	pulumi.Input

	ToDnsRecordOutput() DnsRecordOutput
	ToDnsRecordOutputWithContext(ctx context.Context) DnsRecordOutput
}

type DnsRecordMap 

type DnsRecordMap map[string]DnsRecordInput

func (DnsRecordMap) ElementType 

func (DnsRecordMap) ElementType() reflect.Type

func (DnsRecordMap) ToDnsRecordMapOutput 

func (i DnsRecordMap) ToDnsRecordMapOutput() DnsRecordMapOutput

func (DnsRecordMap) ToDnsRecordMapOutputWithContext 

func (i DnsRecordMap) ToDnsRecordMapOutputWithContext(ctx context.Context) DnsRecordMapOutput

type DnsRecordMapInput 

type DnsRecordMapInput interface {
	pulumi.Input

	ToDnsRecordMapOutput() DnsRecordMapOutput
	ToDnsRecordMapOutputWithContext(context.Context) DnsRecordMapOutput
}

DnsRecordMapInput is an input type that accepts DnsRecordMap and DnsRecordMapOutput values. You can construct a concrete instance of `DnsRecordMapInput` via: 

DnsRecordMap{ "key": DnsRecordArgs{...} }

type DnsRecordMapOutput 

type DnsRecordMapOutput struct{ *pulumi.OutputState }

func (DnsRecordMapOutput) ElementType 

func (DnsRecordMapOutput) ElementType() reflect.Type

func (DnsRecordMapOutput) MapIndex 

func (o DnsRecordMapOutput) MapIndex(k pulumi.StringInput) DnsRecordOutput

func (DnsRecordMapOutput) ToDnsRecordMapOutput 

func (o DnsRecordMapOutput) ToDnsRecordMapOutput() DnsRecordMapOutput

func (DnsRecordMapOutput) ToDnsRecordMapOutputWithContext 

func (o DnsRecordMapOutput) ToDnsRecordMapOutputWithContext(ctx context.Context) DnsRecordMapOutput

type DnsRecordOutput 

type DnsRecordOutput struct{ *pulumi.OutputState }

func (DnsRecordOutput) Comment added in v1.3.0 

func (o DnsRecordOutput) Comment() pulumi.StringOutput

A comment explaining what the DNS record is for.

func (DnsRecordOutput) Domain 

func (o DnsRecordOutput) Domain() pulumi.StringOutput

The domain name, or zone, that the DNS record should be created beneath.

func (DnsRecordOutput) ElementType 

func (DnsRecordOutput) ElementType() reflect.Type

func (DnsRecordOutput) MxPriority 

func (o DnsRecordOutput) MxPriority() pulumi.IntPtrOutput

The priority of the MX record. The priority specifies the sequence that an email server receives emails. A smaller value indicates a higher priority.

func (DnsRecordOutput) Name 

func (o DnsRecordOutput) Name() pulumi.StringOutput

The subdomain name of the record. This should be an empty string if the rercord is for the root domain.

func (DnsRecordOutput) Srv 

func (o DnsRecordOutput) Srv() DnsRecordSrvPtrOutput

Settings for an SRV record.

func (DnsRecordOutput) TeamId 

func (o DnsRecordOutput) TeamId() pulumi.StringOutput

The team ID that the domain and DNS records belong to. Required when configuring a team resource if a default team has not been set in the provider.

func (DnsRecordOutput) ToDnsRecordOutput 

func (o DnsRecordOutput) ToDnsRecordOutput() DnsRecordOutput

func (DnsRecordOutput) ToDnsRecordOutputWithContext 

func (o DnsRecordOutput) ToDnsRecordOutputWithContext(ctx context.Context) DnsRecordOutput

func (DnsRecordOutput) Ttl 

func (o DnsRecordOutput) Ttl() pulumi.IntOutput

The TTL value in seconds. Must be a number between 60 and 2147483647. If unspecified, it will default to 60 seconds.

func (DnsRecordOutput) Type 

func (o DnsRecordOutput) Type() pulumi.StringOutput

The type of DNS record. Available types: `A`, `AAAA`, `ALIAS`, `CAA`, `CNAME`, `MX`, `NS`, `SRV`, `TXT`.

func (DnsRecordOutput) Value 

func (o DnsRecordOutput) Value() pulumi.StringPtrOutput

The value of the DNS record. The format depends on the 'type' property. For an 'A' record, this should be a valid IPv4 address. For an 'AAAA' record, this should be an IPv6 address. For 'ALIAS' records, this should be a hostname. For 'CAA' records, this should specify specify which Certificate Authorities (CAs) are allowed to issue certificates for the domain. For 'CNAME' records, this should be a different domain name. For 'MX' records, this should specify the mail server responsible for accepting messages on behalf of the domain name. For 'TXT' records, this can contain arbitrary text.

type DnsRecordSrv 

type DnsRecordSrv struct {
	// The TCP or UDP port on which the service is to be found.
	Port int `pulumi:"port"`
	// The priority of the target host, lower value means more preferred.
	Priority int `pulumi:"priority"`
	// The canonical hostname of the machine providing the service, ending in a dot.
	Target string `pulumi:"target"`
	// A relative weight for records with the same priority, higher value means higher chance of getting picked.
	Weight int `pulumi:"weight"`
}

type DnsRecordSrvArgs 

type DnsRecordSrvArgs struct {
	// The TCP or UDP port on which the service is to be found.
	Port pulumi.IntInput `pulumi:"port"`
	// The priority of the target host, lower value means more preferred.
	Priority pulumi.IntInput `pulumi:"priority"`
	// The canonical hostname of the machine providing the service, ending in a dot.
	Target pulumi.StringInput `pulumi:"target"`
	// A relative weight for records with the same priority, higher value means higher chance of getting picked.
	Weight pulumi.IntInput `pulumi:"weight"`
}

func (DnsRecordSrvArgs) ElementType 

func (DnsRecordSrvArgs) ElementType() reflect.Type

func (DnsRecordSrvArgs) ToDnsRecordSrvOutput 

func (i DnsRecordSrvArgs) ToDnsRecordSrvOutput() DnsRecordSrvOutput

func (DnsRecordSrvArgs) ToDnsRecordSrvOutputWithContext 

func (i DnsRecordSrvArgs) ToDnsRecordSrvOutputWithContext(ctx context.Context) DnsRecordSrvOutput

func (DnsRecordSrvArgs) ToDnsRecordSrvPtrOutput 

func (i DnsRecordSrvArgs) ToDnsRecordSrvPtrOutput() DnsRecordSrvPtrOutput

func (DnsRecordSrvArgs) ToDnsRecordSrvPtrOutputWithContext 

func (i DnsRecordSrvArgs) ToDnsRecordSrvPtrOutputWithContext(ctx context.Context) DnsRecordSrvPtrOutput

type DnsRecordSrvInput 

type DnsRecordSrvInput interface {
	pulumi.Input

	ToDnsRecordSrvOutput() DnsRecordSrvOutput
	ToDnsRecordSrvOutputWithContext(context.Context) DnsRecordSrvOutput
}

DnsRecordSrvInput is an input type that accepts DnsRecordSrvArgs and DnsRecordSrvOutput values. You can construct a concrete instance of `DnsRecordSrvInput` via: 

DnsRecordSrvArgs{...}

type DnsRecordSrvOutput 

type DnsRecordSrvOutput struct{ *pulumi.OutputState }

func (DnsRecordSrvOutput) ElementType 

func (DnsRecordSrvOutput) ElementType() reflect.Type

func (DnsRecordSrvOutput) Port 

func (o DnsRecordSrvOutput) Port() pulumi.IntOutput

The TCP or UDP port on which the service is to be found.

func (DnsRecordSrvOutput) Priority 

func (o DnsRecordSrvOutput) Priority() pulumi.IntOutput

The priority of the target host, lower value means more preferred.

func (DnsRecordSrvOutput) Target 

func (o DnsRecordSrvOutput) Target() pulumi.StringOutput

The canonical hostname of the machine providing the service, ending in a dot.

func (DnsRecordSrvOutput) ToDnsRecordSrvOutput 

func (o DnsRecordSrvOutput) ToDnsRecordSrvOutput() DnsRecordSrvOutput

func (DnsRecordSrvOutput) ToDnsRecordSrvOutputWithContext 

func (o DnsRecordSrvOutput) ToDnsRecordSrvOutputWithContext(ctx context.Context) DnsRecordSrvOutput

func (DnsRecordSrvOutput) ToDnsRecordSrvPtrOutput 

func (o DnsRecordSrvOutput) ToDnsRecordSrvPtrOutput() DnsRecordSrvPtrOutput

func (DnsRecordSrvOutput) ToDnsRecordSrvPtrOutputWithContext 

func (o DnsRecordSrvOutput) ToDnsRecordSrvPtrOutputWithContext(ctx context.Context) DnsRecordSrvPtrOutput

func (DnsRecordSrvOutput) Weight 

func (o DnsRecordSrvOutput) Weight() pulumi.IntOutput

A relative weight for records with the same priority, higher value means higher chance of getting picked.

type DnsRecordSrvPtrInput 

type DnsRecordSrvPtrInput interface {
	pulumi.Input

	ToDnsRecordSrvPtrOutput() DnsRecordSrvPtrOutput
	ToDnsRecordSrvPtrOutputWithContext(context.Context) DnsRecordSrvPtrOutput
}

DnsRecordSrvPtrInput is an input type that accepts DnsRecordSrvArgs, DnsRecordSrvPtr and DnsRecordSrvPtrOutput values. You can construct a concrete instance of `DnsRecordSrvPtrInput` via: 

        DnsRecordSrvArgs{...}

or:

        nil

func DnsRecordSrvPtr 

func DnsRecordSrvPtr(v *DnsRecordSrvArgs) DnsRecordSrvPtrInput

type DnsRecordSrvPtrOutput 

type DnsRecordSrvPtrOutput struct{ *pulumi.OutputState }

func (DnsRecordSrvPtrOutput) Elem 

func (o DnsRecordSrvPtrOutput) Elem() DnsRecordSrvOutput

func (DnsRecordSrvPtrOutput) ElementType 

func (DnsRecordSrvPtrOutput) ElementType() reflect.Type

func (DnsRecordSrvPtrOutput) Port 

func (o DnsRecordSrvPtrOutput) Port() pulumi.IntPtrOutput

The TCP or UDP port on which the service is to be found.

func (DnsRecordSrvPtrOutput) Priority 

func (o DnsRecordSrvPtrOutput) Priority() pulumi.IntPtrOutput

The priority of the target host, lower value means more preferred.

func (DnsRecordSrvPtrOutput) Target 

func (o DnsRecordSrvPtrOutput) Target() pulumi.StringPtrOutput

The canonical hostname of the machine providing the service, ending in a dot.

func (DnsRecordSrvPtrOutput) ToDnsRecordSrvPtrOutput 

func (o DnsRecordSrvPtrOutput) ToDnsRecordSrvPtrOutput() DnsRecordSrvPtrOutput

func (DnsRecordSrvPtrOutput) ToDnsRecordSrvPtrOutputWithContext 

func (o DnsRecordSrvPtrOutput) ToDnsRecordSrvPtrOutputWithContext(ctx context.Context) DnsRecordSrvPtrOutput

func (DnsRecordSrvPtrOutput) Weight 

func (o DnsRecordSrvPtrOutput) Weight() pulumi.IntPtrOutput

A relative weight for records with the same priority, higher value means higher chance of getting picked.

type DnsRecordState 

type DnsRecordState struct {
	// A comment explaining what the DNS record is for.
	Comment pulumi.StringPtrInput
	// The domain name, or zone, that the DNS record should be created beneath.
	Domain pulumi.StringPtrInput
	// The priority of the MX record. The priority specifies the sequence that an email server receives emails. A smaller value indicates a higher priority.
	MxPriority pulumi.IntPtrInput
	// The subdomain name of the record. This should be an empty string if the rercord is for the root domain.
	Name pulumi.StringPtrInput
	// Settings for an SRV record.
	Srv DnsRecordSrvPtrInput
	// The team ID that the domain and DNS records belong to. Required when configuring a team resource if a default team has not been set in the provider.
	TeamId pulumi.StringPtrInput
	// The TTL value in seconds. Must be a number between 60 and 2147483647. If unspecified, it will default to 60 seconds.
	Ttl pulumi.IntPtrInput
	// The type of DNS record. Available types: `A`, `AAAA`, `ALIAS`, `CAA`, `CNAME`, `MX`, `NS`, `SRV`, `TXT`.
	Type pulumi.StringPtrInput
	// The value of the DNS record. The format depends on the 'type' property.
	// For an 'A' record, this should be a valid IPv4 address.
	// For an 'AAAA' record, this should be an IPv6 address.
	// For 'ALIAS' records, this should be a hostname.
	// For 'CAA' records, this should specify specify which Certificate Authorities (CAs) are allowed to issue certificates for the domain.
	// For 'CNAME' records, this should be a different domain name.
	// For 'MX' records, this should specify the mail server responsible for accepting messages on behalf of the domain name.
	// For 'TXT' records, this can contain arbitrary text.
	Value pulumi.StringPtrInput
}

func (DnsRecordState) ElementType 

func (DnsRecordState) ElementType() reflect.Type

type GetFileArgs 

type GetFileArgs struct {
	Path string `pulumi:"path"`
}

A collection of arguments for invoking getFile.

type GetFileOutputArgs 

type GetFileOutputArgs struct {
	Path pulumi.StringInput `pulumi:"path"`
}

A collection of arguments for invoking getFile.

func (GetFileOutputArgs) ElementType 

func (GetFileOutputArgs) ElementType() reflect.Type

type GetFileResult 

type GetFileResult struct {
	// A map of filename to metadata about the file. The metadata contains the file size and hash, and allows a deployment to be created if the file changes.
	File map[string]string `pulumi:"file"`
	// The ID of this resource.
	Id   string `pulumi:"id"`
	Path string `pulumi:"path"`
}

A collection of values returned by getFile.

func GetFile 

func GetFile(ctx *pulumi.Context, args *GetFileArgs, opts ...pulumi.InvokeOption) (*GetFileResult, error)

Provides information about a file on disk.

This will read a single file, providing metadata for use with a `Deployment`.

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-vercel/sdk/go/vercel"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleFile, err := vercel.GetFile(ctx, &vercel.GetFileArgs{
			Path: "index.html",
		}, nil)
		if err != nil {
			return err
		}
		exampleProject, err := vercel.LookupProject(ctx, &vercel.LookupProjectArgs{
			Name: "my-project",
		}, nil)
		if err != nil {
			return err
		}
		_, err = vercel.NewDeployment(ctx, "exampleDeployment", &vercel.DeploymentArgs{
			ProjectId: *pulumi.String(exampleProject.Id),
			Files:     interface{}(exampleFile.File),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type GetFileResultOutput 

type GetFileResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getFile.

func GetFileOutput 

func GetFileOutput(ctx *pulumi.Context, args GetFileOutputArgs, opts ...pulumi.InvokeOption) GetFileResultOutput

func (GetFileResultOutput) ElementType 

func (GetFileResultOutput) ElementType() reflect.Type

func (GetFileResultOutput) File 

func (o GetFileResultOutput) File() pulumi.StringMapOutput

A map of filename to metadata about the file. The metadata contains the file size and hash, and allows a deployment to be created if the file changes.

func (GetFileResultOutput) Id 

func (o GetFileResultOutput) Id() pulumi.StringOutput

The ID of this resource.

func (GetFileResultOutput) Path 

func (o GetFileResultOutput) Path() pulumi.StringOutput

func (GetFileResultOutput) ToGetFileResultOutput 

func (o GetFileResultOutput) ToGetFileResultOutput() GetFileResultOutput

func (GetFileResultOutput) ToGetFileResultOutputWithContext 

func (o GetFileResultOutput) ToGetFileResultOutputWithContext(ctx context.Context) GetFileResultOutput

type GetPrebuiltProjectArgs 

type GetPrebuiltProjectArgs struct {
	Path string `pulumi:"path"`
}

A collection of arguments for invoking getPrebuiltProject.

type GetPrebuiltProjectOutputArgs 

type GetPrebuiltProjectOutputArgs struct {
	Path pulumi.StringInput `pulumi:"path"`
}

A collection of arguments for invoking getPrebuiltProject.

func (GetPrebuiltProjectOutputArgs) ElementType 

func (GetPrebuiltProjectOutputArgs) ElementType() reflect.Type

type GetPrebuiltProjectResult 

type GetPrebuiltProjectResult struct {
	// The ID of this resource.
	Id string `pulumi:"id"`
	// A map of output file to metadata about the file. The metadata contains the file size and hash, and allows a deployment to be created if the file changes.
	Output map[string]string `pulumi:"output"`
	Path   string            `pulumi:"path"`
}

A collection of values returned by getPrebuiltProject.

func GetPrebuiltProject 

func GetPrebuiltProject(ctx *pulumi.Context, args *GetPrebuiltProjectArgs, opts ...pulumi.InvokeOption) (*GetPrebuiltProjectResult, error)

type GetPrebuiltProjectResultOutput 

type GetPrebuiltProjectResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getPrebuiltProject.

func GetPrebuiltProjectOutput 

func GetPrebuiltProjectOutput(ctx *pulumi.Context, args GetPrebuiltProjectOutputArgs, opts ...pulumi.InvokeOption) GetPrebuiltProjectResultOutput

func (GetPrebuiltProjectResultOutput) ElementType 

func (GetPrebuiltProjectResultOutput) ElementType() reflect.Type

func (GetPrebuiltProjectResultOutput) Id 

func (o GetPrebuiltProjectResultOutput) Id() pulumi.StringOutput

The ID of this resource.

func (GetPrebuiltProjectResultOutput) Output 

func (o GetPrebuiltProjectResultOutput) Output() pulumi.StringMapOutput

A map of output file to metadata about the file. The metadata contains the file size and hash, and allows a deployment to be created if the file changes.

func (GetPrebuiltProjectResultOutput) Path 

func (o GetPrebuiltProjectResultOutput) Path() pulumi.StringOutput

func (GetPrebuiltProjectResultOutput) ToGetPrebuiltProjectResultOutput 

func (o GetPrebuiltProjectResultOutput) ToGetPrebuiltProjectResultOutput() GetPrebuiltProjectResultOutput

func (GetPrebuiltProjectResultOutput) ToGetPrebuiltProjectResultOutputWithContext 

func (o GetPrebuiltProjectResultOutput) ToGetPrebuiltProjectResultOutputWithContext(ctx context.Context) GetPrebuiltProjectResultOutput

type GetProjectDirectoryArgs 

type GetProjectDirectoryArgs struct {
	Path string `pulumi:"path"`
}

A collection of arguments for invoking getProjectDirectory.

type GetProjectDirectoryOutputArgs 

type GetProjectDirectoryOutputArgs struct {
	Path pulumi.StringInput `pulumi:"path"`
}

A collection of arguments for invoking getProjectDirectory.

func (GetProjectDirectoryOutputArgs) ElementType 

func (GetProjectDirectoryOutputArgs) ElementType() reflect.Type

type GetProjectDirectoryResult 

type GetProjectDirectoryResult struct {
	// A map of filename to metadata about the file. The metadata contains the file size and hash, and allows a deployment to be created if the file changes.
	Files map[string]string `pulumi:"files"`
	// The ID of this resource.
	Id   string `pulumi:"id"`
	Path string `pulumi:"path"`
}

A collection of values returned by getProjectDirectory.

func GetProjectDirectory 

func GetProjectDirectory(ctx *pulumi.Context, args *GetProjectDirectoryArgs, opts ...pulumi.InvokeOption) (*GetProjectDirectoryResult, error)

type GetProjectDirectoryResultOutput 

type GetProjectDirectoryResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getProjectDirectory.

func GetProjectDirectoryOutput 

func GetProjectDirectoryOutput(ctx *pulumi.Context, args GetProjectDirectoryOutputArgs, opts ...pulumi.InvokeOption) GetProjectDirectoryResultOutput

func (GetProjectDirectoryResultOutput) ElementType 

func (GetProjectDirectoryResultOutput) ElementType() reflect.Type

func (GetProjectDirectoryResultOutput) Files 

func (o GetProjectDirectoryResultOutput) Files() pulumi.StringMapOutput

A map of filename to metadata about the file. The metadata contains the file size and hash, and allows a deployment to be created if the file changes.

func (GetProjectDirectoryResultOutput) Id 

func (o GetProjectDirectoryResultOutput) Id() pulumi.StringOutput

The ID of this resource.

func (GetProjectDirectoryResultOutput) Path 

func (o GetProjectDirectoryResultOutput) Path() pulumi.StringOutput

func (GetProjectDirectoryResultOutput) ToGetProjectDirectoryResultOutput 

func (o GetProjectDirectoryResultOutput) ToGetProjectDirectoryResultOutput() GetProjectDirectoryResultOutput

func (GetProjectDirectoryResultOutput) ToGetProjectDirectoryResultOutputWithContext 

func (o GetProjectDirectoryResultOutput) ToGetProjectDirectoryResultOutputWithContext(ctx context.Context) GetProjectDirectoryResultOutput

type GetProjectEnvironment 

type GetProjectEnvironment struct {
	// The git branch of the environment variable.
	GitBranch string `pulumi:"gitBranch"`
	// The ID of the environment variable
	Id string `pulumi:"id"`
	// The name of the environment variable.
	Key string `pulumi:"key"`
	// Whether the Environment Variable is sensitive or not. Note that the value will be `null` for sensitive environment variables.
	Sensitive bool `pulumi:"sensitive"`
	// The environments that the environment variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets []string `pulumi:"targets"`
	// The value of the environment variable.
	Value string `pulumi:"value"`
}

type GetProjectEnvironmentArgs 

type GetProjectEnvironmentArgs struct {
	// The git branch of the environment variable.
	GitBranch pulumi.StringInput `pulumi:"gitBranch"`
	// The ID of the environment variable
	Id pulumi.StringInput `pulumi:"id"`
	// The name of the environment variable.
	Key pulumi.StringInput `pulumi:"key"`
	// Whether the Environment Variable is sensitive or not. Note that the value will be `null` for sensitive environment variables.
	Sensitive pulumi.BoolInput `pulumi:"sensitive"`
	// The environments that the environment variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets pulumi.StringArrayInput `pulumi:"targets"`
	// The value of the environment variable.
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetProjectEnvironmentArgs) ElementType 

func (GetProjectEnvironmentArgs) ElementType() reflect.Type

func (GetProjectEnvironmentArgs) ToGetProjectEnvironmentOutput 

func (i GetProjectEnvironmentArgs) ToGetProjectEnvironmentOutput() GetProjectEnvironmentOutput

func (GetProjectEnvironmentArgs) ToGetProjectEnvironmentOutputWithContext 

func (i GetProjectEnvironmentArgs) ToGetProjectEnvironmentOutputWithContext(ctx context.Context) GetProjectEnvironmentOutput

type GetProjectEnvironmentArray 

type GetProjectEnvironmentArray []GetProjectEnvironmentInput

func (GetProjectEnvironmentArray) ElementType 

func (GetProjectEnvironmentArray) ElementType() reflect.Type

func (GetProjectEnvironmentArray) ToGetProjectEnvironmentArrayOutput 

func (i GetProjectEnvironmentArray) ToGetProjectEnvironmentArrayOutput() GetProjectEnvironmentArrayOutput

func (GetProjectEnvironmentArray) ToGetProjectEnvironmentArrayOutputWithContext 

func (i GetProjectEnvironmentArray) ToGetProjectEnvironmentArrayOutputWithContext(ctx context.Context) GetProjectEnvironmentArrayOutput

type GetProjectEnvironmentArrayInput 

type GetProjectEnvironmentArrayInput interface {
	pulumi.Input

	ToGetProjectEnvironmentArrayOutput() GetProjectEnvironmentArrayOutput
	ToGetProjectEnvironmentArrayOutputWithContext(context.Context) GetProjectEnvironmentArrayOutput
}

GetProjectEnvironmentArrayInput is an input type that accepts GetProjectEnvironmentArray and GetProjectEnvironmentArrayOutput values. You can construct a concrete instance of `GetProjectEnvironmentArrayInput` via: 

GetProjectEnvironmentArray{ GetProjectEnvironmentArgs{...} }

type GetProjectEnvironmentArrayOutput 

type GetProjectEnvironmentArrayOutput struct{ *pulumi.OutputState }

func (GetProjectEnvironmentArrayOutput) ElementType 

func (GetProjectEnvironmentArrayOutput) ElementType() reflect.Type

func (GetProjectEnvironmentArrayOutput) Index 

func (o GetProjectEnvironmentArrayOutput) Index(i pulumi.IntInput) GetProjectEnvironmentOutput

func (GetProjectEnvironmentArrayOutput) ToGetProjectEnvironmentArrayOutput 

func (o GetProjectEnvironmentArrayOutput) ToGetProjectEnvironmentArrayOutput() GetProjectEnvironmentArrayOutput

func (GetProjectEnvironmentArrayOutput) ToGetProjectEnvironmentArrayOutputWithContext 

func (o GetProjectEnvironmentArrayOutput) ToGetProjectEnvironmentArrayOutputWithContext(ctx context.Context) GetProjectEnvironmentArrayOutput

type GetProjectEnvironmentInput 

type GetProjectEnvironmentInput interface {
	pulumi.Input

	ToGetProjectEnvironmentOutput() GetProjectEnvironmentOutput
	ToGetProjectEnvironmentOutputWithContext(context.Context) GetProjectEnvironmentOutput
}

GetProjectEnvironmentInput is an input type that accepts GetProjectEnvironmentArgs and GetProjectEnvironmentOutput values. You can construct a concrete instance of `GetProjectEnvironmentInput` via: 

GetProjectEnvironmentArgs{...}

type GetProjectEnvironmentOutput 

type GetProjectEnvironmentOutput struct{ *pulumi.OutputState }

func (GetProjectEnvironmentOutput) ElementType 

func (GetProjectEnvironmentOutput) ElementType() reflect.Type

func (GetProjectEnvironmentOutput) GitBranch 

func (o GetProjectEnvironmentOutput) GitBranch() pulumi.StringOutput

The git branch of the environment variable.

func (GetProjectEnvironmentOutput) Id 

func (o GetProjectEnvironmentOutput) Id() pulumi.StringOutput

The ID of the environment variable

func (GetProjectEnvironmentOutput) Key 

func (o GetProjectEnvironmentOutput) Key() pulumi.StringOutput

The name of the environment variable.

func (GetProjectEnvironmentOutput) Sensitive added in v1.1.0 

func (o GetProjectEnvironmentOutput) Sensitive() pulumi.BoolOutput

Whether the Environment Variable is sensitive or not. Note that the value will be `null` for sensitive environment variables.

func (GetProjectEnvironmentOutput) Targets 

func (o GetProjectEnvironmentOutput) Targets() pulumi.StringArrayOutput

The environments that the environment variable should be present on. Valid targets are either `production`, `preview`, or `development`.

func (GetProjectEnvironmentOutput) ToGetProjectEnvironmentOutput 

func (o GetProjectEnvironmentOutput) ToGetProjectEnvironmentOutput() GetProjectEnvironmentOutput

func (GetProjectEnvironmentOutput) ToGetProjectEnvironmentOutputWithContext 

func (o GetProjectEnvironmentOutput) ToGetProjectEnvironmentOutputWithContext(ctx context.Context) GetProjectEnvironmentOutput

func (GetProjectEnvironmentOutput) Value 

func (o GetProjectEnvironmentOutput) Value() pulumi.StringOutput

The value of the environment variable.

type GetProjectGitRepository 

type GetProjectGitRepository struct {
	// By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
	ProductionBranch string `pulumi:"productionBranch"`
	// The name of the git repository. For example: `vercel/next.js`.
	Repo string `pulumi:"repo"`
	// The git provider of the repository. Must be either `github`, `gitlab`, or `bitbucket`.
	Type string `pulumi:"type"`
}

type GetProjectGitRepositoryArgs 

type GetProjectGitRepositoryArgs struct {
	// By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
	ProductionBranch pulumi.StringInput `pulumi:"productionBranch"`
	// The name of the git repository. For example: `vercel/next.js`.
	Repo pulumi.StringInput `pulumi:"repo"`
	// The git provider of the repository. Must be either `github`, `gitlab`, or `bitbucket`.
	Type pulumi.StringInput `pulumi:"type"`
}

func (GetProjectGitRepositoryArgs) ElementType 

func (GetProjectGitRepositoryArgs) ElementType() reflect.Type

func (GetProjectGitRepositoryArgs) ToGetProjectGitRepositoryOutput 

func (i GetProjectGitRepositoryArgs) ToGetProjectGitRepositoryOutput() GetProjectGitRepositoryOutput

func (GetProjectGitRepositoryArgs) ToGetProjectGitRepositoryOutputWithContext 

func (i GetProjectGitRepositoryArgs) ToGetProjectGitRepositoryOutputWithContext(ctx context.Context) GetProjectGitRepositoryOutput

type GetProjectGitRepositoryInput 

type GetProjectGitRepositoryInput interface {
	pulumi.Input

	ToGetProjectGitRepositoryOutput() GetProjectGitRepositoryOutput
	ToGetProjectGitRepositoryOutputWithContext(context.Context) GetProjectGitRepositoryOutput
}

GetProjectGitRepositoryInput is an input type that accepts GetProjectGitRepositoryArgs and GetProjectGitRepositoryOutput values. You can construct a concrete instance of `GetProjectGitRepositoryInput` via: 

GetProjectGitRepositoryArgs{...}

type GetProjectGitRepositoryOutput 

type GetProjectGitRepositoryOutput struct{ *pulumi.OutputState }

func (GetProjectGitRepositoryOutput) ElementType 

func (GetProjectGitRepositoryOutput) ElementType() reflect.Type

func (GetProjectGitRepositoryOutput) ProductionBranch 

func (o GetProjectGitRepositoryOutput) ProductionBranch() pulumi.StringOutput

By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.

func (GetProjectGitRepositoryOutput) Repo 

func (o GetProjectGitRepositoryOutput) Repo() pulumi.StringOutput

The name of the git repository. For example: `vercel/next.js`.

func (GetProjectGitRepositoryOutput) ToGetProjectGitRepositoryOutput 

func (o GetProjectGitRepositoryOutput) ToGetProjectGitRepositoryOutput() GetProjectGitRepositoryOutput

func (GetProjectGitRepositoryOutput) ToGetProjectGitRepositoryOutputWithContext 

func (o GetProjectGitRepositoryOutput) ToGetProjectGitRepositoryOutputWithContext(ctx context.Context) GetProjectGitRepositoryOutput

func (GetProjectGitRepositoryOutput) Type 

func (o GetProjectGitRepositoryOutput) Type() pulumi.StringOutput

The git provider of the repository. Must be either `github`, `gitlab`, or `bitbucket`.

type GetProjectPasswordProtection 

type GetProjectPasswordProtection struct {
	// The deployment environment that will be protected.
	DeploymentType string `pulumi:"deploymentType"`
}

type GetProjectPasswordProtectionArgs 

type GetProjectPasswordProtectionArgs struct {
	// The deployment environment that will be protected.
	DeploymentType pulumi.StringInput `pulumi:"deploymentType"`
}

func (GetProjectPasswordProtectionArgs) ElementType 

func (GetProjectPasswordProtectionArgs) ElementType() reflect.Type

func (GetProjectPasswordProtectionArgs) ToGetProjectPasswordProtectionOutput 

func (i GetProjectPasswordProtectionArgs) ToGetProjectPasswordProtectionOutput() GetProjectPasswordProtectionOutput

func (GetProjectPasswordProtectionArgs) ToGetProjectPasswordProtectionOutputWithContext 

func (i GetProjectPasswordProtectionArgs) ToGetProjectPasswordProtectionOutputWithContext(ctx context.Context) GetProjectPasswordProtectionOutput

type GetProjectPasswordProtectionInput 

type GetProjectPasswordProtectionInput interface {
	pulumi.Input

	ToGetProjectPasswordProtectionOutput() GetProjectPasswordProtectionOutput
	ToGetProjectPasswordProtectionOutputWithContext(context.Context) GetProjectPasswordProtectionOutput
}

GetProjectPasswordProtectionInput is an input type that accepts GetProjectPasswordProtectionArgs and GetProjectPasswordProtectionOutput values. You can construct a concrete instance of `GetProjectPasswordProtectionInput` via: 

GetProjectPasswordProtectionArgs{...}

type GetProjectPasswordProtectionOutput 

type GetProjectPasswordProtectionOutput struct{ *pulumi.OutputState }

func (GetProjectPasswordProtectionOutput) DeploymentType added in v1.0.1 

func (o GetProjectPasswordProtectionOutput) DeploymentType() pulumi.StringOutput

The deployment environment that will be protected.

func (GetProjectPasswordProtectionOutput) ElementType 

func (GetProjectPasswordProtectionOutput) ElementType() reflect.Type

func (GetProjectPasswordProtectionOutput) ToGetProjectPasswordProtectionOutput 

func (o GetProjectPasswordProtectionOutput) ToGetProjectPasswordProtectionOutput() GetProjectPasswordProtectionOutput

func (GetProjectPasswordProtectionOutput) ToGetProjectPasswordProtectionOutputWithContext 

func (o GetProjectPasswordProtectionOutput) ToGetProjectPasswordProtectionOutputWithContext(ctx context.Context) GetProjectPasswordProtectionOutput

type GetProjectTrustedIps added in v1.0.1 

type GetProjectTrustedIps struct {
	// The allowed IP addressses and CIDR ranges with optional descriptions.
	Addresses []GetProjectTrustedIpsAddress `pulumi:"addresses"`
	// The deployment environment that will be protected.
	DeploymentType string `pulumi:"deploymentType"`
	// Whether or not Trusted IPs is required or optional to access a deployment.
	ProtectionMode string `pulumi:"protectionMode"`
}

type GetProjectTrustedIpsAddress added in v1.0.1 

type GetProjectTrustedIpsAddress struct {
	Note string `pulumi:"note"`
	// The value of the environment variable.
	Value string `pulumi:"value"`
}

type GetProjectTrustedIpsAddressArgs added in v1.0.1 

type GetProjectTrustedIpsAddressArgs struct {
	Note pulumi.StringInput `pulumi:"note"`
	// The value of the environment variable.
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetProjectTrustedIpsAddressArgs) ElementType added in v1.0.1 

func (GetProjectTrustedIpsAddressArgs) ElementType() reflect.Type

func (GetProjectTrustedIpsAddressArgs) ToGetProjectTrustedIpsAddressOutput added in v1.0.1 

func (i GetProjectTrustedIpsAddressArgs) ToGetProjectTrustedIpsAddressOutput() GetProjectTrustedIpsAddressOutput

func (GetProjectTrustedIpsAddressArgs) ToGetProjectTrustedIpsAddressOutputWithContext added in v1.0.1 

func (i GetProjectTrustedIpsAddressArgs) ToGetProjectTrustedIpsAddressOutputWithContext(ctx context.Context) GetProjectTrustedIpsAddressOutput

type GetProjectTrustedIpsAddressArray added in v1.0.1 

type GetProjectTrustedIpsAddressArray []GetProjectTrustedIpsAddressInput

func (GetProjectTrustedIpsAddressArray) ElementType added in v1.0.1 

func (GetProjectTrustedIpsAddressArray) ElementType() reflect.Type

func (GetProjectTrustedIpsAddressArray) ToGetProjectTrustedIpsAddressArrayOutput added in v1.0.1 

func (i GetProjectTrustedIpsAddressArray) ToGetProjectTrustedIpsAddressArrayOutput() GetProjectTrustedIpsAddressArrayOutput

func (GetProjectTrustedIpsAddressArray) ToGetProjectTrustedIpsAddressArrayOutputWithContext added in v1.0.1 

func (i GetProjectTrustedIpsAddressArray) ToGetProjectTrustedIpsAddressArrayOutputWithContext(ctx context.Context) GetProjectTrustedIpsAddressArrayOutput

type GetProjectTrustedIpsAddressArrayInput added in v1.0.1 

type GetProjectTrustedIpsAddressArrayInput interface {
	pulumi.Input

	ToGetProjectTrustedIpsAddressArrayOutput() GetProjectTrustedIpsAddressArrayOutput
	ToGetProjectTrustedIpsAddressArrayOutputWithContext(context.Context) GetProjectTrustedIpsAddressArrayOutput
}

GetProjectTrustedIpsAddressArrayInput is an input type that accepts GetProjectTrustedIpsAddressArray and GetProjectTrustedIpsAddressArrayOutput values. You can construct a concrete instance of `GetProjectTrustedIpsAddressArrayInput` via: 

GetProjectTrustedIpsAddressArray{ GetProjectTrustedIpsAddressArgs{...} }

type GetProjectTrustedIpsAddressArrayOutput added in v1.0.1 

type GetProjectTrustedIpsAddressArrayOutput struct{ *pulumi.OutputState }

func (GetProjectTrustedIpsAddressArrayOutput) ElementType added in v1.0.1 

func (GetProjectTrustedIpsAddressArrayOutput) ElementType() reflect.Type

func (GetProjectTrustedIpsAddressArrayOutput) Index added in v1.0.1 

func (o GetProjectTrustedIpsAddressArrayOutput) Index(i pulumi.IntInput) GetProjectTrustedIpsAddressOutput

func (GetProjectTrustedIpsAddressArrayOutput) ToGetProjectTrustedIpsAddressArrayOutput added in v1.0.1 

func (o GetProjectTrustedIpsAddressArrayOutput) ToGetProjectTrustedIpsAddressArrayOutput() GetProjectTrustedIpsAddressArrayOutput

func (GetProjectTrustedIpsAddressArrayOutput) ToGetProjectTrustedIpsAddressArrayOutputWithContext added in v1.0.1 

func (o GetProjectTrustedIpsAddressArrayOutput) ToGetProjectTrustedIpsAddressArrayOutputWithContext(ctx context.Context) GetProjectTrustedIpsAddressArrayOutput

type GetProjectTrustedIpsAddressInput added in v1.0.1 

type GetProjectTrustedIpsAddressInput interface {
	pulumi.Input

	ToGetProjectTrustedIpsAddressOutput() GetProjectTrustedIpsAddressOutput
	ToGetProjectTrustedIpsAddressOutputWithContext(context.Context) GetProjectTrustedIpsAddressOutput
}

GetProjectTrustedIpsAddressInput is an input type that accepts GetProjectTrustedIpsAddressArgs and GetProjectTrustedIpsAddressOutput values. You can construct a concrete instance of `GetProjectTrustedIpsAddressInput` via: 

GetProjectTrustedIpsAddressArgs{...}

type GetProjectTrustedIpsAddressOutput added in v1.0.1 

type GetProjectTrustedIpsAddressOutput struct{ *pulumi.OutputState }

func (GetProjectTrustedIpsAddressOutput) ElementType added in v1.0.1 

func (GetProjectTrustedIpsAddressOutput) ElementType() reflect.Type

func (GetProjectTrustedIpsAddressOutput) Note added in v1.0.1 

func (o GetProjectTrustedIpsAddressOutput) Note() pulumi.StringOutput

func (GetProjectTrustedIpsAddressOutput) ToGetProjectTrustedIpsAddressOutput added in v1.0.1 

func (o GetProjectTrustedIpsAddressOutput) ToGetProjectTrustedIpsAddressOutput() GetProjectTrustedIpsAddressOutput

func (GetProjectTrustedIpsAddressOutput) ToGetProjectTrustedIpsAddressOutputWithContext added in v1.0.1 

func (o GetProjectTrustedIpsAddressOutput) ToGetProjectTrustedIpsAddressOutputWithContext(ctx context.Context) GetProjectTrustedIpsAddressOutput

func (GetProjectTrustedIpsAddressOutput) Value added in v1.0.1 

func (o GetProjectTrustedIpsAddressOutput) Value() pulumi.StringOutput

The value of the environment variable.

type GetProjectTrustedIpsArgs added in v1.0.1 

type GetProjectTrustedIpsArgs struct {
	// The allowed IP addressses and CIDR ranges with optional descriptions.
	Addresses GetProjectTrustedIpsAddressArrayInput `pulumi:"addresses"`
	// The deployment environment that will be protected.
	DeploymentType pulumi.StringInput `pulumi:"deploymentType"`
	// Whether or not Trusted IPs is required or optional to access a deployment.
	ProtectionMode pulumi.StringInput `pulumi:"protectionMode"`
}

func (GetProjectTrustedIpsArgs) ElementType added in v1.0.1 

func (GetProjectTrustedIpsArgs) ElementType() reflect.Type

func (GetProjectTrustedIpsArgs) ToGetProjectTrustedIpsOutput added in v1.0.1 

func (i GetProjectTrustedIpsArgs) ToGetProjectTrustedIpsOutput() GetProjectTrustedIpsOutput

func (GetProjectTrustedIpsArgs) ToGetProjectTrustedIpsOutputWithContext added in v1.0.1 

func (i GetProjectTrustedIpsArgs) ToGetProjectTrustedIpsOutputWithContext(ctx context.Context) GetProjectTrustedIpsOutput

type GetProjectTrustedIpsInput added in v1.0.1 

type GetProjectTrustedIpsInput interface {
	pulumi.Input

	ToGetProjectTrustedIpsOutput() GetProjectTrustedIpsOutput
	ToGetProjectTrustedIpsOutputWithContext(context.Context) GetProjectTrustedIpsOutput
}

GetProjectTrustedIpsInput is an input type that accepts GetProjectTrustedIpsArgs and GetProjectTrustedIpsOutput values. You can construct a concrete instance of `GetProjectTrustedIpsInput` via: 

GetProjectTrustedIpsArgs{...}

type GetProjectTrustedIpsOutput added in v1.0.1 

type GetProjectTrustedIpsOutput struct{ *pulumi.OutputState }

func (GetProjectTrustedIpsOutput) Addresses added in v1.0.1 

func (o GetProjectTrustedIpsOutput) Addresses() GetProjectTrustedIpsAddressArrayOutput

The allowed IP addressses and CIDR ranges with optional descriptions.

func (GetProjectTrustedIpsOutput) DeploymentType added in v1.0.1 

func (o GetProjectTrustedIpsOutput) DeploymentType() pulumi.StringOutput

The deployment environment that will be protected.

func (GetProjectTrustedIpsOutput) ElementType added in v1.0.1 

func (GetProjectTrustedIpsOutput) ElementType() reflect.Type

func (GetProjectTrustedIpsOutput) ProtectionMode added in v1.0.1 

func (o GetProjectTrustedIpsOutput) ProtectionMode() pulumi.StringOutput

Whether or not Trusted IPs is required or optional to access a deployment.

func (GetProjectTrustedIpsOutput) ToGetProjectTrustedIpsOutput added in v1.0.1 

func (o GetProjectTrustedIpsOutput) ToGetProjectTrustedIpsOutput() GetProjectTrustedIpsOutput

func (GetProjectTrustedIpsOutput) ToGetProjectTrustedIpsOutputWithContext added in v1.0.1 

func (o GetProjectTrustedIpsOutput) ToGetProjectTrustedIpsOutputWithContext(ctx context.Context) GetProjectTrustedIpsOutput

type GetProjectVercelAuthentication 

type GetProjectVercelAuthentication struct {
	// The deployment environment that will be protected.
	DeploymentType string `pulumi:"deploymentType"`
}

type GetProjectVercelAuthenticationArgs 

type GetProjectVercelAuthenticationArgs struct {
	// The deployment environment that will be protected.
	DeploymentType pulumi.StringInput `pulumi:"deploymentType"`
}

func (GetProjectVercelAuthenticationArgs) ElementType 

func (GetProjectVercelAuthenticationArgs) ElementType() reflect.Type

func (GetProjectVercelAuthenticationArgs) ToGetProjectVercelAuthenticationOutput 

func (i GetProjectVercelAuthenticationArgs) ToGetProjectVercelAuthenticationOutput() GetProjectVercelAuthenticationOutput

func (GetProjectVercelAuthenticationArgs) ToGetProjectVercelAuthenticationOutputWithContext 

func (i GetProjectVercelAuthenticationArgs) ToGetProjectVercelAuthenticationOutputWithContext(ctx context.Context) GetProjectVercelAuthenticationOutput

type GetProjectVercelAuthenticationInput 

type GetProjectVercelAuthenticationInput interface {
	pulumi.Input

	ToGetProjectVercelAuthenticationOutput() GetProjectVercelAuthenticationOutput
	ToGetProjectVercelAuthenticationOutputWithContext(context.Context) GetProjectVercelAuthenticationOutput
}

GetProjectVercelAuthenticationInput is an input type that accepts GetProjectVercelAuthenticationArgs and GetProjectVercelAuthenticationOutput values. You can construct a concrete instance of `GetProjectVercelAuthenticationInput` via: 

GetProjectVercelAuthenticationArgs{...}

type GetProjectVercelAuthenticationOutput 

type GetProjectVercelAuthenticationOutput struct{ *pulumi.OutputState }

func (GetProjectVercelAuthenticationOutput) DeploymentType added in v1.0.1 

func (o GetProjectVercelAuthenticationOutput) DeploymentType() pulumi.StringOutput

The deployment environment that will be protected.

func (GetProjectVercelAuthenticationOutput) ElementType 

func (GetProjectVercelAuthenticationOutput) ElementType() reflect.Type

func (GetProjectVercelAuthenticationOutput) ToGetProjectVercelAuthenticationOutput 

func (o GetProjectVercelAuthenticationOutput) ToGetProjectVercelAuthenticationOutput() GetProjectVercelAuthenticationOutput

func (GetProjectVercelAuthenticationOutput) ToGetProjectVercelAuthenticationOutputWithContext 

func (o GetProjectVercelAuthenticationOutput) ToGetProjectVercelAuthenticationOutputWithContext(ctx context.Context) GetProjectVercelAuthenticationOutput

type LookupAliasArgs 

type LookupAliasArgs struct {
	// The Alias or Alias ID to be retrieved.
	Alias string `pulumi:"alias"`
	// 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 `pulumi:"teamId"`
}

A collection of arguments for invoking getAlias.

type LookupAliasOutputArgs 

type LookupAliasOutputArgs struct {
	// The Alias or Alias ID to be retrieved.
	Alias pulumi.StringInput `pulumi:"alias"`
	// 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.StringPtrInput `pulumi:"teamId"`
}

A collection of arguments for invoking getAlias.

func (LookupAliasOutputArgs) ElementType 

func (LookupAliasOutputArgs) ElementType() reflect.Type

type LookupAliasResult 

type LookupAliasResult struct {
	// The Alias or Alias ID to be retrieved.
	Alias string `pulumi:"alias"`
	// The ID of the Deployment the Alias is associated with.
	DeploymentId string `pulumi:"deploymentId"`
	// The ID of this resource.
	Id string `pulumi:"id"`
	// 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 `pulumi:"teamId"`
}

A collection of values returned by getAlias.

func LookupAlias 

func LookupAlias(ctx *pulumi.Context, args *LookupAliasArgs, opts ...pulumi.InvokeOption) (*LookupAliasResult, error)

Provides information about an existing Alias resource.

An Alias allows a `Deployment` to be accessed through a different URL.

type LookupAliasResultOutput 

type LookupAliasResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAlias.

func LookupAliasOutput 

func LookupAliasOutput(ctx *pulumi.Context, args LookupAliasOutputArgs, opts ...pulumi.InvokeOption) LookupAliasResultOutput

func (LookupAliasResultOutput) Alias 

func (o LookupAliasResultOutput) Alias() pulumi.StringOutput

The Alias or Alias ID to be retrieved.

func (LookupAliasResultOutput) DeploymentId 

func (o LookupAliasResultOutput) DeploymentId() pulumi.StringOutput

The ID of the Deployment the Alias is associated with.

func (LookupAliasResultOutput) ElementType 

func (LookupAliasResultOutput) ElementType() reflect.Type

func (LookupAliasResultOutput) Id 

func (o LookupAliasResultOutput) Id() pulumi.StringOutput

The ID of this resource.

func (LookupAliasResultOutput) TeamId 

func (o LookupAliasResultOutput) TeamId() pulumi.StringOutput

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.

func (LookupAliasResultOutput) ToLookupAliasResultOutput 

func (o LookupAliasResultOutput) ToLookupAliasResultOutput() LookupAliasResultOutput

func (LookupAliasResultOutput) ToLookupAliasResultOutputWithContext 

func (o LookupAliasResultOutput) ToLookupAliasResultOutputWithContext(ctx context.Context) LookupAliasResultOutput

type LookupProjectArgs 

type LookupProjectArgs struct {
	// The name of the project.
	Name string `pulumi:"name"`
	// The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.
	TeamId *string `pulumi:"teamId"`
}

A collection of arguments for invoking getProject.

type LookupProjectOutputArgs 

type LookupProjectOutputArgs struct {
	// The name of the project.
	Name pulumi.StringInput `pulumi:"name"`
	// The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.
	TeamId pulumi.StringPtrInput `pulumi:"teamId"`
}

A collection of arguments for invoking getProject.

func (LookupProjectOutputArgs) ElementType 

func (LookupProjectOutputArgs) ElementType() reflect.Type

type LookupProjectResult 

type LookupProjectResult struct {
	// The build command for this project. If omitted, this value will be automatically detected.
	BuildCommand string `pulumi:"buildCommand"`
	// The dev command for this project. If omitted, this value will be automatically detected.
	DevCommand string `pulumi:"devCommand"`
	// A list of environment variables that should be configured for the project.
	Environments []GetProjectEnvironment `pulumi:"environments"`
	// The framework that is being used for this project. If omitted, no framework is selected.
	Framework string `pulumi:"framework"`
	// The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for [Github](https://vercel.com/docs/concepts/git/vercel-for-github), [Gitlab](https://vercel.com/docs/concepts/git/vercel-for-gitlab) or [Bitbucket](https://vercel.com/docs/concepts/git/vercel-for-bitbucket) plugins to be installed.
	GitRepository GetProjectGitRepository `pulumi:"gitRepository"`
	// The ID of this resource.
	Id string `pulumi:"id"`
	// When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
	IgnoreCommand string `pulumi:"ignoreCommand"`
	// The install command for this project. If omitted, this value will be automatically detected.
	InstallCommand string `pulumi:"installCommand"`
	// The name of the project.
	Name string `pulumi:"name"`
	// The output directory of the project. When null is used this value will be automatically detected.
	OutputDirectory string `pulumi:"outputDirectory"`
	// Ensures visitors of your Preview Deployments must enter a password in order to gain access.
	PasswordProtection GetProjectPasswordProtection `pulumi:"passwordProtection"`
	// Specifies whether the source code and logs of the deployments for this project should be public or not.
	PublicSource bool `pulumi:"publicSource"`
	// The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.
	RootDirectory string `pulumi:"rootDirectory"`
	// The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see [Vercel's documentation](https://vercel.com/docs/concepts/edge-network/regions) for a full list of regions.
	ServerlessFunctionRegion string `pulumi:"serverlessFunctionRegion"`
	// The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.
	TeamId string `pulumi:"teamId"`
	// Ensures only visitors from an allowed IP address can access your deployment.
	TrustedIps GetProjectTrustedIps `pulumi:"trustedIps"`
	// Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
	VercelAuthentication GetProjectVercelAuthentication `pulumi:"vercelAuthentication"`
}

A collection of values returned by getProject.

func LookupProject 

func LookupProject(ctx *pulumi.Context, args *LookupProjectArgs, opts ...pulumi.InvokeOption) (*LookupProjectResult, error)

Provides information about an existing project within Vercel.

A Project groups deployments and custom domains. To deploy on Vercel, you need a Project.

For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/concepts/projects/overview).

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-vercel/sdk/go/vercel"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		foo, err := vercel.LookupProject(ctx, &vercel.LookupProjectArgs{
			Name: "my-existing-project",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("projectId", foo.Id)
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupProjectResultOutput 

type LookupProjectResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getProject.

func LookupProjectOutput 

func LookupProjectOutput(ctx *pulumi.Context, args LookupProjectOutputArgs, opts ...pulumi.InvokeOption) LookupProjectResultOutput

func (LookupProjectResultOutput) BuildCommand 

func (o LookupProjectResultOutput) BuildCommand() pulumi.StringOutput

The build command for this project. If omitted, this value will be automatically detected.

func (LookupProjectResultOutput) DevCommand 

func (o LookupProjectResultOutput) DevCommand() pulumi.StringOutput

The dev command for this project. If omitted, this value will be automatically detected.

func (LookupProjectResultOutput) ElementType 

func (LookupProjectResultOutput) ElementType() reflect.Type

func (LookupProjectResultOutput) Environments 

func (o LookupProjectResultOutput) Environments() GetProjectEnvironmentArrayOutput

A list of environment variables that should be configured for the project.

func (LookupProjectResultOutput) Framework 

func (o LookupProjectResultOutput) Framework() pulumi.StringOutput

The framework that is being used for this project. If omitted, no framework is selected.

func (LookupProjectResultOutput) GitRepository 

func (o LookupProjectResultOutput) GitRepository() GetProjectGitRepositoryOutput

The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for [Github](https://vercel.com/docs/concepts/git/vercel-for-github), [Gitlab](https://vercel.com/docs/concepts/git/vercel-for-gitlab) or [Bitbucket](https://vercel.com/docs/concepts/git/vercel-for-bitbucket) plugins to be installed.

func (LookupProjectResultOutput) Id 

func (o LookupProjectResultOutput) Id() pulumi.StringOutput

The ID of this resource.

func (LookupProjectResultOutput) IgnoreCommand 

func (o LookupProjectResultOutput) IgnoreCommand() pulumi.StringOutput

When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.

func (LookupProjectResultOutput) InstallCommand 

func (o LookupProjectResultOutput) InstallCommand() pulumi.StringOutput

The install command for this project. If omitted, this value will be automatically detected.

func (LookupProjectResultOutput) Name 

func (o LookupProjectResultOutput) Name() pulumi.StringOutput

The name of the project.

func (LookupProjectResultOutput) OutputDirectory 

func (o LookupProjectResultOutput) OutputDirectory() pulumi.StringOutput

The output directory of the project. When null is used this value will be automatically detected.

func (LookupProjectResultOutput) PasswordProtection 

func (o LookupProjectResultOutput) PasswordProtection() GetProjectPasswordProtectionOutput

Ensures visitors of your Preview Deployments must enter a password in order to gain access.

func (LookupProjectResultOutput) PublicSource 

func (o LookupProjectResultOutput) PublicSource() pulumi.BoolOutput

Specifies whether the source code and logs of the deployments for this project should be public or not.

func (LookupProjectResultOutput) RootDirectory 

func (o LookupProjectResultOutput) RootDirectory() pulumi.StringOutput

The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.

func (LookupProjectResultOutput) ServerlessFunctionRegion 

func (o LookupProjectResultOutput) ServerlessFunctionRegion() pulumi.StringOutput

The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see [Vercel's documentation](https://vercel.com/docs/concepts/edge-network/regions) for a full list of regions.

func (LookupProjectResultOutput) TeamId 

func (o LookupProjectResultOutput) TeamId() pulumi.StringOutput

The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.

func (LookupProjectResultOutput) ToLookupProjectResultOutput 

func (o LookupProjectResultOutput) ToLookupProjectResultOutput() LookupProjectResultOutput

func (LookupProjectResultOutput) ToLookupProjectResultOutputWithContext 

func (o LookupProjectResultOutput) ToLookupProjectResultOutputWithContext(ctx context.Context) LookupProjectResultOutput

func (LookupProjectResultOutput) TrustedIps added in v1.0.1 

func (o LookupProjectResultOutput) TrustedIps() GetProjectTrustedIpsOutput

Ensures only visitors from an allowed IP address can access your deployment.

func (LookupProjectResultOutput) VercelAuthentication 

func (o LookupProjectResultOutput) VercelAuthentication() GetProjectVercelAuthenticationOutput

Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.

type LookupSharedEnvironmentVariableArgs added in v1.3.0 

type LookupSharedEnvironmentVariableArgs struct {
	// The ID of the Environment Variable.
	Id *string `pulumi:"id"`
	// The name of the Environment Variable.
	Key *string `pulumi:"key"`
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets []string `pulumi:"targets"`
	// The ID of the Vercel team. Shared environment variables require a team.
	TeamId *string `pulumi:"teamId"`
}

A collection of arguments for invoking getSharedEnvironmentVariable.

type LookupSharedEnvironmentVariableOutputArgs added in v1.3.0 

type LookupSharedEnvironmentVariableOutputArgs struct {
	// The ID of the Environment Variable.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// The name of the Environment Variable.
	Key pulumi.StringPtrInput `pulumi:"key"`
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets pulumi.StringArrayInput `pulumi:"targets"`
	// The ID of the Vercel team. Shared environment variables require a team.
	TeamId pulumi.StringPtrInput `pulumi:"teamId"`
}

A collection of arguments for invoking getSharedEnvironmentVariable.

func (LookupSharedEnvironmentVariableOutputArgs) ElementType added in v1.3.0 

func (LookupSharedEnvironmentVariableOutputArgs) ElementType() reflect.Type

type LookupSharedEnvironmentVariableResult added in v1.3.0 

type LookupSharedEnvironmentVariableResult struct {
	// The ID of the Environment Variable.
	Id string `pulumi:"id"`
	// The name of the Environment Variable.
	Key string `pulumi:"key"`
	// The ID of the Vercel project.
	ProjectIds []string `pulumi:"projectIds"`
	// Whether the Environment Variable is sensitive or not.
	Sensitive bool `pulumi:"sensitive"`
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets []string `pulumi:"targets"`
	// The ID of the Vercel team. Shared environment variables require a team.
	TeamId string `pulumi:"teamId"`
	// The value of the Environment Variable.
	Value string `pulumi:"value"`
}

A collection of values returned by getSharedEnvironmentVariable.

func LookupSharedEnvironmentVariable added in v1.3.0 

func LookupSharedEnvironmentVariable(ctx *pulumi.Context, args *LookupSharedEnvironmentVariableArgs, opts ...pulumi.InvokeOption) (*LookupSharedEnvironmentVariableResult, error)

Provides information about an existing Shared Environment Variable within Vercel.

A Shared Environment Variable resource defines an Environment Variable that can be shared between multiple Vercel Projects.

For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables/shared-environment-variables).

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-vercel/sdk/go/vercel"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vercel.LookupSharedEnvironmentVariable(ctx, &vercel.LookupSharedEnvironmentVariableArgs{
			Id: pulumi.StringRef("xxxxxxxxxxxxxxx"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vercel.LookupSharedEnvironmentVariable(ctx, &vercel.LookupSharedEnvironmentVariableArgs{
			Key: pulumi.StringRef("MY_ENV_VAR"),
			Targets: []string{
				"production",
				"preview",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

type LookupSharedEnvironmentVariableResultOutput added in v1.3.0 

type LookupSharedEnvironmentVariableResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getSharedEnvironmentVariable.

func LookupSharedEnvironmentVariableOutput added in v1.3.0 

func LookupSharedEnvironmentVariableOutput(ctx *pulumi.Context, args LookupSharedEnvironmentVariableOutputArgs, opts ...pulumi.InvokeOption) LookupSharedEnvironmentVariableResultOutput

func (LookupSharedEnvironmentVariableResultOutput) ElementType added in v1.3.0 

func (LookupSharedEnvironmentVariableResultOutput) ElementType() reflect.Type

func (LookupSharedEnvironmentVariableResultOutput) Id added in v1.3.0 

func (o LookupSharedEnvironmentVariableResultOutput) Id() pulumi.StringOutput

The ID of the Environment Variable.

func (LookupSharedEnvironmentVariableResultOutput) Key added in v1.3.0 

func (o LookupSharedEnvironmentVariableResultOutput) Key() pulumi.StringOutput

The name of the Environment Variable.

func (LookupSharedEnvironmentVariableResultOutput) ProjectIds added in v1.3.0 

func (o LookupSharedEnvironmentVariableResultOutput) ProjectIds() pulumi.StringArrayOutput

The ID of the Vercel project.

func (LookupSharedEnvironmentVariableResultOutput) Sensitive added in v1.3.0 

func (o LookupSharedEnvironmentVariableResultOutput) Sensitive() pulumi.BoolOutput

Whether the Environment Variable is sensitive or not.

func (LookupSharedEnvironmentVariableResultOutput) Targets added in v1.3.0 

func (o LookupSharedEnvironmentVariableResultOutput) Targets() pulumi.StringArrayOutput

The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.

func (LookupSharedEnvironmentVariableResultOutput) TeamId added in v1.3.0 

func (o LookupSharedEnvironmentVariableResultOutput) TeamId() pulumi.StringOutput

The ID of the Vercel team. Shared environment variables require a team.

func (LookupSharedEnvironmentVariableResultOutput) ToLookupSharedEnvironmentVariableResultOutput added in v1.3.0 

func (o LookupSharedEnvironmentVariableResultOutput) ToLookupSharedEnvironmentVariableResultOutput() LookupSharedEnvironmentVariableResultOutput

func (LookupSharedEnvironmentVariableResultOutput) ToLookupSharedEnvironmentVariableResultOutputWithContext added in v1.3.0 

func (o LookupSharedEnvironmentVariableResultOutput) ToLookupSharedEnvironmentVariableResultOutputWithContext(ctx context.Context) LookupSharedEnvironmentVariableResultOutput

func (LookupSharedEnvironmentVariableResultOutput) Value added in v1.3.0 

func (o LookupSharedEnvironmentVariableResultOutput) Value() pulumi.StringOutput

The value of the Environment Variable.

type Project 

type Project struct {
	pulumi.CustomResourceState

	// The build command for this project. If omitted, this value will be automatically detected.
	BuildCommand pulumi.StringPtrOutput `pulumi:"buildCommand"`
	// The dev command for this project. If omitted, this value will be automatically detected.
	DevCommand pulumi.StringPtrOutput `pulumi:"devCommand"`
	// A set of Environment Variables that should be configured for the project.
	Environments ProjectEnvironmentArrayOutput `pulumi:"environments"`
	// The framework that is being used for this project. If omitted, no framework is selected.
	Framework pulumi.StringPtrOutput `pulumi:"framework"`
	// The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for [Github](https://vercel.com/docs/concepts/git/vercel-for-github), [Gitlab](https://vercel.com/docs/concepts/git/vercel-for-gitlab) or [Bitbucket](https://vercel.com/docs/concepts/git/vercel-for-bitbucket) plugins to be installed.
	GitRepository ProjectGitRepositoryPtrOutput `pulumi:"gitRepository"`
	// When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
	IgnoreCommand pulumi.StringPtrOutput `pulumi:"ignoreCommand"`
	// The install command for this project. If omitted, this value will be automatically detected.
	InstallCommand pulumi.StringPtrOutput `pulumi:"installCommand"`
	// The desired name for the project.
	Name pulumi.StringOutput `pulumi:"name"`
	// The output directory of the project. If omitted, this value will be automatically detected.
	OutputDirectory pulumi.StringPtrOutput `pulumi:"outputDirectory"`
	// Ensures visitors of your Preview Deployments must enter a password in order to gain access.
	PasswordProtection ProjectPasswordProtectionPtrOutput `pulumi:"passwordProtection"`
	// Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named `x-vercel-protection-bypass` with a value of the `passwordProtectionForAutomationSecret` field.
	ProtectionBypassForAutomation pulumi.BoolPtrOutput `pulumi:"protectionBypassForAutomation"`
	// If `protectionBypassForAutomation` is enabled, use this value in the `x-vercel-protection-bypass` header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
	ProtectionBypassForAutomationSecret pulumi.StringOutput `pulumi:"protectionBypassForAutomationSecret"`
	// By default, visitors to the `/_logs` and `/_src` paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting `publicSource` to `true` disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
	PublicSource pulumi.BoolPtrOutput `pulumi:"publicSource"`
	// The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
	RootDirectory pulumi.StringPtrOutput `pulumi:"rootDirectory"`
	// The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see [Vercel's documentation](https://vercel.com/docs/concepts/edge-network/regions) for a full list of regions.
	ServerlessFunctionRegion pulumi.StringOutput `pulumi:"serverlessFunctionRegion"`
	// 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.StringOutput `pulumi:"teamId"`
	// Ensures only visitors from an allowed IP address can access your deployment.
	TrustedIps ProjectTrustedIpsPtrOutput `pulumi:"trustedIps"`
	// Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
	VercelAuthentication ProjectVercelAuthenticationOutput `pulumi:"vercelAuthentication"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-vercel/sdk/go/vercel"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// A project that is connected to a git repository.
		// Deployments will be created automatically
		// on every branch push and merges onto the Production Branch.
		_, err := vercel.NewProject(ctx, "withGit", &vercel.ProjectArgs{
			Framework: pulumi.String("nextjs"),
			GitRepository: &vercel.ProjectGitRepositoryArgs{
				Repo: pulumi.String("vercel/some-repo"),
				Type: pulumi.String("github"),
			},
		})
		if err != nil {
			return err
		}
		// A project that is not connected to a git repository.
		// Deployments will need to be created manually through
		// terraform, or via the vercel CLI.
		_, err = vercel.NewProject(ctx, "example", &vercel.ProjectArgs{
			Framework: pulumi.String("nextjs"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

If importing into a personal account, or with a team configured on

the provider, simply use the project ID.

- project_id can be found in the project `settings` tab in the Vercel UI.

```sh $ pulumi import vercel:index/project:Project example prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx ```

Alternatively, you can import via the team_id and project_id.

- team_id can be found in the team `settings` tab in the Vercel UI.

- project_id can be found in the project `settings` tab in the Vercel UI.

```sh $ pulumi import vercel:index/project:Project example team_xxxxxxxxxxxxxxxxxxxxxxxx/prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx ```

func GetProject 

func GetProject(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ProjectState, opts ...pulumi.ResourceOption) (*Project, error)

GetProject gets an existing Project 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 NewProject 

func NewProject(ctx *pulumi.Context,
	name string, args *ProjectArgs, opts ...pulumi.ResourceOption) (*Project, error)

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

func (*Project) ElementType 

func (*Project) ElementType() reflect.Type

func (*Project) ToProjectOutput 

func (i *Project) ToProjectOutput() ProjectOutput

func (*Project) ToProjectOutputWithContext 

func (i *Project) ToProjectOutputWithContext(ctx context.Context) ProjectOutput

type ProjectArgs 

type ProjectArgs struct {
	// The build command for this project. If omitted, this value will be automatically detected.
	BuildCommand pulumi.StringPtrInput
	// The dev command for this project. If omitted, this value will be automatically detected.
	DevCommand pulumi.StringPtrInput
	// A set of Environment Variables that should be configured for the project.
	Environments ProjectEnvironmentArrayInput
	// The framework that is being used for this project. If omitted, no framework is selected.
	Framework pulumi.StringPtrInput
	// The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for [Github](https://vercel.com/docs/concepts/git/vercel-for-github), [Gitlab](https://vercel.com/docs/concepts/git/vercel-for-gitlab) or [Bitbucket](https://vercel.com/docs/concepts/git/vercel-for-bitbucket) plugins to be installed.
	GitRepository ProjectGitRepositoryPtrInput
	// When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
	IgnoreCommand pulumi.StringPtrInput
	// The install command for this project. If omitted, this value will be automatically detected.
	InstallCommand pulumi.StringPtrInput
	// The desired name for the project.
	Name pulumi.StringPtrInput
	// The output directory of the project. If omitted, this value will be automatically detected.
	OutputDirectory pulumi.StringPtrInput
	// Ensures visitors of your Preview Deployments must enter a password in order to gain access.
	PasswordProtection ProjectPasswordProtectionPtrInput
	// Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named `x-vercel-protection-bypass` with a value of the `passwordProtectionForAutomationSecret` field.
	ProtectionBypassForAutomation pulumi.BoolPtrInput
	// By default, visitors to the `/_logs` and `/_src` paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting `publicSource` to `true` disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
	PublicSource pulumi.BoolPtrInput
	// The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
	RootDirectory pulumi.StringPtrInput
	// The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see [Vercel's documentation](https://vercel.com/docs/concepts/edge-network/regions) for a full list of regions.
	ServerlessFunctionRegion pulumi.StringPtrInput
	// 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.StringPtrInput
	// Ensures only visitors from an allowed IP address can access your deployment.
	TrustedIps ProjectTrustedIpsPtrInput
	// Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
	VercelAuthentication ProjectVercelAuthenticationPtrInput
}

The set of arguments for constructing a Project resource.

func (ProjectArgs) ElementType 

func (ProjectArgs) ElementType() reflect.Type

type ProjectArray 

type ProjectArray []ProjectInput

func (ProjectArray) ElementType 

func (ProjectArray) ElementType() reflect.Type

func (ProjectArray) ToProjectArrayOutput 

func (i ProjectArray) ToProjectArrayOutput() ProjectArrayOutput

func (ProjectArray) ToProjectArrayOutputWithContext 

func (i ProjectArray) ToProjectArrayOutputWithContext(ctx context.Context) ProjectArrayOutput

type ProjectArrayInput 

type ProjectArrayInput interface {
	pulumi.Input

	ToProjectArrayOutput() ProjectArrayOutput
	ToProjectArrayOutputWithContext(context.Context) ProjectArrayOutput
}

ProjectArrayInput is an input type that accepts ProjectArray and ProjectArrayOutput values. You can construct a concrete instance of `ProjectArrayInput` via: 

ProjectArray{ ProjectArgs{...} }

type ProjectArrayOutput 

type ProjectArrayOutput struct{ *pulumi.OutputState }

func (ProjectArrayOutput) ElementType 

func (ProjectArrayOutput) ElementType() reflect.Type

func (ProjectArrayOutput) Index 

func (o ProjectArrayOutput) Index(i pulumi.IntInput) ProjectOutput

func (ProjectArrayOutput) ToProjectArrayOutput 

func (o ProjectArrayOutput) ToProjectArrayOutput() ProjectArrayOutput

func (ProjectArrayOutput) ToProjectArrayOutputWithContext 

func (o ProjectArrayOutput) ToProjectArrayOutputWithContext(ctx context.Context) ProjectArrayOutput

type ProjectDomain 

type ProjectDomain struct {
	pulumi.CustomResourceState

	// The domain name to associate with the project.
	Domain pulumi.StringOutput `pulumi:"domain"`
	// Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
	GitBranch pulumi.StringPtrOutput `pulumi:"gitBranch"`
	// The project ID to add the deployment to.
	ProjectId pulumi.StringOutput `pulumi:"projectId"`
	// The domain name that serves as a target destination for redirects.
	Redirect pulumi.StringPtrOutput `pulumi:"redirect"`
	// The HTTP status code to use when serving as a redirect.
	RedirectStatusCode pulumi.IntPtrOutput `pulumi:"redirectStatusCode"`
	// 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.StringOutput `pulumi:"teamId"`
}

Provides a Project Domain resource.

A Project Domain is used to associate a domain name with a `Project`.

By default, Project Domains will be automatically applied to any `production` deployments.

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-vercel/sdk/go/vercel"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleProject, err := vercel.NewProject(ctx, "exampleProject", nil)
		if err != nil {
			return err
		}
		// A simple domain that will be automatically
		// applied to each production deployment
		exampleProjectDomain, err := vercel.NewProjectDomain(ctx, "exampleProjectDomain", &vercel.ProjectDomainArgs{
			ProjectId: exampleProject.ID(),
			Domain:    pulumi.String("i-love.vercel.app"),
		})
		if err != nil {
			return err
		}
		// A redirect of a domain name to a second domain name.
		// The status_code can optionally be controlled.
		_, err = vercel.NewProjectDomain(ctx, "exampleRedirect", &vercel.ProjectDomainArgs{
			ProjectId:          exampleProject.ID(),
			Domain:             pulumi.String("i-also-love.vercel.app"),
			Redirect:           exampleProjectDomain.Domain,
			RedirectStatusCode: pulumi.Int(307),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

If importing into a personal account, or with a team configured on

the provider, simply use the project ID and domain.

- project_id can be found in the project `settings` tab in the Vercel UI.

```sh $ pulumi import vercel:index/projectDomain:ProjectDomain example prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/example.com ```

Alternatively, you can import via the team_id, project_id and domain name.

- team_id can be found in the team `settings` tab in the Vercel UI.

- project_id can be found in the project `settings` tab in the Vercel UI.

```sh $ pulumi import vercel:index/projectDomain:ProjectDomain example team_xxxxxxxxxxxxxxxxxxxxxxxx/prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/example.com ```

func GetProjectDomain 

func GetProjectDomain(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ProjectDomainState, opts ...pulumi.ResourceOption) (*ProjectDomain, error)

GetProjectDomain gets an existing ProjectDomain 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 NewProjectDomain 

func NewProjectDomain(ctx *pulumi.Context,
	name string, args *ProjectDomainArgs, opts ...pulumi.ResourceOption) (*ProjectDomain, error)

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

func (*ProjectDomain) ElementType 

func (*ProjectDomain) ElementType() reflect.Type

func (*ProjectDomain) ToProjectDomainOutput 

func (i *ProjectDomain) ToProjectDomainOutput() ProjectDomainOutput

func (*ProjectDomain) ToProjectDomainOutputWithContext 

func (i *ProjectDomain) ToProjectDomainOutputWithContext(ctx context.Context) ProjectDomainOutput

type ProjectDomainArgs 

type ProjectDomainArgs struct {
	// The domain name to associate with the project.
	Domain pulumi.StringInput
	// Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
	GitBranch pulumi.StringPtrInput
	// The project ID to add the deployment to.
	ProjectId pulumi.StringInput
	// The domain name that serves as a target destination for redirects.
	Redirect pulumi.StringPtrInput
	// The HTTP status code to use when serving as a redirect.
	RedirectStatusCode pulumi.IntPtrInput
	// 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.StringPtrInput
}

The set of arguments for constructing a ProjectDomain resource.

func (ProjectDomainArgs) ElementType 

func (ProjectDomainArgs) ElementType() reflect.Type

type ProjectDomainArray 

type ProjectDomainArray []ProjectDomainInput

func (ProjectDomainArray) ElementType 

func (ProjectDomainArray) ElementType() reflect.Type

func (ProjectDomainArray) ToProjectDomainArrayOutput 

func (i ProjectDomainArray) ToProjectDomainArrayOutput() ProjectDomainArrayOutput

func (ProjectDomainArray) ToProjectDomainArrayOutputWithContext 

func (i ProjectDomainArray) ToProjectDomainArrayOutputWithContext(ctx context.Context) ProjectDomainArrayOutput

type ProjectDomainArrayInput 

type ProjectDomainArrayInput interface {
	pulumi.Input

	ToProjectDomainArrayOutput() ProjectDomainArrayOutput
	ToProjectDomainArrayOutputWithContext(context.Context) ProjectDomainArrayOutput
}

ProjectDomainArrayInput is an input type that accepts ProjectDomainArray and ProjectDomainArrayOutput values. You can construct a concrete instance of `ProjectDomainArrayInput` via: 

ProjectDomainArray{ ProjectDomainArgs{...} }

type ProjectDomainArrayOutput 

type ProjectDomainArrayOutput struct{ *pulumi.OutputState }

func (ProjectDomainArrayOutput) ElementType 

func (ProjectDomainArrayOutput) ElementType() reflect.Type

func (ProjectDomainArrayOutput) Index 

func (o ProjectDomainArrayOutput) Index(i pulumi.IntInput) ProjectDomainOutput

func (ProjectDomainArrayOutput) ToProjectDomainArrayOutput 

func (o ProjectDomainArrayOutput) ToProjectDomainArrayOutput() ProjectDomainArrayOutput

func (ProjectDomainArrayOutput) ToProjectDomainArrayOutputWithContext 

func (o ProjectDomainArrayOutput) ToProjectDomainArrayOutputWithContext(ctx context.Context) ProjectDomainArrayOutput

type ProjectDomainInput 

type ProjectDomainInput interface {
	pulumi.Input

	ToProjectDomainOutput() ProjectDomainOutput
	ToProjectDomainOutputWithContext(ctx context.Context) ProjectDomainOutput
}

type ProjectDomainMap 

type ProjectDomainMap map[string]ProjectDomainInput

func (ProjectDomainMap) ElementType 

func (ProjectDomainMap) ElementType() reflect.Type

func (ProjectDomainMap) ToProjectDomainMapOutput 

func (i ProjectDomainMap) ToProjectDomainMapOutput() ProjectDomainMapOutput

func (ProjectDomainMap) ToProjectDomainMapOutputWithContext 

func (i ProjectDomainMap) ToProjectDomainMapOutputWithContext(ctx context.Context) ProjectDomainMapOutput

type ProjectDomainMapInput 

type ProjectDomainMapInput interface {
	pulumi.Input

	ToProjectDomainMapOutput() ProjectDomainMapOutput
	ToProjectDomainMapOutputWithContext(context.Context) ProjectDomainMapOutput
}

ProjectDomainMapInput is an input type that accepts ProjectDomainMap and ProjectDomainMapOutput values. You can construct a concrete instance of `ProjectDomainMapInput` via: 

ProjectDomainMap{ "key": ProjectDomainArgs{...} }

type ProjectDomainMapOutput 

type ProjectDomainMapOutput struct{ *pulumi.OutputState }

func (ProjectDomainMapOutput) ElementType 

func (ProjectDomainMapOutput) ElementType() reflect.Type

func (ProjectDomainMapOutput) MapIndex 

func (o ProjectDomainMapOutput) MapIndex(k pulumi.StringInput) ProjectDomainOutput

func (ProjectDomainMapOutput) ToProjectDomainMapOutput 

func (o ProjectDomainMapOutput) ToProjectDomainMapOutput() ProjectDomainMapOutput

func (ProjectDomainMapOutput) ToProjectDomainMapOutputWithContext 

func (o ProjectDomainMapOutput) ToProjectDomainMapOutputWithContext(ctx context.Context) ProjectDomainMapOutput

type ProjectDomainOutput 

type ProjectDomainOutput struct{ *pulumi.OutputState }

func (ProjectDomainOutput) Domain 

func (o ProjectDomainOutput) Domain() pulumi.StringOutput

The domain name to associate with the project.

func (ProjectDomainOutput) ElementType 

func (ProjectDomainOutput) ElementType() reflect.Type

func (ProjectDomainOutput) GitBranch 

func (o ProjectDomainOutput) GitBranch() pulumi.StringPtrOutput

Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.

func (ProjectDomainOutput) ProjectId 

func (o ProjectDomainOutput) ProjectId() pulumi.StringOutput

The project ID to add the deployment to.

func (ProjectDomainOutput) Redirect 

func (o ProjectDomainOutput) Redirect() pulumi.StringPtrOutput

The domain name that serves as a target destination for redirects.

func (ProjectDomainOutput) RedirectStatusCode 

func (o ProjectDomainOutput) RedirectStatusCode() pulumi.IntPtrOutput

The HTTP status code to use when serving as a redirect.

func (ProjectDomainOutput) TeamId 

func (o ProjectDomainOutput) TeamId() pulumi.StringOutput

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.

func (ProjectDomainOutput) ToProjectDomainOutput 

func (o ProjectDomainOutput) ToProjectDomainOutput() ProjectDomainOutput

func (ProjectDomainOutput) ToProjectDomainOutputWithContext 

func (o ProjectDomainOutput) ToProjectDomainOutputWithContext(ctx context.Context) ProjectDomainOutput

type ProjectDomainState 

type ProjectDomainState struct {
	// The domain name to associate with the project.
	Domain pulumi.StringPtrInput
	// Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
	GitBranch pulumi.StringPtrInput
	// The project ID to add the deployment to.
	ProjectId pulumi.StringPtrInput
	// The domain name that serves as a target destination for redirects.
	Redirect pulumi.StringPtrInput
	// The HTTP status code to use when serving as a redirect.
	RedirectStatusCode pulumi.IntPtrInput
	// 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.StringPtrInput
}

func (ProjectDomainState) ElementType 

func (ProjectDomainState) ElementType() reflect.Type

type ProjectEnvironment 

type ProjectEnvironment struct {
	// The git branch of the Environment Variable.
	GitBranch *string `pulumi:"gitBranch"`
	// The ID of the Environment Variable.
	Id *string `pulumi:"id"`
	// The name of the Environment Variable.
	Key string `pulumi:"key"`
	// Whether the Environment Variable is sensitive or not.
	Sensitive *bool `pulumi:"sensitive"`
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets []string `pulumi:"targets"`
	// The value of the Environment Variable.
	Value string `pulumi:"value"`
}

type ProjectEnvironmentArgs 

type ProjectEnvironmentArgs struct {
	// The git branch of the Environment Variable.
	GitBranch pulumi.StringPtrInput `pulumi:"gitBranch"`
	// The ID of the Environment Variable.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// The name of the Environment Variable.
	Key pulumi.StringInput `pulumi:"key"`
	// Whether the Environment Variable is sensitive or not.
	Sensitive pulumi.BoolPtrInput `pulumi:"sensitive"`
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets pulumi.StringArrayInput `pulumi:"targets"`
	// The value of the Environment Variable.
	Value pulumi.StringInput `pulumi:"value"`
}

func (ProjectEnvironmentArgs) ElementType 

func (ProjectEnvironmentArgs) ElementType() reflect.Type

func (ProjectEnvironmentArgs) ToProjectEnvironmentOutput 

func (i ProjectEnvironmentArgs) ToProjectEnvironmentOutput() ProjectEnvironmentOutput

func (ProjectEnvironmentArgs) ToProjectEnvironmentOutputWithContext 

func (i ProjectEnvironmentArgs) ToProjectEnvironmentOutputWithContext(ctx context.Context) ProjectEnvironmentOutput

type ProjectEnvironmentArray 

type ProjectEnvironmentArray []ProjectEnvironmentInput

func (ProjectEnvironmentArray) ElementType 

func (ProjectEnvironmentArray) ElementType() reflect.Type

func (ProjectEnvironmentArray) ToProjectEnvironmentArrayOutput 

func (i ProjectEnvironmentArray) ToProjectEnvironmentArrayOutput() ProjectEnvironmentArrayOutput

func (ProjectEnvironmentArray) ToProjectEnvironmentArrayOutputWithContext 

func (i ProjectEnvironmentArray) ToProjectEnvironmentArrayOutputWithContext(ctx context.Context) ProjectEnvironmentArrayOutput

type ProjectEnvironmentArrayInput 

type ProjectEnvironmentArrayInput interface {
	pulumi.Input

	ToProjectEnvironmentArrayOutput() ProjectEnvironmentArrayOutput
	ToProjectEnvironmentArrayOutputWithContext(context.Context) ProjectEnvironmentArrayOutput
}

ProjectEnvironmentArrayInput is an input type that accepts ProjectEnvironmentArray and ProjectEnvironmentArrayOutput values. You can construct a concrete instance of `ProjectEnvironmentArrayInput` via: 

ProjectEnvironmentArray{ ProjectEnvironmentArgs{...} }

type ProjectEnvironmentArrayOutput 

type ProjectEnvironmentArrayOutput struct{ *pulumi.OutputState }

func (ProjectEnvironmentArrayOutput) ElementType 

func (ProjectEnvironmentArrayOutput) ElementType() reflect.Type

func (ProjectEnvironmentArrayOutput) Index 

func (o ProjectEnvironmentArrayOutput) Index(i pulumi.IntInput) ProjectEnvironmentOutput

func (ProjectEnvironmentArrayOutput) ToProjectEnvironmentArrayOutput 

func (o ProjectEnvironmentArrayOutput) ToProjectEnvironmentArrayOutput() ProjectEnvironmentArrayOutput

func (ProjectEnvironmentArrayOutput) ToProjectEnvironmentArrayOutputWithContext 

func (o ProjectEnvironmentArrayOutput) ToProjectEnvironmentArrayOutputWithContext(ctx context.Context) ProjectEnvironmentArrayOutput

type ProjectEnvironmentInput 

type ProjectEnvironmentInput interface {
	pulumi.Input

	ToProjectEnvironmentOutput() ProjectEnvironmentOutput
	ToProjectEnvironmentOutputWithContext(context.Context) ProjectEnvironmentOutput
}

ProjectEnvironmentInput is an input type that accepts ProjectEnvironmentArgs and ProjectEnvironmentOutput values. You can construct a concrete instance of `ProjectEnvironmentInput` via: 

ProjectEnvironmentArgs{...}

type ProjectEnvironmentOutput 

type ProjectEnvironmentOutput struct{ *pulumi.OutputState }

func (ProjectEnvironmentOutput) ElementType 

func (ProjectEnvironmentOutput) ElementType() reflect.Type

func (ProjectEnvironmentOutput) GitBranch 

func (o ProjectEnvironmentOutput) GitBranch() pulumi.StringPtrOutput

The git branch of the Environment Variable.

func (ProjectEnvironmentOutput) Id 

func (o ProjectEnvironmentOutput) Id() pulumi.StringPtrOutput

The ID of the Environment Variable.

func (ProjectEnvironmentOutput) Key 

func (o ProjectEnvironmentOutput) Key() pulumi.StringOutput

The name of the Environment Variable.

func (ProjectEnvironmentOutput) Sensitive added in v1.1.0 

func (o ProjectEnvironmentOutput) Sensitive() pulumi.BoolPtrOutput

Whether the Environment Variable is sensitive or not.

func (ProjectEnvironmentOutput) Targets 

func (o ProjectEnvironmentOutput) Targets() pulumi.StringArrayOutput

The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.

func (ProjectEnvironmentOutput) ToProjectEnvironmentOutput 

func (o ProjectEnvironmentOutput) ToProjectEnvironmentOutput() ProjectEnvironmentOutput

func (ProjectEnvironmentOutput) ToProjectEnvironmentOutputWithContext 

func (o ProjectEnvironmentOutput) ToProjectEnvironmentOutputWithContext(ctx context.Context) ProjectEnvironmentOutput

func (ProjectEnvironmentOutput) Value 

func (o ProjectEnvironmentOutput) Value() pulumi.StringOutput

The value of the Environment Variable.

type ProjectEnvironmentVariable 

type ProjectEnvironmentVariable struct {
	pulumi.CustomResourceState

	// The git branch of the Environment Variable.
	GitBranch pulumi.StringPtrOutput `pulumi:"gitBranch"`
	// The name of the Environment Variable.
	Key pulumi.StringOutput `pulumi:"key"`
	// The ID of the Vercel project.
	ProjectId pulumi.StringOutput `pulumi:"projectId"`
	// Whether the Environment Variable is sensitive or not.
	Sensitive pulumi.BoolOutput `pulumi:"sensitive"`
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets pulumi.StringArrayOutput `pulumi:"targets"`
	// The ID of the Vercel team.Required when configuring a team resource if a default team has not been set in the provider.
	TeamId pulumi.StringOutput `pulumi:"teamId"`
	// The value of the Environment Variable.
	Value pulumi.StringOutput `pulumi:"value"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-vercel/sdk/go/vercel"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleProject, err := vercel.NewProject(ctx, "exampleProject", &vercel.ProjectArgs{
			GitRepository: &vercel.ProjectGitRepositoryArgs{
				Type: pulumi.String("github"),
				Repo: pulumi.String("vercel/some-repo"),
			},
		})
		if err != nil {
			return err
		}
		// An environment variable that will be created
		// for this project for the "production" environment.
		_, err = vercel.NewProjectEnvironmentVariable(ctx, "exampleProjectEnvironmentVariable", &vercel.ProjectEnvironmentVariableArgs{
			ProjectId: exampleProject.ID(),
			Key:       pulumi.String("foo"),
			Value:     pulumi.String("bar"),
			Targets: pulumi.StringArray{
				pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		// An environment variable that will be created
		// for this project for the "preview" environment when the branch is "staging".
		_, err = vercel.NewProjectEnvironmentVariable(ctx, "exampleGitBranch", &vercel.ProjectEnvironmentVariableArgs{
			ProjectId: exampleProject.ID(),
			Key:       pulumi.String("foo"),
			Value:     pulumi.String("bar-staging"),
			Targets: pulumi.StringArray{
				pulumi.String("preview"),
			},
			GitBranch: pulumi.String("staging"),
		})
		if err != nil {
			return err
		}
		// A sensitive environment variable that will be created
		// for this project for the "production" environment.
		_, err = vercel.NewProjectEnvironmentVariable(ctx, "exampleSensitive", &vercel.ProjectEnvironmentVariableArgs{
			ProjectId: exampleProject.ID(),
			Key:       pulumi.String("foo"),
			Value:     pulumi.String("bar-production"),
			Targets: pulumi.StringArray{
				pulumi.String("production"),
			},
			Sensitive: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

If importing into a personal account, or with a team configured on

the provider, simply use the project_id and environment variable id.

- project_id can be found in the project `settings` tab in the Vercel UI.

- environment variable id is hard to find, but can be taken from the network tab, inside developer tools, on the project page.

#

Note also, that the value field for sensitive environment variables will be imported as `null`.

```sh $ pulumi import vercel:index/projectEnvironmentVariable:ProjectEnvironmentVariable example prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/FdT2e1E5Of6Cihmt ```

Alternatively, you can import via the team_id, project_id and

environment variable id.

- team_id can be found in the team `settings` tab in the Vercel UI.

- project_id can be found in the project `settings` tab in the Vercel UI.

- environment variable id is hard to find, but can be taken from the network tab, inside developer tools, on the project page.

#

Note also, that the value field for sensitive environment variables will be imported as `null`.

```sh $ pulumi import vercel:index/projectEnvironmentVariable:ProjectEnvironmentVariable example team_xxxxxxxxxxxxxxxxxxxxxxxx/prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/FdT2e1E5Of6Cihmt ```

func GetProjectEnvironmentVariable 

func GetProjectEnvironmentVariable(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ProjectEnvironmentVariableState, opts ...pulumi.ResourceOption) (*ProjectEnvironmentVariable, error)

GetProjectEnvironmentVariable gets an existing ProjectEnvironmentVariable 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 NewProjectEnvironmentVariable 

func NewProjectEnvironmentVariable(ctx *pulumi.Context,
	name string, args *ProjectEnvironmentVariableArgs, opts ...pulumi.ResourceOption) (*ProjectEnvironmentVariable, error)

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

func (*ProjectEnvironmentVariable) ElementType 

func (*ProjectEnvironmentVariable) ElementType() reflect.Type

func (*ProjectEnvironmentVariable) ToProjectEnvironmentVariableOutput 

func (i *ProjectEnvironmentVariable) ToProjectEnvironmentVariableOutput() ProjectEnvironmentVariableOutput

func (*ProjectEnvironmentVariable) ToProjectEnvironmentVariableOutputWithContext 

func (i *ProjectEnvironmentVariable) ToProjectEnvironmentVariableOutputWithContext(ctx context.Context) ProjectEnvironmentVariableOutput

type ProjectEnvironmentVariableArgs 

type ProjectEnvironmentVariableArgs struct {
	// The git branch of the Environment Variable.
	GitBranch pulumi.StringPtrInput
	// The name of the Environment Variable.
	Key pulumi.StringInput
	// The ID of the Vercel project.
	ProjectId pulumi.StringInput
	// Whether the Environment Variable is sensitive or not.
	Sensitive pulumi.BoolPtrInput
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets pulumi.StringArrayInput
	// The ID of the Vercel team.Required when configuring a team resource if a default team has not been set in the provider.
	TeamId pulumi.StringPtrInput
	// The value of the Environment Variable.
	Value pulumi.StringInput
}

The set of arguments for constructing a ProjectEnvironmentVariable resource.

func (ProjectEnvironmentVariableArgs) ElementType 

func (ProjectEnvironmentVariableArgs) ElementType() reflect.Type

type ProjectEnvironmentVariableArray 

type ProjectEnvironmentVariableArray []ProjectEnvironmentVariableInput

func (ProjectEnvironmentVariableArray) ElementType 

func (ProjectEnvironmentVariableArray) ElementType() reflect.Type

func (ProjectEnvironmentVariableArray) ToProjectEnvironmentVariableArrayOutput 

func (i ProjectEnvironmentVariableArray) ToProjectEnvironmentVariableArrayOutput() ProjectEnvironmentVariableArrayOutput

func (ProjectEnvironmentVariableArray) ToProjectEnvironmentVariableArrayOutputWithContext 

func (i ProjectEnvironmentVariableArray) ToProjectEnvironmentVariableArrayOutputWithContext(ctx context.Context) ProjectEnvironmentVariableArrayOutput

type ProjectEnvironmentVariableArrayInput 

type ProjectEnvironmentVariableArrayInput interface {
	pulumi.Input

	ToProjectEnvironmentVariableArrayOutput() ProjectEnvironmentVariableArrayOutput
	ToProjectEnvironmentVariableArrayOutputWithContext(context.Context) ProjectEnvironmentVariableArrayOutput
}

ProjectEnvironmentVariableArrayInput is an input type that accepts ProjectEnvironmentVariableArray and ProjectEnvironmentVariableArrayOutput values. You can construct a concrete instance of `ProjectEnvironmentVariableArrayInput` via: 

ProjectEnvironmentVariableArray{ ProjectEnvironmentVariableArgs{...} }

type ProjectEnvironmentVariableArrayOutput 

type ProjectEnvironmentVariableArrayOutput struct{ *pulumi.OutputState }

func (ProjectEnvironmentVariableArrayOutput) ElementType 

func (ProjectEnvironmentVariableArrayOutput) ElementType() reflect.Type

func (ProjectEnvironmentVariableArrayOutput) Index 

func (o ProjectEnvironmentVariableArrayOutput) Index(i pulumi.IntInput) ProjectEnvironmentVariableOutput

func (ProjectEnvironmentVariableArrayOutput) ToProjectEnvironmentVariableArrayOutput 

func (o ProjectEnvironmentVariableArrayOutput) ToProjectEnvironmentVariableArrayOutput() ProjectEnvironmentVariableArrayOutput

func (ProjectEnvironmentVariableArrayOutput) ToProjectEnvironmentVariableArrayOutputWithContext 

func (o ProjectEnvironmentVariableArrayOutput) ToProjectEnvironmentVariableArrayOutputWithContext(ctx context.Context) ProjectEnvironmentVariableArrayOutput

type ProjectEnvironmentVariableInput 

type ProjectEnvironmentVariableInput interface {
	pulumi.Input

	ToProjectEnvironmentVariableOutput() ProjectEnvironmentVariableOutput
	ToProjectEnvironmentVariableOutputWithContext(ctx context.Context) ProjectEnvironmentVariableOutput
}

type ProjectEnvironmentVariableMap 

type ProjectEnvironmentVariableMap map[string]ProjectEnvironmentVariableInput

func (ProjectEnvironmentVariableMap) ElementType 

func (ProjectEnvironmentVariableMap) ElementType() reflect.Type

func (ProjectEnvironmentVariableMap) ToProjectEnvironmentVariableMapOutput 

func (i ProjectEnvironmentVariableMap) ToProjectEnvironmentVariableMapOutput() ProjectEnvironmentVariableMapOutput

func (ProjectEnvironmentVariableMap) ToProjectEnvironmentVariableMapOutputWithContext 

func (i ProjectEnvironmentVariableMap) ToProjectEnvironmentVariableMapOutputWithContext(ctx context.Context) ProjectEnvironmentVariableMapOutput

type ProjectEnvironmentVariableMapInput 

type ProjectEnvironmentVariableMapInput interface {
	pulumi.Input

	ToProjectEnvironmentVariableMapOutput() ProjectEnvironmentVariableMapOutput
	ToProjectEnvironmentVariableMapOutputWithContext(context.Context) ProjectEnvironmentVariableMapOutput
}

ProjectEnvironmentVariableMapInput is an input type that accepts ProjectEnvironmentVariableMap and ProjectEnvironmentVariableMapOutput values. You can construct a concrete instance of `ProjectEnvironmentVariableMapInput` via: 

ProjectEnvironmentVariableMap{ "key": ProjectEnvironmentVariableArgs{...} }

type ProjectEnvironmentVariableMapOutput 

type ProjectEnvironmentVariableMapOutput struct{ *pulumi.OutputState }

func (ProjectEnvironmentVariableMapOutput) ElementType 

func (ProjectEnvironmentVariableMapOutput) ElementType() reflect.Type

func (ProjectEnvironmentVariableMapOutput) MapIndex 

func (o ProjectEnvironmentVariableMapOutput) MapIndex(k pulumi.StringInput) ProjectEnvironmentVariableOutput

func (ProjectEnvironmentVariableMapOutput) ToProjectEnvironmentVariableMapOutput 

func (o ProjectEnvironmentVariableMapOutput) ToProjectEnvironmentVariableMapOutput() ProjectEnvironmentVariableMapOutput

func (ProjectEnvironmentVariableMapOutput) ToProjectEnvironmentVariableMapOutputWithContext 

func (o ProjectEnvironmentVariableMapOutput) ToProjectEnvironmentVariableMapOutputWithContext(ctx context.Context) ProjectEnvironmentVariableMapOutput

type ProjectEnvironmentVariableOutput 

type ProjectEnvironmentVariableOutput struct{ *pulumi.OutputState }

func (ProjectEnvironmentVariableOutput) ElementType 

func (ProjectEnvironmentVariableOutput) ElementType() reflect.Type

func (ProjectEnvironmentVariableOutput) GitBranch 

func (o ProjectEnvironmentVariableOutput) GitBranch() pulumi.StringPtrOutput

The git branch of the Environment Variable.

func (ProjectEnvironmentVariableOutput) Key 

func (o ProjectEnvironmentVariableOutput) Key() pulumi.StringOutput

The name of the Environment Variable.

func (ProjectEnvironmentVariableOutput) ProjectId 

func (o ProjectEnvironmentVariableOutput) ProjectId() pulumi.StringOutput

The ID of the Vercel project.

func (ProjectEnvironmentVariableOutput) Sensitive added in v1.1.0 

func (o ProjectEnvironmentVariableOutput) Sensitive() pulumi.BoolOutput

Whether the Environment Variable is sensitive or not.

func (ProjectEnvironmentVariableOutput) Targets 

func (o ProjectEnvironmentVariableOutput) Targets() pulumi.StringArrayOutput

The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.

func (ProjectEnvironmentVariableOutput) TeamId 

func (o ProjectEnvironmentVariableOutput) TeamId() pulumi.StringOutput

The ID of the Vercel team.Required when configuring a team resource if a default team has not been set in the provider.

func (ProjectEnvironmentVariableOutput) ToProjectEnvironmentVariableOutput 

func (o ProjectEnvironmentVariableOutput) ToProjectEnvironmentVariableOutput() ProjectEnvironmentVariableOutput

func (ProjectEnvironmentVariableOutput) ToProjectEnvironmentVariableOutputWithContext 

func (o ProjectEnvironmentVariableOutput) ToProjectEnvironmentVariableOutputWithContext(ctx context.Context) ProjectEnvironmentVariableOutput

func (ProjectEnvironmentVariableOutput) Value 

func (o ProjectEnvironmentVariableOutput) Value() pulumi.StringOutput

The value of the Environment Variable.

type ProjectEnvironmentVariableState 

type ProjectEnvironmentVariableState struct {
	// The git branch of the Environment Variable.
	GitBranch pulumi.StringPtrInput
	// The name of the Environment Variable.
	Key pulumi.StringPtrInput
	// The ID of the Vercel project.
	ProjectId pulumi.StringPtrInput
	// Whether the Environment Variable is sensitive or not.
	Sensitive pulumi.BoolPtrInput
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets pulumi.StringArrayInput
	// The ID of the Vercel team.Required when configuring a team resource if a default team has not been set in the provider.
	TeamId pulumi.StringPtrInput
	// The value of the Environment Variable.
	Value pulumi.StringPtrInput
}

func (ProjectEnvironmentVariableState) ElementType 

func (ProjectEnvironmentVariableState) ElementType() reflect.Type

type ProjectGitRepository 

type ProjectGitRepository struct {
	// By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
	ProductionBranch *string `pulumi:"productionBranch"`
	// The name of the git repository. For example: `vercel/next.js`.
	Repo string `pulumi:"repo"`
	// The git provider of the repository. Must be either `github`, `gitlab`, or `bitbucket`.
	Type string `pulumi:"type"`
}

type ProjectGitRepositoryArgs 

type ProjectGitRepositoryArgs struct {
	// By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
	ProductionBranch pulumi.StringPtrInput `pulumi:"productionBranch"`
	// The name of the git repository. For example: `vercel/next.js`.
	Repo pulumi.StringInput `pulumi:"repo"`
	// The git provider of the repository. Must be either `github`, `gitlab`, or `bitbucket`.
	Type pulumi.StringInput `pulumi:"type"`
}

func (ProjectGitRepositoryArgs) ElementType 

func (ProjectGitRepositoryArgs) ElementType() reflect.Type

func (ProjectGitRepositoryArgs) ToProjectGitRepositoryOutput 

func (i ProjectGitRepositoryArgs) ToProjectGitRepositoryOutput() ProjectGitRepositoryOutput

func (ProjectGitRepositoryArgs) ToProjectGitRepositoryOutputWithContext 

func (i ProjectGitRepositoryArgs) ToProjectGitRepositoryOutputWithContext(ctx context.Context) ProjectGitRepositoryOutput

func (ProjectGitRepositoryArgs) ToProjectGitRepositoryPtrOutput 

func (i ProjectGitRepositoryArgs) ToProjectGitRepositoryPtrOutput() ProjectGitRepositoryPtrOutput

func (ProjectGitRepositoryArgs) ToProjectGitRepositoryPtrOutputWithContext 

func (i ProjectGitRepositoryArgs) ToProjectGitRepositoryPtrOutputWithContext(ctx context.Context) ProjectGitRepositoryPtrOutput

type ProjectGitRepositoryInput 

type ProjectGitRepositoryInput interface {
	pulumi.Input

	ToProjectGitRepositoryOutput() ProjectGitRepositoryOutput
	ToProjectGitRepositoryOutputWithContext(context.Context) ProjectGitRepositoryOutput
}

ProjectGitRepositoryInput is an input type that accepts ProjectGitRepositoryArgs and ProjectGitRepositoryOutput values. You can construct a concrete instance of `ProjectGitRepositoryInput` via: 

ProjectGitRepositoryArgs{...}

type ProjectGitRepositoryOutput 

type ProjectGitRepositoryOutput struct{ *pulumi.OutputState }

func (ProjectGitRepositoryOutput) ElementType 

func (ProjectGitRepositoryOutput) ElementType() reflect.Type

func (ProjectGitRepositoryOutput) ProductionBranch 

func (o ProjectGitRepositoryOutput) ProductionBranch() pulumi.StringPtrOutput

By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.

func (ProjectGitRepositoryOutput) Repo 

func (o ProjectGitRepositoryOutput) Repo() pulumi.StringOutput

The name of the git repository. For example: `vercel/next.js`.

func (ProjectGitRepositoryOutput) ToProjectGitRepositoryOutput 

func (o ProjectGitRepositoryOutput) ToProjectGitRepositoryOutput() ProjectGitRepositoryOutput

func (ProjectGitRepositoryOutput) ToProjectGitRepositoryOutputWithContext 

func (o ProjectGitRepositoryOutput) ToProjectGitRepositoryOutputWithContext(ctx context.Context) ProjectGitRepositoryOutput

func (ProjectGitRepositoryOutput) ToProjectGitRepositoryPtrOutput 

func (o ProjectGitRepositoryOutput) ToProjectGitRepositoryPtrOutput() ProjectGitRepositoryPtrOutput

func (ProjectGitRepositoryOutput) ToProjectGitRepositoryPtrOutputWithContext 

func (o ProjectGitRepositoryOutput) ToProjectGitRepositoryPtrOutputWithContext(ctx context.Context) ProjectGitRepositoryPtrOutput

func (ProjectGitRepositoryOutput) Type 

func (o ProjectGitRepositoryOutput) Type() pulumi.StringOutput

The git provider of the repository. Must be either `github`, `gitlab`, or `bitbucket`.

type ProjectGitRepositoryPtrInput 

type ProjectGitRepositoryPtrInput interface {
	pulumi.Input

	ToProjectGitRepositoryPtrOutput() ProjectGitRepositoryPtrOutput
	ToProjectGitRepositoryPtrOutputWithContext(context.Context) ProjectGitRepositoryPtrOutput
}

ProjectGitRepositoryPtrInput is an input type that accepts ProjectGitRepositoryArgs, ProjectGitRepositoryPtr and ProjectGitRepositoryPtrOutput values. You can construct a concrete instance of `ProjectGitRepositoryPtrInput` via: 

        ProjectGitRepositoryArgs{...}

or:

        nil

func ProjectGitRepositoryPtr 

func ProjectGitRepositoryPtr(v *ProjectGitRepositoryArgs) ProjectGitRepositoryPtrInput

type ProjectGitRepositoryPtrOutput 

type ProjectGitRepositoryPtrOutput struct{ *pulumi.OutputState }

func (ProjectGitRepositoryPtrOutput) Elem 

func (o ProjectGitRepositoryPtrOutput) Elem() ProjectGitRepositoryOutput

func (ProjectGitRepositoryPtrOutput) ElementType 

func (ProjectGitRepositoryPtrOutput) ElementType() reflect.Type

func (ProjectGitRepositoryPtrOutput) ProductionBranch 

func (o ProjectGitRepositoryPtrOutput) ProductionBranch() pulumi.StringPtrOutput

By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.

func (ProjectGitRepositoryPtrOutput) Repo 

func (o ProjectGitRepositoryPtrOutput) Repo() pulumi.StringPtrOutput

The name of the git repository. For example: `vercel/next.js`.

func (ProjectGitRepositoryPtrOutput) ToProjectGitRepositoryPtrOutput 

func (o ProjectGitRepositoryPtrOutput) ToProjectGitRepositoryPtrOutput() ProjectGitRepositoryPtrOutput

func (ProjectGitRepositoryPtrOutput) ToProjectGitRepositoryPtrOutputWithContext 

func (o ProjectGitRepositoryPtrOutput) ToProjectGitRepositoryPtrOutputWithContext(ctx context.Context) ProjectGitRepositoryPtrOutput

func (ProjectGitRepositoryPtrOutput) Type 

func (o ProjectGitRepositoryPtrOutput) Type() pulumi.StringPtrOutput

The git provider of the repository. Must be either `github`, `gitlab`, or `bitbucket`.

type ProjectInput 

type ProjectInput interface {
	pulumi.Input

	ToProjectOutput() ProjectOutput
	ToProjectOutputWithContext(ctx context.Context) ProjectOutput
}

type ProjectMap 

type ProjectMap map[string]ProjectInput

func (ProjectMap) ElementType 

func (ProjectMap) ElementType() reflect.Type

func (ProjectMap) ToProjectMapOutput 

func (i ProjectMap) ToProjectMapOutput() ProjectMapOutput

func (ProjectMap) ToProjectMapOutputWithContext 

func (i ProjectMap) ToProjectMapOutputWithContext(ctx context.Context) ProjectMapOutput

type ProjectMapInput 

type ProjectMapInput interface {
	pulumi.Input

	ToProjectMapOutput() ProjectMapOutput
	ToProjectMapOutputWithContext(context.Context) ProjectMapOutput
}

ProjectMapInput is an input type that accepts ProjectMap and ProjectMapOutput values. You can construct a concrete instance of `ProjectMapInput` via: 

ProjectMap{ "key": ProjectArgs{...} }

type ProjectMapOutput 

type ProjectMapOutput struct{ *pulumi.OutputState }

func (ProjectMapOutput) ElementType 

func (ProjectMapOutput) ElementType() reflect.Type

func (ProjectMapOutput) MapIndex 

func (o ProjectMapOutput) MapIndex(k pulumi.StringInput) ProjectOutput

func (ProjectMapOutput) ToProjectMapOutput 

func (o ProjectMapOutput) ToProjectMapOutput() ProjectMapOutput

func (ProjectMapOutput) ToProjectMapOutputWithContext 

func (o ProjectMapOutput) ToProjectMapOutputWithContext(ctx context.Context) ProjectMapOutput

type ProjectOutput 

type ProjectOutput struct{ *pulumi.OutputState }

func (ProjectOutput) BuildCommand 

func (o ProjectOutput) BuildCommand() pulumi.StringPtrOutput

The build command for this project. If omitted, this value will be automatically detected.

func (ProjectOutput) DevCommand 

func (o ProjectOutput) DevCommand() pulumi.StringPtrOutput

The dev command for this project. If omitted, this value will be automatically detected.

func (ProjectOutput) ElementType 

func (ProjectOutput) ElementType() reflect.Type

func (ProjectOutput) Environments 

func (o ProjectOutput) Environments() ProjectEnvironmentArrayOutput

A set of Environment Variables that should be configured for the project.

func (ProjectOutput) Framework 

func (o ProjectOutput) Framework() pulumi.StringPtrOutput

The framework that is being used for this project. If omitted, no framework is selected.

func (ProjectOutput) GitRepository 

func (o ProjectOutput) GitRepository() ProjectGitRepositoryPtrOutput

The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for [Github](https://vercel.com/docs/concepts/git/vercel-for-github), [Gitlab](https://vercel.com/docs/concepts/git/vercel-for-gitlab) or [Bitbucket](https://vercel.com/docs/concepts/git/vercel-for-bitbucket) plugins to be installed.

func (ProjectOutput) IgnoreCommand 

func (o ProjectOutput) IgnoreCommand() pulumi.StringPtrOutput

When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.

func (ProjectOutput) InstallCommand 

func (o ProjectOutput) InstallCommand() pulumi.StringPtrOutput

The install command for this project. If omitted, this value will be automatically detected.

func (ProjectOutput) Name 

func (o ProjectOutput) Name() pulumi.StringOutput

The desired name for the project.

func (ProjectOutput) OutputDirectory 

func (o ProjectOutput) OutputDirectory() pulumi.StringPtrOutput

The output directory of the project. If omitted, this value will be automatically detected.

func (ProjectOutput) PasswordProtection 

func (o ProjectOutput) PasswordProtection() ProjectPasswordProtectionPtrOutput

Ensures visitors of your Preview Deployments must enter a password in order to gain access.

func (ProjectOutput) ProtectionBypassForAutomation 

func (o ProjectOutput) ProtectionBypassForAutomation() pulumi.BoolPtrOutput

Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named `x-vercel-protection-bypass` with a value of the `passwordProtectionForAutomationSecret` field.

func (ProjectOutput) ProtectionBypassForAutomationSecret 

func (o ProjectOutput) ProtectionBypassForAutomationSecret() pulumi.StringOutput

If `protectionBypassForAutomation` is enabled, use this value in the `x-vercel-protection-bypass` header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.

func (ProjectOutput) PublicSource 

func (o ProjectOutput) PublicSource() pulumi.BoolPtrOutput

By default, visitors to the `/_logs` and `/_src` paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting `publicSource` to `true` disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.

func (ProjectOutput) RootDirectory 

func (o ProjectOutput) RootDirectory() pulumi.StringPtrOutput

The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.

func (ProjectOutput) ServerlessFunctionRegion 

func (o ProjectOutput) ServerlessFunctionRegion() pulumi.StringOutput

The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see [Vercel's documentation](https://vercel.com/docs/concepts/edge-network/regions) for a full list of regions.

func (ProjectOutput) TeamId 

func (o ProjectOutput) TeamId() pulumi.StringOutput

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.

func (ProjectOutput) ToProjectOutput 

func (o ProjectOutput) ToProjectOutput() ProjectOutput

func (ProjectOutput) ToProjectOutputWithContext 

func (o ProjectOutput) ToProjectOutputWithContext(ctx context.Context) ProjectOutput

func (ProjectOutput) TrustedIps added in v1.0.1 

func (o ProjectOutput) TrustedIps() ProjectTrustedIpsPtrOutput

Ensures only visitors from an allowed IP address can access your deployment.

func (ProjectOutput) VercelAuthentication 

func (o ProjectOutput) VercelAuthentication() ProjectVercelAuthenticationOutput

Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.

type ProjectPasswordProtection 

type ProjectPasswordProtection struct {
	// The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, or `onlyPreviewDeployments`.
	DeploymentType string `pulumi:"deploymentType"`
	// The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field.
	Password string `pulumi:"password"`
}

type ProjectPasswordProtectionArgs 

type ProjectPasswordProtectionArgs struct {
	// The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, or `onlyPreviewDeployments`.
	DeploymentType pulumi.StringInput `pulumi:"deploymentType"`
	// The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field.
	Password pulumi.StringInput `pulumi:"password"`
}

func (ProjectPasswordProtectionArgs) ElementType 

func (ProjectPasswordProtectionArgs) ElementType() reflect.Type

func (ProjectPasswordProtectionArgs) ToProjectPasswordProtectionOutput 

func (i ProjectPasswordProtectionArgs) ToProjectPasswordProtectionOutput() ProjectPasswordProtectionOutput

func (ProjectPasswordProtectionArgs) ToProjectPasswordProtectionOutputWithContext 

func (i ProjectPasswordProtectionArgs) ToProjectPasswordProtectionOutputWithContext(ctx context.Context) ProjectPasswordProtectionOutput

func (ProjectPasswordProtectionArgs) ToProjectPasswordProtectionPtrOutput 

func (i ProjectPasswordProtectionArgs) ToProjectPasswordProtectionPtrOutput() ProjectPasswordProtectionPtrOutput

func (ProjectPasswordProtectionArgs) ToProjectPasswordProtectionPtrOutputWithContext 

func (i ProjectPasswordProtectionArgs) ToProjectPasswordProtectionPtrOutputWithContext(ctx context.Context) ProjectPasswordProtectionPtrOutput

type ProjectPasswordProtectionInput 

type ProjectPasswordProtectionInput interface {
	pulumi.Input

	ToProjectPasswordProtectionOutput() ProjectPasswordProtectionOutput
	ToProjectPasswordProtectionOutputWithContext(context.Context) ProjectPasswordProtectionOutput
}

ProjectPasswordProtectionInput is an input type that accepts ProjectPasswordProtectionArgs and ProjectPasswordProtectionOutput values. You can construct a concrete instance of `ProjectPasswordProtectionInput` via: 

ProjectPasswordProtectionArgs{...}

type ProjectPasswordProtectionOutput 

type ProjectPasswordProtectionOutput struct{ *pulumi.OutputState }

func (ProjectPasswordProtectionOutput) DeploymentType added in v1.0.1 

func (o ProjectPasswordProtectionOutput) DeploymentType() pulumi.StringOutput

The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, or `onlyPreviewDeployments`.

func (ProjectPasswordProtectionOutput) ElementType 

func (ProjectPasswordProtectionOutput) ElementType() reflect.Type

func (ProjectPasswordProtectionOutput) Password 

func (o ProjectPasswordProtectionOutput) Password() pulumi.StringOutput

The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field.

func (ProjectPasswordProtectionOutput) ToProjectPasswordProtectionOutput 

func (o ProjectPasswordProtectionOutput) ToProjectPasswordProtectionOutput() ProjectPasswordProtectionOutput

func (ProjectPasswordProtectionOutput) ToProjectPasswordProtectionOutputWithContext 

func (o ProjectPasswordProtectionOutput) ToProjectPasswordProtectionOutputWithContext(ctx context.Context) ProjectPasswordProtectionOutput

func (ProjectPasswordProtectionOutput) ToProjectPasswordProtectionPtrOutput 

func (o ProjectPasswordProtectionOutput) ToProjectPasswordProtectionPtrOutput() ProjectPasswordProtectionPtrOutput

func (ProjectPasswordProtectionOutput) ToProjectPasswordProtectionPtrOutputWithContext 

func (o ProjectPasswordProtectionOutput) ToProjectPasswordProtectionPtrOutputWithContext(ctx context.Context) ProjectPasswordProtectionPtrOutput

type ProjectPasswordProtectionPtrInput 

type ProjectPasswordProtectionPtrInput interface {
	pulumi.Input

	ToProjectPasswordProtectionPtrOutput() ProjectPasswordProtectionPtrOutput
	ToProjectPasswordProtectionPtrOutputWithContext(context.Context) ProjectPasswordProtectionPtrOutput
}

ProjectPasswordProtectionPtrInput is an input type that accepts ProjectPasswordProtectionArgs, ProjectPasswordProtectionPtr and ProjectPasswordProtectionPtrOutput values. You can construct a concrete instance of `ProjectPasswordProtectionPtrInput` via: 

        ProjectPasswordProtectionArgs{...}

or:

        nil

func ProjectPasswordProtectionPtr 

func ProjectPasswordProtectionPtr(v *ProjectPasswordProtectionArgs) ProjectPasswordProtectionPtrInput

type ProjectPasswordProtectionPtrOutput 

type ProjectPasswordProtectionPtrOutput struct{ *pulumi.OutputState }

func (ProjectPasswordProtectionPtrOutput) DeploymentType added in v1.0.1 

func (o ProjectPasswordProtectionPtrOutput) DeploymentType() pulumi.StringPtrOutput

The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, or `onlyPreviewDeployments`.

func (ProjectPasswordProtectionPtrOutput) Elem 

func (o ProjectPasswordProtectionPtrOutput) Elem() ProjectPasswordProtectionOutput

func (ProjectPasswordProtectionPtrOutput) ElementType 

func (ProjectPasswordProtectionPtrOutput) ElementType() reflect.Type

func (ProjectPasswordProtectionPtrOutput) Password 

func (o ProjectPasswordProtectionPtrOutput) Password() pulumi.StringPtrOutput

The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field.

func (ProjectPasswordProtectionPtrOutput) ToProjectPasswordProtectionPtrOutput 

func (o ProjectPasswordProtectionPtrOutput) ToProjectPasswordProtectionPtrOutput() ProjectPasswordProtectionPtrOutput

func (ProjectPasswordProtectionPtrOutput) ToProjectPasswordProtectionPtrOutputWithContext 

func (o ProjectPasswordProtectionPtrOutput) ToProjectPasswordProtectionPtrOutputWithContext(ctx context.Context) ProjectPasswordProtectionPtrOutput

type ProjectState 

type ProjectState struct {
	// The build command for this project. If omitted, this value will be automatically detected.
	BuildCommand pulumi.StringPtrInput
	// The dev command for this project. If omitted, this value will be automatically detected.
	DevCommand pulumi.StringPtrInput
	// A set of Environment Variables that should be configured for the project.
	Environments ProjectEnvironmentArrayInput
	// The framework that is being used for this project. If omitted, no framework is selected.
	Framework pulumi.StringPtrInput
	// The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for [Github](https://vercel.com/docs/concepts/git/vercel-for-github), [Gitlab](https://vercel.com/docs/concepts/git/vercel-for-gitlab) or [Bitbucket](https://vercel.com/docs/concepts/git/vercel-for-bitbucket) plugins to be installed.
	GitRepository ProjectGitRepositoryPtrInput
	// When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
	IgnoreCommand pulumi.StringPtrInput
	// The install command for this project. If omitted, this value will be automatically detected.
	InstallCommand pulumi.StringPtrInput
	// The desired name for the project.
	Name pulumi.StringPtrInput
	// The output directory of the project. If omitted, this value will be automatically detected.
	OutputDirectory pulumi.StringPtrInput
	// Ensures visitors of your Preview Deployments must enter a password in order to gain access.
	PasswordProtection ProjectPasswordProtectionPtrInput
	// Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named `x-vercel-protection-bypass` with a value of the `passwordProtectionForAutomationSecret` field.
	ProtectionBypassForAutomation pulumi.BoolPtrInput
	// If `protectionBypassForAutomation` is enabled, use this value in the `x-vercel-protection-bypass` header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
	ProtectionBypassForAutomationSecret pulumi.StringPtrInput
	// By default, visitors to the `/_logs` and `/_src` paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting `publicSource` to `true` disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
	PublicSource pulumi.BoolPtrInput
	// The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
	RootDirectory pulumi.StringPtrInput
	// The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see [Vercel's documentation](https://vercel.com/docs/concepts/edge-network/regions) for a full list of regions.
	ServerlessFunctionRegion pulumi.StringPtrInput
	// 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.StringPtrInput
	// Ensures only visitors from an allowed IP address can access your deployment.
	TrustedIps ProjectTrustedIpsPtrInput
	// Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
	VercelAuthentication ProjectVercelAuthenticationPtrInput
}

func (ProjectState) ElementType 

func (ProjectState) ElementType() reflect.Type

type ProjectTrustedIps added in v1.0.1 

type ProjectTrustedIps struct {
	// The allowed IP addressses and CIDR ranges with optional descriptions.
	Addresses []ProjectTrustedIpsAddress `pulumi:"addresses"`
	// The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, `onlyProductionDeployments`, or `onlyPreviewDeployments`.
	DeploymentType string `pulumi:"deploymentType"`
	// Whether or not Trusted IPs is optional to access a deployment. Must be either `trustedIpRequired` or `trustedIpOptional`. `trustedIpOptional` is only available with Standalone Trusted IPs.
	ProtectionMode *string `pulumi:"protectionMode"`
}

type ProjectTrustedIpsAddress added in v1.0.1 

type ProjectTrustedIpsAddress struct {
	// A description for the value
	Note *string `pulumi:"note"`
	// The value of the Environment Variable.
	Value string `pulumi:"value"`
}

type ProjectTrustedIpsAddressArgs added in v1.0.1 

type ProjectTrustedIpsAddressArgs struct {
	// A description for the value
	Note pulumi.StringPtrInput `pulumi:"note"`
	// The value of the Environment Variable.
	Value pulumi.StringInput `pulumi:"value"`
}

func (ProjectTrustedIpsAddressArgs) ElementType added in v1.0.1 

func (ProjectTrustedIpsAddressArgs) ElementType() reflect.Type

func (ProjectTrustedIpsAddressArgs) ToProjectTrustedIpsAddressOutput added in v1.0.1 

func (i ProjectTrustedIpsAddressArgs) ToProjectTrustedIpsAddressOutput() ProjectTrustedIpsAddressOutput

func (ProjectTrustedIpsAddressArgs) ToProjectTrustedIpsAddressOutputWithContext added in v1.0.1 

func (i ProjectTrustedIpsAddressArgs) ToProjectTrustedIpsAddressOutputWithContext(ctx context.Context) ProjectTrustedIpsAddressOutput

type ProjectTrustedIpsAddressArray added in v1.0.1 

type ProjectTrustedIpsAddressArray []ProjectTrustedIpsAddressInput

func (ProjectTrustedIpsAddressArray) ElementType added in v1.0.1 

func (ProjectTrustedIpsAddressArray) ElementType() reflect.Type

func (ProjectTrustedIpsAddressArray) ToProjectTrustedIpsAddressArrayOutput added in v1.0.1 

func (i ProjectTrustedIpsAddressArray) ToProjectTrustedIpsAddressArrayOutput() ProjectTrustedIpsAddressArrayOutput

func (ProjectTrustedIpsAddressArray) ToProjectTrustedIpsAddressArrayOutputWithContext added in v1.0.1 

func (i ProjectTrustedIpsAddressArray) ToProjectTrustedIpsAddressArrayOutputWithContext(ctx context.Context) ProjectTrustedIpsAddressArrayOutput

type ProjectTrustedIpsAddressArrayInput added in v1.0.1 

type ProjectTrustedIpsAddressArrayInput interface {
	pulumi.Input

	ToProjectTrustedIpsAddressArrayOutput() ProjectTrustedIpsAddressArrayOutput
	ToProjectTrustedIpsAddressArrayOutputWithContext(context.Context) ProjectTrustedIpsAddressArrayOutput
}

ProjectTrustedIpsAddressArrayInput is an input type that accepts ProjectTrustedIpsAddressArray and ProjectTrustedIpsAddressArrayOutput values. You can construct a concrete instance of `ProjectTrustedIpsAddressArrayInput` via: 

ProjectTrustedIpsAddressArray{ ProjectTrustedIpsAddressArgs{...} }

type ProjectTrustedIpsAddressArrayOutput added in v1.0.1 

type ProjectTrustedIpsAddressArrayOutput struct{ *pulumi.OutputState }

func (ProjectTrustedIpsAddressArrayOutput) ElementType added in v1.0.1 

func (ProjectTrustedIpsAddressArrayOutput) ElementType() reflect.Type

func (ProjectTrustedIpsAddressArrayOutput) Index added in v1.0.1 

func (o ProjectTrustedIpsAddressArrayOutput) Index(i pulumi.IntInput) ProjectTrustedIpsAddressOutput

func (ProjectTrustedIpsAddressArrayOutput) ToProjectTrustedIpsAddressArrayOutput added in v1.0.1 

func (o ProjectTrustedIpsAddressArrayOutput) ToProjectTrustedIpsAddressArrayOutput() ProjectTrustedIpsAddressArrayOutput

func (ProjectTrustedIpsAddressArrayOutput) ToProjectTrustedIpsAddressArrayOutputWithContext added in v1.0.1 

func (o ProjectTrustedIpsAddressArrayOutput) ToProjectTrustedIpsAddressArrayOutputWithContext(ctx context.Context) ProjectTrustedIpsAddressArrayOutput

type ProjectTrustedIpsAddressInput added in v1.0.1 

type ProjectTrustedIpsAddressInput interface {
	pulumi.Input

	ToProjectTrustedIpsAddressOutput() ProjectTrustedIpsAddressOutput
	ToProjectTrustedIpsAddressOutputWithContext(context.Context) ProjectTrustedIpsAddressOutput
}

ProjectTrustedIpsAddressInput is an input type that accepts ProjectTrustedIpsAddressArgs and ProjectTrustedIpsAddressOutput values. You can construct a concrete instance of `ProjectTrustedIpsAddressInput` via: 

ProjectTrustedIpsAddressArgs{...}

type ProjectTrustedIpsAddressOutput added in v1.0.1 

type ProjectTrustedIpsAddressOutput struct{ *pulumi.OutputState }

func (ProjectTrustedIpsAddressOutput) ElementType added in v1.0.1 

func (ProjectTrustedIpsAddressOutput) ElementType() reflect.Type

func (ProjectTrustedIpsAddressOutput) Note added in v1.0.1 

func (o ProjectTrustedIpsAddressOutput) Note() pulumi.StringPtrOutput

A description for the value

func (ProjectTrustedIpsAddressOutput) ToProjectTrustedIpsAddressOutput added in v1.0.1 

func (o ProjectTrustedIpsAddressOutput) ToProjectTrustedIpsAddressOutput() ProjectTrustedIpsAddressOutput

func (ProjectTrustedIpsAddressOutput) ToProjectTrustedIpsAddressOutputWithContext added in v1.0.1 

func (o ProjectTrustedIpsAddressOutput) ToProjectTrustedIpsAddressOutputWithContext(ctx context.Context) ProjectTrustedIpsAddressOutput

func (ProjectTrustedIpsAddressOutput) Value added in v1.0.1 

func (o ProjectTrustedIpsAddressOutput) Value() pulumi.StringOutput

The value of the Environment Variable.

type ProjectTrustedIpsArgs added in v1.0.1 

type ProjectTrustedIpsArgs struct {
	// The allowed IP addressses and CIDR ranges with optional descriptions.
	Addresses ProjectTrustedIpsAddressArrayInput `pulumi:"addresses"`
	// The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, `onlyProductionDeployments`, or `onlyPreviewDeployments`.
	DeploymentType pulumi.StringInput `pulumi:"deploymentType"`
	// Whether or not Trusted IPs is optional to access a deployment. Must be either `trustedIpRequired` or `trustedIpOptional`. `trustedIpOptional` is only available with Standalone Trusted IPs.
	ProtectionMode pulumi.StringPtrInput `pulumi:"protectionMode"`
}

func (ProjectTrustedIpsArgs) ElementType added in v1.0.1 

func (ProjectTrustedIpsArgs) ElementType() reflect.Type

func (ProjectTrustedIpsArgs) ToProjectTrustedIpsOutput added in v1.0.1 

func (i ProjectTrustedIpsArgs) ToProjectTrustedIpsOutput() ProjectTrustedIpsOutput

func (ProjectTrustedIpsArgs) ToProjectTrustedIpsOutputWithContext added in v1.0.1 

func (i ProjectTrustedIpsArgs) ToProjectTrustedIpsOutputWithContext(ctx context.Context) ProjectTrustedIpsOutput

func (ProjectTrustedIpsArgs) ToProjectTrustedIpsPtrOutput added in v1.0.1 

func (i ProjectTrustedIpsArgs) ToProjectTrustedIpsPtrOutput() ProjectTrustedIpsPtrOutput

func (ProjectTrustedIpsArgs) ToProjectTrustedIpsPtrOutputWithContext added in v1.0.1 

func (i ProjectTrustedIpsArgs) ToProjectTrustedIpsPtrOutputWithContext(ctx context.Context) ProjectTrustedIpsPtrOutput

type ProjectTrustedIpsInput added in v1.0.1 

type ProjectTrustedIpsInput interface {
	pulumi.Input

	ToProjectTrustedIpsOutput() ProjectTrustedIpsOutput
	ToProjectTrustedIpsOutputWithContext(context.Context) ProjectTrustedIpsOutput
}

ProjectTrustedIpsInput is an input type that accepts ProjectTrustedIpsArgs and ProjectTrustedIpsOutput values. You can construct a concrete instance of `ProjectTrustedIpsInput` via: 

ProjectTrustedIpsArgs{...}

type ProjectTrustedIpsOutput added in v1.0.1 

type ProjectTrustedIpsOutput struct{ *pulumi.OutputState }

func (ProjectTrustedIpsOutput) Addresses added in v1.0.1 

func (o ProjectTrustedIpsOutput) Addresses() ProjectTrustedIpsAddressArrayOutput

The allowed IP addressses and CIDR ranges with optional descriptions.

func (ProjectTrustedIpsOutput) DeploymentType added in v1.0.1 

func (o ProjectTrustedIpsOutput) DeploymentType() pulumi.StringOutput

The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, `onlyProductionDeployments`, or `onlyPreviewDeployments`.

func (ProjectTrustedIpsOutput) ElementType added in v1.0.1 

func (ProjectTrustedIpsOutput) ElementType() reflect.Type

func (ProjectTrustedIpsOutput) ProtectionMode added in v1.0.1 

func (o ProjectTrustedIpsOutput) ProtectionMode() pulumi.StringPtrOutput

Whether or not Trusted IPs is optional to access a deployment. Must be either `trustedIpRequired` or `trustedIpOptional`. `trustedIpOptional` is only available with Standalone Trusted IPs.

func (ProjectTrustedIpsOutput) ToProjectTrustedIpsOutput added in v1.0.1 

func (o ProjectTrustedIpsOutput) ToProjectTrustedIpsOutput() ProjectTrustedIpsOutput

func (ProjectTrustedIpsOutput) ToProjectTrustedIpsOutputWithContext added in v1.0.1 

func (o ProjectTrustedIpsOutput) ToProjectTrustedIpsOutputWithContext(ctx context.Context) ProjectTrustedIpsOutput

func (ProjectTrustedIpsOutput) ToProjectTrustedIpsPtrOutput added in v1.0.1 

func (o ProjectTrustedIpsOutput) ToProjectTrustedIpsPtrOutput() ProjectTrustedIpsPtrOutput

func (ProjectTrustedIpsOutput) ToProjectTrustedIpsPtrOutputWithContext added in v1.0.1 

func (o ProjectTrustedIpsOutput) ToProjectTrustedIpsPtrOutputWithContext(ctx context.Context) ProjectTrustedIpsPtrOutput

type ProjectTrustedIpsPtrInput added in v1.0.1 

type ProjectTrustedIpsPtrInput interface {
	pulumi.Input

	ToProjectTrustedIpsPtrOutput() ProjectTrustedIpsPtrOutput
	ToProjectTrustedIpsPtrOutputWithContext(context.Context) ProjectTrustedIpsPtrOutput
}

ProjectTrustedIpsPtrInput is an input type that accepts ProjectTrustedIpsArgs, ProjectTrustedIpsPtr and ProjectTrustedIpsPtrOutput values. You can construct a concrete instance of `ProjectTrustedIpsPtrInput` via: 

        ProjectTrustedIpsArgs{...}

or:

        nil

func ProjectTrustedIpsPtr added in v1.0.1 

func ProjectTrustedIpsPtr(v *ProjectTrustedIpsArgs) ProjectTrustedIpsPtrInput

type ProjectTrustedIpsPtrOutput added in v1.0.1 

type ProjectTrustedIpsPtrOutput struct{ *pulumi.OutputState }

func (ProjectTrustedIpsPtrOutput) Addresses added in v1.0.1 

func (o ProjectTrustedIpsPtrOutput) Addresses() ProjectTrustedIpsAddressArrayOutput

The allowed IP addressses and CIDR ranges with optional descriptions.

func (ProjectTrustedIpsPtrOutput) DeploymentType added in v1.0.1 

func (o ProjectTrustedIpsPtrOutput) DeploymentType() pulumi.StringPtrOutput

The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, `onlyProductionDeployments`, or `onlyPreviewDeployments`.

func (ProjectTrustedIpsPtrOutput) Elem added in v1.0.1 

func (o ProjectTrustedIpsPtrOutput) Elem() ProjectTrustedIpsOutput

func (ProjectTrustedIpsPtrOutput) ElementType added in v1.0.1 

func (ProjectTrustedIpsPtrOutput) ElementType() reflect.Type

func (ProjectTrustedIpsPtrOutput) ProtectionMode added in v1.0.1 

func (o ProjectTrustedIpsPtrOutput) ProtectionMode() pulumi.StringPtrOutput

Whether or not Trusted IPs is optional to access a deployment. Must be either `trustedIpRequired` or `trustedIpOptional`. `trustedIpOptional` is only available with Standalone Trusted IPs.

func (ProjectTrustedIpsPtrOutput) ToProjectTrustedIpsPtrOutput added in v1.0.1 

func (o ProjectTrustedIpsPtrOutput) ToProjectTrustedIpsPtrOutput() ProjectTrustedIpsPtrOutput

func (ProjectTrustedIpsPtrOutput) ToProjectTrustedIpsPtrOutputWithContext added in v1.0.1 

func (o ProjectTrustedIpsPtrOutput) ToProjectTrustedIpsPtrOutputWithContext(ctx context.Context) ProjectTrustedIpsPtrOutput

type ProjectVercelAuthentication 

type ProjectVercelAuthentication struct {
	// The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, `onlyPreviewDeployments`, or `none`.
	DeploymentType string `pulumi:"deploymentType"`
}

type ProjectVercelAuthenticationArgs 

type ProjectVercelAuthenticationArgs struct {
	// The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, `onlyPreviewDeployments`, or `none`.
	DeploymentType pulumi.StringInput `pulumi:"deploymentType"`
}

func (ProjectVercelAuthenticationArgs) ElementType 

func (ProjectVercelAuthenticationArgs) ElementType() reflect.Type

func (ProjectVercelAuthenticationArgs) ToProjectVercelAuthenticationOutput 

func (i ProjectVercelAuthenticationArgs) ToProjectVercelAuthenticationOutput() ProjectVercelAuthenticationOutput

func (ProjectVercelAuthenticationArgs) ToProjectVercelAuthenticationOutputWithContext 

func (i ProjectVercelAuthenticationArgs) ToProjectVercelAuthenticationOutputWithContext(ctx context.Context) ProjectVercelAuthenticationOutput

func (ProjectVercelAuthenticationArgs) ToProjectVercelAuthenticationPtrOutput 

func (i ProjectVercelAuthenticationArgs) ToProjectVercelAuthenticationPtrOutput() ProjectVercelAuthenticationPtrOutput

func (ProjectVercelAuthenticationArgs) ToProjectVercelAuthenticationPtrOutputWithContext 

func (i ProjectVercelAuthenticationArgs) ToProjectVercelAuthenticationPtrOutputWithContext(ctx context.Context) ProjectVercelAuthenticationPtrOutput

type ProjectVercelAuthenticationInput 

type ProjectVercelAuthenticationInput interface {
	pulumi.Input

	ToProjectVercelAuthenticationOutput() ProjectVercelAuthenticationOutput
	ToProjectVercelAuthenticationOutputWithContext(context.Context) ProjectVercelAuthenticationOutput
}

ProjectVercelAuthenticationInput is an input type that accepts ProjectVercelAuthenticationArgs and ProjectVercelAuthenticationOutput values. You can construct a concrete instance of `ProjectVercelAuthenticationInput` via: 

ProjectVercelAuthenticationArgs{...}

type ProjectVercelAuthenticationOutput 

type ProjectVercelAuthenticationOutput struct{ *pulumi.OutputState }

func (ProjectVercelAuthenticationOutput) DeploymentType added in v1.0.1 

func (o ProjectVercelAuthenticationOutput) DeploymentType() pulumi.StringOutput

The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, `onlyPreviewDeployments`, or `none`.

func (ProjectVercelAuthenticationOutput) ElementType 

func (ProjectVercelAuthenticationOutput) ElementType() reflect.Type

func (ProjectVercelAuthenticationOutput) ToProjectVercelAuthenticationOutput 

func (o ProjectVercelAuthenticationOutput) ToProjectVercelAuthenticationOutput() ProjectVercelAuthenticationOutput

func (ProjectVercelAuthenticationOutput) ToProjectVercelAuthenticationOutputWithContext 

func (o ProjectVercelAuthenticationOutput) ToProjectVercelAuthenticationOutputWithContext(ctx context.Context) ProjectVercelAuthenticationOutput

func (ProjectVercelAuthenticationOutput) ToProjectVercelAuthenticationPtrOutput 

func (o ProjectVercelAuthenticationOutput) ToProjectVercelAuthenticationPtrOutput() ProjectVercelAuthenticationPtrOutput

func (ProjectVercelAuthenticationOutput) ToProjectVercelAuthenticationPtrOutputWithContext 

func (o ProjectVercelAuthenticationOutput) ToProjectVercelAuthenticationPtrOutputWithContext(ctx context.Context) ProjectVercelAuthenticationPtrOutput

type ProjectVercelAuthenticationPtrInput 

type ProjectVercelAuthenticationPtrInput interface {
	pulumi.Input

	ToProjectVercelAuthenticationPtrOutput() ProjectVercelAuthenticationPtrOutput
	ToProjectVercelAuthenticationPtrOutputWithContext(context.Context) ProjectVercelAuthenticationPtrOutput
}

ProjectVercelAuthenticationPtrInput is an input type that accepts ProjectVercelAuthenticationArgs, ProjectVercelAuthenticationPtr and ProjectVercelAuthenticationPtrOutput values. You can construct a concrete instance of `ProjectVercelAuthenticationPtrInput` via: 

        ProjectVercelAuthenticationArgs{...}

or:

        nil

func ProjectVercelAuthenticationPtr 

func ProjectVercelAuthenticationPtr(v *ProjectVercelAuthenticationArgs) ProjectVercelAuthenticationPtrInput

type ProjectVercelAuthenticationPtrOutput 

type ProjectVercelAuthenticationPtrOutput struct{ *pulumi.OutputState }

func (ProjectVercelAuthenticationPtrOutput) DeploymentType added in v1.0.1 

func (o ProjectVercelAuthenticationPtrOutput) DeploymentType() pulumi.StringPtrOutput

The deployment environment to protect. Must be one of `standardProtection`, `allDeployments`, `onlyPreviewDeployments`, or `none`.

func (ProjectVercelAuthenticationPtrOutput) Elem 

func (o ProjectVercelAuthenticationPtrOutput) Elem() ProjectVercelAuthenticationOutput

func (ProjectVercelAuthenticationPtrOutput) ElementType 

func (ProjectVercelAuthenticationPtrOutput) ElementType() reflect.Type

func (ProjectVercelAuthenticationPtrOutput) ToProjectVercelAuthenticationPtrOutput 

func (o ProjectVercelAuthenticationPtrOutput) ToProjectVercelAuthenticationPtrOutput() ProjectVercelAuthenticationPtrOutput

func (ProjectVercelAuthenticationPtrOutput) ToProjectVercelAuthenticationPtrOutputWithContext 

func (o ProjectVercelAuthenticationPtrOutput) ToProjectVercelAuthenticationPtrOutputWithContext(ctx context.Context) ProjectVercelAuthenticationPtrOutput

type Provider 

type Provider struct {
	pulumi.ProviderResourceState

	// The Vercel API Token to use. This can also be specified with the `VERCEL_API_TOKEN` shell environment variable. Tokens
	// can be created from your [Vercel settings](https://vercel.com/account/tokens).
	ApiToken pulumi.StringPtrOutput `pulumi:"apiToken"`
	// The default Vercel Team to use when creating resources. This can be provided as either a team slug, or team ID. The slug
	// and ID are both available from the Team Settings page in the Vercel dashboard.
	Team pulumi.StringPtrOutput `pulumi:"team"`
}

The provider type for the vercel package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

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

func (*Provider) ElementType 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs 

type ProviderArgs struct {
	// The Vercel API Token to use. This can also be specified with the `VERCEL_API_TOKEN` shell environment variable. Tokens
	// can be created from your [Vercel settings](https://vercel.com/account/tokens).
	ApiToken pulumi.StringPtrInput
	// The default Vercel Team to use when creating resources. This can be provided as either a team slug, or team ID. The slug
	// and ID are both available from the Team Settings page in the Vercel dashboard.
	Team pulumi.StringPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput 

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ApiToken 

func (o ProviderOutput) ApiToken() pulumi.StringPtrOutput

The Vercel API Token to use. This can also be specified with the `VERCEL_API_TOKEN` shell environment variable. Tokens can be created from your [Vercel settings](https://vercel.com/account/tokens).

func (ProviderOutput) ElementType 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) Team 

func (o ProviderOutput) Team() pulumi.StringPtrOutput

The default Vercel Team to use when creating resources. This can be provided as either a team slug, or team ID. The slug and ID are both available from the Team Settings page in the Vercel dashboard.

func (ProviderOutput) ToProviderOutput 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type SharedEnvironmentVariable 

type SharedEnvironmentVariable struct {
	pulumi.CustomResourceState

	// The name of the Environment Variable.
	Key pulumi.StringOutput `pulumi:"key"`
	// The ID of the Vercel project.
	ProjectIds pulumi.StringArrayOutput `pulumi:"projectIds"`
	// Whether the Environment Variable is sensitive or not.
	Sensitive pulumi.BoolOutput `pulumi:"sensitive"`
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets pulumi.StringArrayOutput `pulumi:"targets"`
	// The ID of the Vercel team. Shared environment variables require a team.
	TeamId pulumi.StringOutput `pulumi:"teamId"`
	// The value of the Environment Variable.
	Value pulumi.StringOutput `pulumi:"value"`
}

Provides a Shared Environment Variable resource.

A Shared Environment Variable resource defines an Environment Variable that can be shared between multiple Vercel Projects.

For more detailed information, please see the [Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables/shared-environment-variables).

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-vercel/sdk/go/vercel"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleProject, err := vercel.NewProject(ctx, "exampleProject", &vercel.ProjectArgs{
			GitRepository: &vercel.ProjectGitRepositoryArgs{
				Type: pulumi.String("github"),
				Repo: pulumi.String("vercel/some-repo"),
			},
		})
		if err != nil {
			return err
		}
		// A shared environment variable that will be created
		// and associated with the "example" project.
		_, err = vercel.NewSharedEnvironmentVariable(ctx, "exampleSharedEnvironmentVariable", &vercel.SharedEnvironmentVariableArgs{
			Key:   pulumi.String("EXAMPLE"),
			Value: pulumi.String("some_value"),
			Targets: pulumi.StringArray{
				pulumi.String("production"),
			},
			ProjectIds: pulumi.StringArray{
				exampleProject.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

You can import via the team_id and environment variable id.

- team_id can be found in the team `settings` tab in the Vercel UI.

- environment variable id is hard to find, but can be taken from the network tab, inside developer tools, on the shared environment variable page.

#

Note also, that the value field for sensitive environment variables will be imported as `null`.

```sh $ pulumi import vercel:index/sharedEnvironmentVariable:SharedEnvironmentVariable example team_xxxxxxxxxxxxxxxxxxxxxxxx/env_yyyyyyyyyyyyy ```

func GetSharedEnvironmentVariable 

func GetSharedEnvironmentVariable(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SharedEnvironmentVariableState, opts ...pulumi.ResourceOption) (*SharedEnvironmentVariable, error)

GetSharedEnvironmentVariable gets an existing SharedEnvironmentVariable 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 NewSharedEnvironmentVariable 

func NewSharedEnvironmentVariable(ctx *pulumi.Context,
	name string, args *SharedEnvironmentVariableArgs, opts ...pulumi.ResourceOption) (*SharedEnvironmentVariable, error)

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

func (*SharedEnvironmentVariable) ElementType 

func (*SharedEnvironmentVariable) ElementType() reflect.Type

func (*SharedEnvironmentVariable) ToSharedEnvironmentVariableOutput 

func (i *SharedEnvironmentVariable) ToSharedEnvironmentVariableOutput() SharedEnvironmentVariableOutput

func (*SharedEnvironmentVariable) ToSharedEnvironmentVariableOutputWithContext 

func (i *SharedEnvironmentVariable) ToSharedEnvironmentVariableOutputWithContext(ctx context.Context) SharedEnvironmentVariableOutput

type SharedEnvironmentVariableArgs 

type SharedEnvironmentVariableArgs struct {
	// The name of the Environment Variable.
	Key pulumi.StringInput
	// The ID of the Vercel project.
	ProjectIds pulumi.StringArrayInput
	// Whether the Environment Variable is sensitive or not.
	Sensitive pulumi.BoolPtrInput
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets pulumi.StringArrayInput
	// The ID of the Vercel team. Shared environment variables require a team.
	TeamId pulumi.StringPtrInput
	// The value of the Environment Variable.
	Value pulumi.StringInput
}

The set of arguments for constructing a SharedEnvironmentVariable resource.

func (SharedEnvironmentVariableArgs) ElementType 

func (SharedEnvironmentVariableArgs) ElementType() reflect.Type

type SharedEnvironmentVariableArray 

type SharedEnvironmentVariableArray []SharedEnvironmentVariableInput

func (SharedEnvironmentVariableArray) ElementType 

func (SharedEnvironmentVariableArray) ElementType() reflect.Type

func (SharedEnvironmentVariableArray) ToSharedEnvironmentVariableArrayOutput 

func (i SharedEnvironmentVariableArray) ToSharedEnvironmentVariableArrayOutput() SharedEnvironmentVariableArrayOutput

func (SharedEnvironmentVariableArray) ToSharedEnvironmentVariableArrayOutputWithContext 

func (i SharedEnvironmentVariableArray) ToSharedEnvironmentVariableArrayOutputWithContext(ctx context.Context) SharedEnvironmentVariableArrayOutput

type SharedEnvironmentVariableArrayInput 

type SharedEnvironmentVariableArrayInput interface {
	pulumi.Input

	ToSharedEnvironmentVariableArrayOutput() SharedEnvironmentVariableArrayOutput
	ToSharedEnvironmentVariableArrayOutputWithContext(context.Context) SharedEnvironmentVariableArrayOutput
}

SharedEnvironmentVariableArrayInput is an input type that accepts SharedEnvironmentVariableArray and SharedEnvironmentVariableArrayOutput values. You can construct a concrete instance of `SharedEnvironmentVariableArrayInput` via: 

SharedEnvironmentVariableArray{ SharedEnvironmentVariableArgs{...} }

type SharedEnvironmentVariableArrayOutput 

type SharedEnvironmentVariableArrayOutput struct{ *pulumi.OutputState }

func (SharedEnvironmentVariableArrayOutput) ElementType 

func (SharedEnvironmentVariableArrayOutput) ElementType() reflect.Type

func (SharedEnvironmentVariableArrayOutput) Index 

func (o SharedEnvironmentVariableArrayOutput) Index(i pulumi.IntInput) SharedEnvironmentVariableOutput

func (SharedEnvironmentVariableArrayOutput) ToSharedEnvironmentVariableArrayOutput 

func (o SharedEnvironmentVariableArrayOutput) ToSharedEnvironmentVariableArrayOutput() SharedEnvironmentVariableArrayOutput

func (SharedEnvironmentVariableArrayOutput) ToSharedEnvironmentVariableArrayOutputWithContext 

func (o SharedEnvironmentVariableArrayOutput) ToSharedEnvironmentVariableArrayOutputWithContext(ctx context.Context) SharedEnvironmentVariableArrayOutput

type SharedEnvironmentVariableInput 

type SharedEnvironmentVariableInput interface {
	pulumi.Input

	ToSharedEnvironmentVariableOutput() SharedEnvironmentVariableOutput
	ToSharedEnvironmentVariableOutputWithContext(ctx context.Context) SharedEnvironmentVariableOutput
}

type SharedEnvironmentVariableMap 

type SharedEnvironmentVariableMap map[string]SharedEnvironmentVariableInput

func (SharedEnvironmentVariableMap) ElementType 

func (SharedEnvironmentVariableMap) ElementType() reflect.Type

func (SharedEnvironmentVariableMap) ToSharedEnvironmentVariableMapOutput 

func (i SharedEnvironmentVariableMap) ToSharedEnvironmentVariableMapOutput() SharedEnvironmentVariableMapOutput

func (SharedEnvironmentVariableMap) ToSharedEnvironmentVariableMapOutputWithContext 

func (i SharedEnvironmentVariableMap) ToSharedEnvironmentVariableMapOutputWithContext(ctx context.Context) SharedEnvironmentVariableMapOutput

type SharedEnvironmentVariableMapInput 

type SharedEnvironmentVariableMapInput interface {
	pulumi.Input

	ToSharedEnvironmentVariableMapOutput() SharedEnvironmentVariableMapOutput
	ToSharedEnvironmentVariableMapOutputWithContext(context.Context) SharedEnvironmentVariableMapOutput
}

SharedEnvironmentVariableMapInput is an input type that accepts SharedEnvironmentVariableMap and SharedEnvironmentVariableMapOutput values. You can construct a concrete instance of `SharedEnvironmentVariableMapInput` via: 

SharedEnvironmentVariableMap{ "key": SharedEnvironmentVariableArgs{...} }

type SharedEnvironmentVariableMapOutput 

type SharedEnvironmentVariableMapOutput struct{ *pulumi.OutputState }

func (SharedEnvironmentVariableMapOutput) ElementType 

func (SharedEnvironmentVariableMapOutput) ElementType() reflect.Type

func (SharedEnvironmentVariableMapOutput) MapIndex 

func (o SharedEnvironmentVariableMapOutput) MapIndex(k pulumi.StringInput) SharedEnvironmentVariableOutput

func (SharedEnvironmentVariableMapOutput) ToSharedEnvironmentVariableMapOutput 

func (o SharedEnvironmentVariableMapOutput) ToSharedEnvironmentVariableMapOutput() SharedEnvironmentVariableMapOutput

func (SharedEnvironmentVariableMapOutput) ToSharedEnvironmentVariableMapOutputWithContext 

func (o SharedEnvironmentVariableMapOutput) ToSharedEnvironmentVariableMapOutputWithContext(ctx context.Context) SharedEnvironmentVariableMapOutput

type SharedEnvironmentVariableOutput 

type SharedEnvironmentVariableOutput struct{ *pulumi.OutputState }

func (SharedEnvironmentVariableOutput) ElementType 

func (SharedEnvironmentVariableOutput) ElementType() reflect.Type

func (SharedEnvironmentVariableOutput) Key 

func (o SharedEnvironmentVariableOutput) Key() pulumi.StringOutput

The name of the Environment Variable.

func (SharedEnvironmentVariableOutput) ProjectIds 

func (o SharedEnvironmentVariableOutput) ProjectIds() pulumi.StringArrayOutput

The ID of the Vercel project.

func (SharedEnvironmentVariableOutput) Sensitive added in v1.1.0 

func (o SharedEnvironmentVariableOutput) Sensitive() pulumi.BoolOutput

Whether the Environment Variable is sensitive or not.

func (SharedEnvironmentVariableOutput) Targets 

func (o SharedEnvironmentVariableOutput) Targets() pulumi.StringArrayOutput

The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.

func (SharedEnvironmentVariableOutput) TeamId 

func (o SharedEnvironmentVariableOutput) TeamId() pulumi.StringOutput

The ID of the Vercel team. Shared environment variables require a team.

func (SharedEnvironmentVariableOutput) ToSharedEnvironmentVariableOutput 

func (o SharedEnvironmentVariableOutput) ToSharedEnvironmentVariableOutput() SharedEnvironmentVariableOutput

func (SharedEnvironmentVariableOutput) ToSharedEnvironmentVariableOutputWithContext 

func (o SharedEnvironmentVariableOutput) ToSharedEnvironmentVariableOutputWithContext(ctx context.Context) SharedEnvironmentVariableOutput

func (SharedEnvironmentVariableOutput) Value 

func (o SharedEnvironmentVariableOutput) Value() pulumi.StringOutput

The value of the Environment Variable.

type SharedEnvironmentVariableState 

type SharedEnvironmentVariableState struct {
	// The name of the Environment Variable.
	Key pulumi.StringPtrInput
	// The ID of the Vercel project.
	ProjectIds pulumi.StringArrayInput
	// Whether the Environment Variable is sensitive or not.
	Sensitive pulumi.BoolPtrInput
	// The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`.
	Targets pulumi.StringArrayInput
	// The ID of the Vercel team. Shared environment variables require a team.
	TeamId pulumi.StringPtrInput
	// The value of the Environment Variable.
	Value pulumi.StringPtrInput
}

func (SharedEnvironmentVariableState) ElementType 

func (SharedEnvironmentVariableState) ElementType() reflect.Type

Source Files

View all Source files

Directories

Path Synopsis

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.