cloudflare.PagesProject
Explore with Pulumi AI
Provides a resource which manages Cloudflare Pages projects.
If you are using a
source
block configuration, you must first have a connected GitHub or GitLab account connected to Cloudflare. See the [Getting Started with Pages] documentation on how to link your accounts.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
// Direct upload Pages project
const basicProject = new cloudflare.PagesProject("basicProject", {
accountId: "f037e56e89293a057740de681ac9abbe",
name: "this-is-my-project-01",
productionBranch: "main",
});
// Pages project with managing build config
const buildConfig = new cloudflare.PagesProject("buildConfig", {
accountId: "f037e56e89293a057740de681ac9abbe",
buildConfig: {
buildCommand: "npm run build",
destinationDir: "build",
rootDir: "",
webAnalyticsTag: "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
webAnalyticsToken: "021e1057c18547eca7b79f2516f06o7x",
},
name: "this-is-my-project-01",
productionBranch: "main",
});
// Pages project managing project source
const sourceConfig = new cloudflare.PagesProject("sourceConfig", {
accountId: "f037e56e89293a057740de681ac9abbe",
name: "this-is-my-project-01",
productionBranch: "main",
source: {
config: {
deploymentsEnabled: true,
owner: "cloudflare",
prCommentsEnabled: true,
previewBranchExcludes: [
"main",
"prod",
],
previewBranchIncludes: [
"dev",
"preview",
],
previewDeploymentSetting: "custom",
productionBranch: "main",
productionDeploymentEnabled: true,
repoName: "ninjakittens",
},
type: "github",
},
});
// Pages project managing all configs
const deploymentConfigs = new cloudflare.PagesProject("deploymentConfigs", {
accountId: "f037e56e89293a057740de681ac9abbe",
buildConfig: {
buildCommand: "npm run build",
destinationDir: "build",
rootDir: "",
webAnalyticsTag: "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
webAnalyticsToken: "021e1057c18547eca7b79f2516f06o7x",
},
deploymentConfigs: {
preview: {
compatibilityDate: "2022-08-15",
compatibilityFlags: ["nodejs_compat"],
d1Databases: {
D1BINDING: "445e2955-951a-4358-a35b-a4d0c813f63",
},
durableObjectNamespaces: {
DOBINDING: "5eb63bbbe01eeed093cb22bb8f5acdc3",
},
environmentVariables: {
ENVIRONMENT: "preview",
},
kvNamespaces: {
KVBINDING: "5eb63bbbe01eeed093cb22bb8f5acdc3",
},
r2Buckets: {
R2BINDING: "some-bucket",
},
secrets: {
TURNSTILESECRET: "1x0000000000000000000000000000000AA",
},
},
production: {
compatibilityDate: "2022-08-16",
compatibilityFlags: [
"nodejs_compat",
"streams_enable_constructors",
],
d1Databases: {
D1BINDING1: "445e2955-951a-4358-a35b-a4d0c813f63",
D1BINDING2: "a399414b-c697-409a-a688-377db6433cd9",
},
durableObjectNamespaces: {
DOBINDING1: "5eb63bbbe01eeed093cb22bb8f5acdc3",
DOBINDING2: "3cdca5f8bb22bc390deee10ebbb36be5",
},
environmentVariables: {
ENVIRONMENT: "production",
OTHERVALUE: "other value",
},
kvNamespaces: {
KVBINDING1: "5eb63bbbe01eeed093cb22bb8f5acdc3",
KVBINDING2: "3cdca5f8bb22bc390deee10ebbb36be5",
},
r2Buckets: {
R2BINDING1: "some-bucket",
R2BINDING2: "other-bucket",
},
secrets: {
TURNSTILEINVISSECRET: "2x0000000000000000000000000000000AA",
TURNSTILESECRET: "1x0000000000000000000000000000000AA",
},
},
},
name: "this-is-my-project-01",
productionBranch: "main",
source: {
config: {
deploymentsEnabled: true,
owner: "cloudflare",
prCommentsEnabled: true,
previewBranchExcludes: [
"main",
"prod",
],
previewBranchIncludes: [
"dev",
"preview",
],
previewDeploymentSetting: "custom",
productionBranch: "main",
productionDeploymentEnabled: true,
repoName: "ninjakittens",
},
type: "github",
},
});
import pulumi
import pulumi_cloudflare as cloudflare
# Direct upload Pages project
basic_project = cloudflare.PagesProject("basicProject",
account_id="f037e56e89293a057740de681ac9abbe",
name="this-is-my-project-01",
production_branch="main")
# Pages project with managing build config
build_config = cloudflare.PagesProject("buildConfig",
account_id="f037e56e89293a057740de681ac9abbe",
build_config=cloudflare.PagesProjectBuildConfigArgs(
build_command="npm run build",
destination_dir="build",
root_dir="",
web_analytics_tag="cee1c73f6e4743d0b5e6bb1a0bcaabcc",
web_analytics_token="021e1057c18547eca7b79f2516f06o7x",
),
name="this-is-my-project-01",
production_branch="main")
# Pages project managing project source
source_config = cloudflare.PagesProject("sourceConfig",
account_id="f037e56e89293a057740de681ac9abbe",
name="this-is-my-project-01",
production_branch="main",
source=cloudflare.PagesProjectSourceArgs(
config=cloudflare.PagesProjectSourceConfigArgs(
deployments_enabled=True,
owner="cloudflare",
pr_comments_enabled=True,
preview_branch_excludes=[
"main",
"prod",
],
preview_branch_includes=[
"dev",
"preview",
],
preview_deployment_setting="custom",
production_branch="main",
production_deployment_enabled=True,
repo_name="ninjakittens",
),
type="github",
))
# Pages project managing all configs
deployment_configs = cloudflare.PagesProject("deploymentConfigs",
account_id="f037e56e89293a057740de681ac9abbe",
build_config=cloudflare.PagesProjectBuildConfigArgs(
build_command="npm run build",
destination_dir="build",
root_dir="",
web_analytics_tag="cee1c73f6e4743d0b5e6bb1a0bcaabcc",
web_analytics_token="021e1057c18547eca7b79f2516f06o7x",
),
deployment_configs=cloudflare.PagesProjectDeploymentConfigsArgs(
preview=cloudflare.PagesProjectDeploymentConfigsPreviewArgs(
compatibility_date="2022-08-15",
compatibility_flags=["nodejs_compat"],
d1_databases={
"D1BINDING": "445e2955-951a-4358-a35b-a4d0c813f63",
},
durable_object_namespaces={
"DOBINDING": "5eb63bbbe01eeed093cb22bb8f5acdc3",
},
environment_variables={
"ENVIRONMENT": "preview",
},
kv_namespaces={
"KVBINDING": "5eb63bbbe01eeed093cb22bb8f5acdc3",
},
r2_buckets={
"R2BINDING": "some-bucket",
},
secrets={
"TURNSTILESECRET": "1x0000000000000000000000000000000AA",
},
),
production=cloudflare.PagesProjectDeploymentConfigsProductionArgs(
compatibility_date="2022-08-16",
compatibility_flags=[
"nodejs_compat",
"streams_enable_constructors",
],
d1_databases={
"D1BINDING1": "445e2955-951a-4358-a35b-a4d0c813f63",
"D1BINDING2": "a399414b-c697-409a-a688-377db6433cd9",
},
durable_object_namespaces={
"DOBINDING1": "5eb63bbbe01eeed093cb22bb8f5acdc3",
"DOBINDING2": "3cdca5f8bb22bc390deee10ebbb36be5",
},
environment_variables={
"ENVIRONMENT": "production",
"OTHERVALUE": "other value",
},
kv_namespaces={
"KVBINDING1": "5eb63bbbe01eeed093cb22bb8f5acdc3",
"KVBINDING2": "3cdca5f8bb22bc390deee10ebbb36be5",
},
r2_buckets={
"R2BINDING1": "some-bucket",
"R2BINDING2": "other-bucket",
},
secrets={
"TURNSTILEINVISSECRET": "2x0000000000000000000000000000000AA",
"TURNSTILESECRET": "1x0000000000000000000000000000000AA",
},
),
),
name="this-is-my-project-01",
production_branch="main",
source=cloudflare.PagesProjectSourceArgs(
config=cloudflare.PagesProjectSourceConfigArgs(
deployments_enabled=True,
owner="cloudflare",
pr_comments_enabled=True,
preview_branch_excludes=[
"main",
"prod",
],
preview_branch_includes=[
"dev",
"preview",
],
preview_deployment_setting="custom",
production_branch="main",
production_deployment_enabled=True,
repo_name="ninjakittens",
),
type="github",
))
package main
import (
"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Direct upload Pages project
_, err := cloudflare.NewPagesProject(ctx, "basicProject", &cloudflare.PagesProjectArgs{
AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
Name: pulumi.String("this-is-my-project-01"),
ProductionBranch: pulumi.String("main"),
})
if err != nil {
return err
}
// Pages project with managing build config
_, err = cloudflare.NewPagesProject(ctx, "buildConfig", &cloudflare.PagesProjectArgs{
AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
BuildConfig: &cloudflare.PagesProjectBuildConfigArgs{
BuildCommand: pulumi.String("npm run build"),
DestinationDir: pulumi.String("build"),
RootDir: pulumi.String(""),
WebAnalyticsTag: pulumi.String("cee1c73f6e4743d0b5e6bb1a0bcaabcc"),
WebAnalyticsToken: pulumi.String("021e1057c18547eca7b79f2516f06o7x"),
},
Name: pulumi.String("this-is-my-project-01"),
ProductionBranch: pulumi.String("main"),
})
if err != nil {
return err
}
// Pages project managing project source
_, err = cloudflare.NewPagesProject(ctx, "sourceConfig", &cloudflare.PagesProjectArgs{
AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
Name: pulumi.String("this-is-my-project-01"),
ProductionBranch: pulumi.String("main"),
Source: &cloudflare.PagesProjectSourceArgs{
Config: &cloudflare.PagesProjectSourceConfigArgs{
DeploymentsEnabled: pulumi.Bool(true),
Owner: pulumi.String("cloudflare"),
PrCommentsEnabled: pulumi.Bool(true),
PreviewBranchExcludes: pulumi.StringArray{
pulumi.String("main"),
pulumi.String("prod"),
},
PreviewBranchIncludes: pulumi.StringArray{
pulumi.String("dev"),
pulumi.String("preview"),
},
PreviewDeploymentSetting: pulumi.String("custom"),
ProductionBranch: pulumi.String("main"),
ProductionDeploymentEnabled: pulumi.Bool(true),
RepoName: pulumi.String("ninjakittens"),
},
Type: pulumi.String("github"),
},
})
if err != nil {
return err
}
// Pages project managing all configs
_, err = cloudflare.NewPagesProject(ctx, "deploymentConfigs", &cloudflare.PagesProjectArgs{
AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
BuildConfig: &cloudflare.PagesProjectBuildConfigArgs{
BuildCommand: pulumi.String("npm run build"),
DestinationDir: pulumi.String("build"),
RootDir: pulumi.String(""),
WebAnalyticsTag: pulumi.String("cee1c73f6e4743d0b5e6bb1a0bcaabcc"),
WebAnalyticsToken: pulumi.String("021e1057c18547eca7b79f2516f06o7x"),
},
DeploymentConfigs: &cloudflare.PagesProjectDeploymentConfigsArgs{
Preview: &cloudflare.PagesProjectDeploymentConfigsPreviewArgs{
CompatibilityDate: pulumi.String("2022-08-15"),
CompatibilityFlags: pulumi.StringArray{
pulumi.String("nodejs_compat"),
},
D1Databases: pulumi.Map{
"D1BINDING": pulumi.Any("445e2955-951a-4358-a35b-a4d0c813f63"),
},
DurableObjectNamespaces: pulumi.Map{
"DOBINDING": pulumi.Any("5eb63bbbe01eeed093cb22bb8f5acdc3"),
},
EnvironmentVariables: pulumi.Map{
"ENVIRONMENT": pulumi.Any("preview"),
},
KvNamespaces: pulumi.Map{
"KVBINDING": pulumi.Any("5eb63bbbe01eeed093cb22bb8f5acdc3"),
},
R2Buckets: pulumi.Map{
"R2BINDING": pulumi.Any("some-bucket"),
},
Secrets: pulumi.Map{
"TURNSTILESECRET": pulumi.Any("1x0000000000000000000000000000000AA"),
},
},
Production: &cloudflare.PagesProjectDeploymentConfigsProductionArgs{
CompatibilityDate: pulumi.String("2022-08-16"),
CompatibilityFlags: pulumi.StringArray{
pulumi.String("nodejs_compat"),
pulumi.String("streams_enable_constructors"),
},
D1Databases: pulumi.Map{
"D1BINDING1": pulumi.Any("445e2955-951a-4358-a35b-a4d0c813f63"),
"D1BINDING2": pulumi.Any("a399414b-c697-409a-a688-377db6433cd9"),
},
DurableObjectNamespaces: pulumi.Map{
"DOBINDING1": pulumi.Any("5eb63bbbe01eeed093cb22bb8f5acdc3"),
"DOBINDING2": pulumi.Any("3cdca5f8bb22bc390deee10ebbb36be5"),
},
EnvironmentVariables: pulumi.Map{
"ENVIRONMENT": pulumi.Any("production"),
"OTHERVALUE": pulumi.Any("other value"),
},
KvNamespaces: pulumi.Map{
"KVBINDING1": pulumi.Any("5eb63bbbe01eeed093cb22bb8f5acdc3"),
"KVBINDING2": pulumi.Any("3cdca5f8bb22bc390deee10ebbb36be5"),
},
R2Buckets: pulumi.Map{
"R2BINDING1": pulumi.Any("some-bucket"),
"R2BINDING2": pulumi.Any("other-bucket"),
},
Secrets: pulumi.Map{
"TURNSTILEINVISSECRET": pulumi.Any("2x0000000000000000000000000000000AA"),
"TURNSTILESECRET": pulumi.Any("1x0000000000000000000000000000000AA"),
},
},
},
Name: pulumi.String("this-is-my-project-01"),
ProductionBranch: pulumi.String("main"),
Source: &cloudflare.PagesProjectSourceArgs{
Config: &cloudflare.PagesProjectSourceConfigArgs{
DeploymentsEnabled: pulumi.Bool(true),
Owner: pulumi.String("cloudflare"),
PrCommentsEnabled: pulumi.Bool(true),
PreviewBranchExcludes: pulumi.StringArray{
pulumi.String("main"),
pulumi.String("prod"),
},
PreviewBranchIncludes: pulumi.StringArray{
pulumi.String("dev"),
pulumi.String("preview"),
},
PreviewDeploymentSetting: pulumi.String("custom"),
ProductionBranch: pulumi.String("main"),
ProductionDeploymentEnabled: pulumi.Bool(true),
RepoName: pulumi.String("ninjakittens"),
},
Type: pulumi.String("github"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
// Direct upload Pages project
var basicProject = new Cloudflare.PagesProject("basicProject", new()
{
AccountId = "f037e56e89293a057740de681ac9abbe",
Name = "this-is-my-project-01",
ProductionBranch = "main",
});
// Pages project with managing build config
var buildConfig = new Cloudflare.PagesProject("buildConfig", new()
{
AccountId = "f037e56e89293a057740de681ac9abbe",
BuildConfig = new Cloudflare.Inputs.PagesProjectBuildConfigArgs
{
BuildCommand = "npm run build",
DestinationDir = "build",
RootDir = "",
WebAnalyticsTag = "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
WebAnalyticsToken = "021e1057c18547eca7b79f2516f06o7x",
},
Name = "this-is-my-project-01",
ProductionBranch = "main",
});
// Pages project managing project source
var sourceConfig = new Cloudflare.PagesProject("sourceConfig", new()
{
AccountId = "f037e56e89293a057740de681ac9abbe",
Name = "this-is-my-project-01",
ProductionBranch = "main",
Source = new Cloudflare.Inputs.PagesProjectSourceArgs
{
Config = new Cloudflare.Inputs.PagesProjectSourceConfigArgs
{
DeploymentsEnabled = true,
Owner = "cloudflare",
PrCommentsEnabled = true,
PreviewBranchExcludes = new[]
{
"main",
"prod",
},
PreviewBranchIncludes = new[]
{
"dev",
"preview",
},
PreviewDeploymentSetting = "custom",
ProductionBranch = "main",
ProductionDeploymentEnabled = true,
RepoName = "ninjakittens",
},
Type = "github",
},
});
// Pages project managing all configs
var deploymentConfigs = new Cloudflare.PagesProject("deploymentConfigs", new()
{
AccountId = "f037e56e89293a057740de681ac9abbe",
BuildConfig = new Cloudflare.Inputs.PagesProjectBuildConfigArgs
{
BuildCommand = "npm run build",
DestinationDir = "build",
RootDir = "",
WebAnalyticsTag = "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
WebAnalyticsToken = "021e1057c18547eca7b79f2516f06o7x",
},
DeploymentConfigs = new Cloudflare.Inputs.PagesProjectDeploymentConfigsArgs
{
Preview = new Cloudflare.Inputs.PagesProjectDeploymentConfigsPreviewArgs
{
CompatibilityDate = "2022-08-15",
CompatibilityFlags = new[]
{
"nodejs_compat",
},
D1Databases =
{
{ "D1BINDING", "445e2955-951a-4358-a35b-a4d0c813f63" },
},
DurableObjectNamespaces =
{
{ "DOBINDING", "5eb63bbbe01eeed093cb22bb8f5acdc3" },
},
EnvironmentVariables =
{
{ "ENVIRONMENT", "preview" },
},
KvNamespaces =
{
{ "KVBINDING", "5eb63bbbe01eeed093cb22bb8f5acdc3" },
},
R2Buckets =
{
{ "R2BINDING", "some-bucket" },
},
Secrets =
{
{ "TURNSTILESECRET", "1x0000000000000000000000000000000AA" },
},
},
Production = new Cloudflare.Inputs.PagesProjectDeploymentConfigsProductionArgs
{
CompatibilityDate = "2022-08-16",
CompatibilityFlags = new[]
{
"nodejs_compat",
"streams_enable_constructors",
},
D1Databases =
{
{ "D1BINDING1", "445e2955-951a-4358-a35b-a4d0c813f63" },
{ "D1BINDING2", "a399414b-c697-409a-a688-377db6433cd9" },
},
DurableObjectNamespaces =
{
{ "DOBINDING1", "5eb63bbbe01eeed093cb22bb8f5acdc3" },
{ "DOBINDING2", "3cdca5f8bb22bc390deee10ebbb36be5" },
},
EnvironmentVariables =
{
{ "ENVIRONMENT", "production" },
{ "OTHERVALUE", "other value" },
},
KvNamespaces =
{
{ "KVBINDING1", "5eb63bbbe01eeed093cb22bb8f5acdc3" },
{ "KVBINDING2", "3cdca5f8bb22bc390deee10ebbb36be5" },
},
R2Buckets =
{
{ "R2BINDING1", "some-bucket" },
{ "R2BINDING2", "other-bucket" },
},
Secrets =
{
{ "TURNSTILEINVISSECRET", "2x0000000000000000000000000000000AA" },
{ "TURNSTILESECRET", "1x0000000000000000000000000000000AA" },
},
},
},
Name = "this-is-my-project-01",
ProductionBranch = "main",
Source = new Cloudflare.Inputs.PagesProjectSourceArgs
{
Config = new Cloudflare.Inputs.PagesProjectSourceConfigArgs
{
DeploymentsEnabled = true,
Owner = "cloudflare",
PrCommentsEnabled = true,
PreviewBranchExcludes = new[]
{
"main",
"prod",
},
PreviewBranchIncludes = new[]
{
"dev",
"preview",
},
PreviewDeploymentSetting = "custom",
ProductionBranch = "main",
ProductionDeploymentEnabled = true,
RepoName = "ninjakittens",
},
Type = "github",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.PagesProject;
import com.pulumi.cloudflare.PagesProjectArgs;
import com.pulumi.cloudflare.inputs.PagesProjectBuildConfigArgs;
import com.pulumi.cloudflare.inputs.PagesProjectSourceArgs;
import com.pulumi.cloudflare.inputs.PagesProjectSourceConfigArgs;
import com.pulumi.cloudflare.inputs.PagesProjectDeploymentConfigsArgs;
import com.pulumi.cloudflare.inputs.PagesProjectDeploymentConfigsPreviewArgs;
import com.pulumi.cloudflare.inputs.PagesProjectDeploymentConfigsProductionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Direct upload Pages project
var basicProject = new PagesProject("basicProject", PagesProjectArgs.builder()
.accountId("f037e56e89293a057740de681ac9abbe")
.name("this-is-my-project-01")
.productionBranch("main")
.build());
// Pages project with managing build config
var buildConfig = new PagesProject("buildConfig", PagesProjectArgs.builder()
.accountId("f037e56e89293a057740de681ac9abbe")
.buildConfig(PagesProjectBuildConfigArgs.builder()
.buildCommand("npm run build")
.destinationDir("build")
.rootDir("")
.webAnalyticsTag("cee1c73f6e4743d0b5e6bb1a0bcaabcc")
.webAnalyticsToken("021e1057c18547eca7b79f2516f06o7x")
.build())
.name("this-is-my-project-01")
.productionBranch("main")
.build());
// Pages project managing project source
var sourceConfig = new PagesProject("sourceConfig", PagesProjectArgs.builder()
.accountId("f037e56e89293a057740de681ac9abbe")
.name("this-is-my-project-01")
.productionBranch("main")
.source(PagesProjectSourceArgs.builder()
.config(PagesProjectSourceConfigArgs.builder()
.deploymentsEnabled(true)
.owner("cloudflare")
.prCommentsEnabled(true)
.previewBranchExcludes(
"main",
"prod")
.previewBranchIncludes(
"dev",
"preview")
.previewDeploymentSetting("custom")
.productionBranch("main")
.productionDeploymentEnabled(true)
.repoName("ninjakittens")
.build())
.type("github")
.build())
.build());
// Pages project managing all configs
var deploymentConfigs = new PagesProject("deploymentConfigs", PagesProjectArgs.builder()
.accountId("f037e56e89293a057740de681ac9abbe")
.buildConfig(PagesProjectBuildConfigArgs.builder()
.buildCommand("npm run build")
.destinationDir("build")
.rootDir("")
.webAnalyticsTag("cee1c73f6e4743d0b5e6bb1a0bcaabcc")
.webAnalyticsToken("021e1057c18547eca7b79f2516f06o7x")
.build())
.deploymentConfigs(PagesProjectDeploymentConfigsArgs.builder()
.preview(PagesProjectDeploymentConfigsPreviewArgs.builder()
.compatibilityDate("2022-08-15")
.compatibilityFlags("nodejs_compat")
.d1Databases(Map.of("D1BINDING", "445e2955-951a-4358-a35b-a4d0c813f63"))
.durableObjectNamespaces(Map.of("DOBINDING", "5eb63bbbe01eeed093cb22bb8f5acdc3"))
.environmentVariables(Map.of("ENVIRONMENT", "preview"))
.kvNamespaces(Map.of("KVBINDING", "5eb63bbbe01eeed093cb22bb8f5acdc3"))
.r2Buckets(Map.of("R2BINDING", "some-bucket"))
.secrets(Map.of("TURNSTILESECRET", "1x0000000000000000000000000000000AA"))
.build())
.production(PagesProjectDeploymentConfigsProductionArgs.builder()
.compatibilityDate("2022-08-16")
.compatibilityFlags(
"nodejs_compat",
"streams_enable_constructors")
.d1Databases(Map.ofEntries(
Map.entry("D1BINDING1", "445e2955-951a-4358-a35b-a4d0c813f63"),
Map.entry("D1BINDING2", "a399414b-c697-409a-a688-377db6433cd9")
))
.durableObjectNamespaces(Map.ofEntries(
Map.entry("DOBINDING1", "5eb63bbbe01eeed093cb22bb8f5acdc3"),
Map.entry("DOBINDING2", "3cdca5f8bb22bc390deee10ebbb36be5")
))
.environmentVariables(Map.ofEntries(
Map.entry("ENVIRONMENT", "production"),
Map.entry("OTHERVALUE", "other value")
))
.kvNamespaces(Map.ofEntries(
Map.entry("KVBINDING1", "5eb63bbbe01eeed093cb22bb8f5acdc3"),
Map.entry("KVBINDING2", "3cdca5f8bb22bc390deee10ebbb36be5")
))
.r2Buckets(Map.ofEntries(
Map.entry("R2BINDING1", "some-bucket"),
Map.entry("R2BINDING2", "other-bucket")
))
.secrets(Map.ofEntries(
Map.entry("TURNSTILEINVISSECRET", "2x0000000000000000000000000000000AA"),
Map.entry("TURNSTILESECRET", "1x0000000000000000000000000000000AA")
))
.build())
.build())
.name("this-is-my-project-01")
.productionBranch("main")
.source(PagesProjectSourceArgs.builder()
.config(PagesProjectSourceConfigArgs.builder()
.deploymentsEnabled(true)
.owner("cloudflare")
.prCommentsEnabled(true)
.previewBranchExcludes(
"main",
"prod")
.previewBranchIncludes(
"dev",
"preview")
.previewDeploymentSetting("custom")
.productionBranch("main")
.productionDeploymentEnabled(true)
.repoName("ninjakittens")
.build())
.type("github")
.build())
.build());
}
}
resources:
# Direct upload Pages project
basicProject:
type: cloudflare:PagesProject
properties:
accountId: f037e56e89293a057740de681ac9abbe
name: this-is-my-project-01
productionBranch: main
# Pages project with managing build config
buildConfig:
type: cloudflare:PagesProject
properties:
accountId: f037e56e89293a057740de681ac9abbe
buildConfig:
buildCommand: npm run build
destinationDir: build
rootDir:
webAnalyticsTag: cee1c73f6e4743d0b5e6bb1a0bcaabcc
webAnalyticsToken: 021e1057c18547eca7b79f2516f06o7x
name: this-is-my-project-01
productionBranch: main
# Pages project managing project source
sourceConfig:
type: cloudflare:PagesProject
properties:
accountId: f037e56e89293a057740de681ac9abbe
name: this-is-my-project-01
productionBranch: main
source:
config:
deploymentsEnabled: true
owner: cloudflare
prCommentsEnabled: true
previewBranchExcludes:
- main
- prod
previewBranchIncludes:
- dev
- preview
previewDeploymentSetting: custom
productionBranch: main
productionDeploymentEnabled: true
repoName: ninjakittens
type: github
# Pages project managing all configs
deploymentConfigs:
type: cloudflare:PagesProject
properties:
accountId: f037e56e89293a057740de681ac9abbe
buildConfig:
buildCommand: npm run build
destinationDir: build
rootDir:
webAnalyticsTag: cee1c73f6e4743d0b5e6bb1a0bcaabcc
webAnalyticsToken: 021e1057c18547eca7b79f2516f06o7x
deploymentConfigs:
preview:
compatibilityDate: 2022-08-15
compatibilityFlags:
- nodejs_compat
d1Databases:
D1BINDING: 445e2955-951a-4358-a35b-a4d0c813f63
durableObjectNamespaces:
DOBINDING: 5eb63bbbe01eeed093cb22bb8f5acdc3
environmentVariables:
ENVIRONMENT: preview
kvNamespaces:
KVBINDING: 5eb63bbbe01eeed093cb22bb8f5acdc3
r2Buckets:
R2BINDING: some-bucket
secrets:
TURNSTILESECRET: 1x0000000000000000000000000000000AA
production:
compatibilityDate: 2022-08-16
compatibilityFlags:
- nodejs_compat
- streams_enable_constructors
d1Databases:
D1BINDING1: 445e2955-951a-4358-a35b-a4d0c813f63
D1BINDING2: a399414b-c697-409a-a688-377db6433cd9
durableObjectNamespaces:
DOBINDING1: 5eb63bbbe01eeed093cb22bb8f5acdc3
DOBINDING2: 3cdca5f8bb22bc390deee10ebbb36be5
environmentVariables:
ENVIRONMENT: production
OTHERVALUE: other value
kvNamespaces:
KVBINDING1: 5eb63bbbe01eeed093cb22bb8f5acdc3
KVBINDING2: 3cdca5f8bb22bc390deee10ebbb36be5
r2Buckets:
R2BINDING1: some-bucket
R2BINDING2: other-bucket
secrets:
TURNSTILEINVISSECRET: 2x0000000000000000000000000000000AA
TURNSTILESECRET: 1x0000000000000000000000000000000AA
name: this-is-my-project-01
productionBranch: main
source:
config:
deploymentsEnabled: true
owner: cloudflare
prCommentsEnabled: true
previewBranchExcludes:
- main
- prod
previewBranchIncludes:
- dev
- preview
previewDeploymentSetting: custom
productionBranch: main
productionDeploymentEnabled: true
repoName: ninjakittens
type: github
Create PagesProject Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PagesProject(name: string, args: PagesProjectArgs, opts?: CustomResourceOptions);
@overload
def PagesProject(resource_name: str,
args: PagesProjectArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PagesProject(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
name: Optional[str] = None,
production_branch: Optional[str] = None,
build_config: Optional[PagesProjectBuildConfigArgs] = None,
deployment_configs: Optional[PagesProjectDeploymentConfigsArgs] = None,
source: Optional[PagesProjectSourceArgs] = None)
func NewPagesProject(ctx *Context, name string, args PagesProjectArgs, opts ...ResourceOption) (*PagesProject, error)
public PagesProject(string name, PagesProjectArgs args, CustomResourceOptions? opts = null)
public PagesProject(String name, PagesProjectArgs args)
public PagesProject(String name, PagesProjectArgs args, CustomResourceOptions options)
type: cloudflare:PagesProject
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PagesProjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PagesProjectArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PagesProjectArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PagesProjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PagesProjectArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var pagesProjectResource = new Cloudflare.PagesProject("pagesProjectResource", new()
{
AccountId = "string",
Name = "string",
ProductionBranch = "string",
BuildConfig = new Cloudflare.Inputs.PagesProjectBuildConfigArgs
{
BuildCaching = false,
BuildCommand = "string",
DestinationDir = "string",
RootDir = "string",
WebAnalyticsTag = "string",
WebAnalyticsToken = "string",
},
DeploymentConfigs = new Cloudflare.Inputs.PagesProjectDeploymentConfigsArgs
{
Preview = new Cloudflare.Inputs.PagesProjectDeploymentConfigsPreviewArgs
{
AlwaysUseLatestCompatibilityDate = false,
CompatibilityDate = "string",
CompatibilityFlags = new[]
{
"string",
},
D1Databases =
{
{ "string", "any" },
},
DurableObjectNamespaces =
{
{ "string", "any" },
},
EnvironmentVariables =
{
{ "string", "any" },
},
FailOpen = false,
KvNamespaces =
{
{ "string", "any" },
},
Placement = new Cloudflare.Inputs.PagesProjectDeploymentConfigsPreviewPlacementArgs
{
Mode = "string",
},
R2Buckets =
{
{ "string", "any" },
},
Secrets =
{
{ "string", "any" },
},
ServiceBindings = new[]
{
new Cloudflare.Inputs.PagesProjectDeploymentConfigsPreviewServiceBindingArgs
{
Name = "string",
Service = "string",
Environment = "string",
},
},
UsageModel = "string",
},
Production = new Cloudflare.Inputs.PagesProjectDeploymentConfigsProductionArgs
{
AlwaysUseLatestCompatibilityDate = false,
CompatibilityDate = "string",
CompatibilityFlags = new[]
{
"string",
},
D1Databases =
{
{ "string", "any" },
},
DurableObjectNamespaces =
{
{ "string", "any" },
},
EnvironmentVariables =
{
{ "string", "any" },
},
FailOpen = false,
KvNamespaces =
{
{ "string", "any" },
},
Placement = new Cloudflare.Inputs.PagesProjectDeploymentConfigsProductionPlacementArgs
{
Mode = "string",
},
R2Buckets =
{
{ "string", "any" },
},
Secrets =
{
{ "string", "any" },
},
ServiceBindings = new[]
{
new Cloudflare.Inputs.PagesProjectDeploymentConfigsProductionServiceBindingArgs
{
Name = "string",
Service = "string",
Environment = "string",
},
},
UsageModel = "string",
},
},
Source = new Cloudflare.Inputs.PagesProjectSourceArgs
{
Config = new Cloudflare.Inputs.PagesProjectSourceConfigArgs
{
ProductionBranch = "string",
DeploymentsEnabled = false,
Owner = "string",
PrCommentsEnabled = false,
PreviewBranchExcludes = new[]
{
"string",
},
PreviewBranchIncludes = new[]
{
"string",
},
PreviewDeploymentSetting = "string",
ProductionDeploymentEnabled = false,
RepoName = "string",
},
Type = "string",
},
});
example, err := cloudflare.NewPagesProject(ctx, "pagesProjectResource", &cloudflare.PagesProjectArgs{
AccountId: pulumi.String("string"),
Name: pulumi.String("string"),
ProductionBranch: pulumi.String("string"),
BuildConfig: &cloudflare.PagesProjectBuildConfigArgs{
BuildCaching: pulumi.Bool(false),
BuildCommand: pulumi.String("string"),
DestinationDir: pulumi.String("string"),
RootDir: pulumi.String("string"),
WebAnalyticsTag: pulumi.String("string"),
WebAnalyticsToken: pulumi.String("string"),
},
DeploymentConfigs: &cloudflare.PagesProjectDeploymentConfigsArgs{
Preview: &cloudflare.PagesProjectDeploymentConfigsPreviewArgs{
AlwaysUseLatestCompatibilityDate: pulumi.Bool(false),
CompatibilityDate: pulumi.String("string"),
CompatibilityFlags: pulumi.StringArray{
pulumi.String("string"),
},
D1Databases: pulumi.Map{
"string": pulumi.Any("any"),
},
DurableObjectNamespaces: pulumi.Map{
"string": pulumi.Any("any"),
},
EnvironmentVariables: pulumi.Map{
"string": pulumi.Any("any"),
},
FailOpen: pulumi.Bool(false),
KvNamespaces: pulumi.Map{
"string": pulumi.Any("any"),
},
Placement: &cloudflare.PagesProjectDeploymentConfigsPreviewPlacementArgs{
Mode: pulumi.String("string"),
},
R2Buckets: pulumi.Map{
"string": pulumi.Any("any"),
},
Secrets: pulumi.Map{
"string": pulumi.Any("any"),
},
ServiceBindings: cloudflare.PagesProjectDeploymentConfigsPreviewServiceBindingArray{
&cloudflare.PagesProjectDeploymentConfigsPreviewServiceBindingArgs{
Name: pulumi.String("string"),
Service: pulumi.String("string"),
Environment: pulumi.String("string"),
},
},
UsageModel: pulumi.String("string"),
},
Production: &cloudflare.PagesProjectDeploymentConfigsProductionArgs{
AlwaysUseLatestCompatibilityDate: pulumi.Bool(false),
CompatibilityDate: pulumi.String("string"),
CompatibilityFlags: pulumi.StringArray{
pulumi.String("string"),
},
D1Databases: pulumi.Map{
"string": pulumi.Any("any"),
},
DurableObjectNamespaces: pulumi.Map{
"string": pulumi.Any("any"),
},
EnvironmentVariables: pulumi.Map{
"string": pulumi.Any("any"),
},
FailOpen: pulumi.Bool(false),
KvNamespaces: pulumi.Map{
"string": pulumi.Any("any"),
},
Placement: &cloudflare.PagesProjectDeploymentConfigsProductionPlacementArgs{
Mode: pulumi.String("string"),
},
R2Buckets: pulumi.Map{
"string": pulumi.Any("any"),
},
Secrets: pulumi.Map{
"string": pulumi.Any("any"),
},
ServiceBindings: cloudflare.PagesProjectDeploymentConfigsProductionServiceBindingArray{
&cloudflare.PagesProjectDeploymentConfigsProductionServiceBindingArgs{
Name: pulumi.String("string"),
Service: pulumi.String("string"),
Environment: pulumi.String("string"),
},
},
UsageModel: pulumi.String("string"),
},
},
Source: &cloudflare.PagesProjectSourceArgs{
Config: &cloudflare.PagesProjectSourceConfigArgs{
ProductionBranch: pulumi.String("string"),
DeploymentsEnabled: pulumi.Bool(false),
Owner: pulumi.String("string"),
PrCommentsEnabled: pulumi.Bool(false),
PreviewBranchExcludes: pulumi.StringArray{
pulumi.String("string"),
},
PreviewBranchIncludes: pulumi.StringArray{
pulumi.String("string"),
},
PreviewDeploymentSetting: pulumi.String("string"),
ProductionDeploymentEnabled: pulumi.Bool(false),
RepoName: pulumi.String("string"),
},
Type: pulumi.String("string"),
},
})
var pagesProjectResource = new PagesProject("pagesProjectResource", PagesProjectArgs.builder()
.accountId("string")
.name("string")
.productionBranch("string")
.buildConfig(PagesProjectBuildConfigArgs.builder()
.buildCaching(false)
.buildCommand("string")
.destinationDir("string")
.rootDir("string")
.webAnalyticsTag("string")
.webAnalyticsToken("string")
.build())
.deploymentConfigs(PagesProjectDeploymentConfigsArgs.builder()
.preview(PagesProjectDeploymentConfigsPreviewArgs.builder()
.alwaysUseLatestCompatibilityDate(false)
.compatibilityDate("string")
.compatibilityFlags("string")
.d1Databases(Map.of("string", "any"))
.durableObjectNamespaces(Map.of("string", "any"))
.environmentVariables(Map.of("string", "any"))
.failOpen(false)
.kvNamespaces(Map.of("string", "any"))
.placement(PagesProjectDeploymentConfigsPreviewPlacementArgs.builder()
.mode("string")
.build())
.r2Buckets(Map.of("string", "any"))
.secrets(Map.of("string", "any"))
.serviceBindings(PagesProjectDeploymentConfigsPreviewServiceBindingArgs.builder()
.name("string")
.service("string")
.environment("string")
.build())
.usageModel("string")
.build())
.production(PagesProjectDeploymentConfigsProductionArgs.builder()
.alwaysUseLatestCompatibilityDate(false)
.compatibilityDate("string")
.compatibilityFlags("string")
.d1Databases(Map.of("string", "any"))
.durableObjectNamespaces(Map.of("string", "any"))
.environmentVariables(Map.of("string", "any"))
.failOpen(false)
.kvNamespaces(Map.of("string", "any"))
.placement(PagesProjectDeploymentConfigsProductionPlacementArgs.builder()
.mode("string")
.build())
.r2Buckets(Map.of("string", "any"))
.secrets(Map.of("string", "any"))
.serviceBindings(PagesProjectDeploymentConfigsProductionServiceBindingArgs.builder()
.name("string")
.service("string")
.environment("string")
.build())
.usageModel("string")
.build())
.build())
.source(PagesProjectSourceArgs.builder()
.config(PagesProjectSourceConfigArgs.builder()
.productionBranch("string")
.deploymentsEnabled(false)
.owner("string")
.prCommentsEnabled(false)
.previewBranchExcludes("string")
.previewBranchIncludes("string")
.previewDeploymentSetting("string")
.productionDeploymentEnabled(false)
.repoName("string")
.build())
.type("string")
.build())
.build());
pages_project_resource = cloudflare.PagesProject("pagesProjectResource",
account_id="string",
name="string",
production_branch="string",
build_config=cloudflare.PagesProjectBuildConfigArgs(
build_caching=False,
build_command="string",
destination_dir="string",
root_dir="string",
web_analytics_tag="string",
web_analytics_token="string",
),
deployment_configs=cloudflare.PagesProjectDeploymentConfigsArgs(
preview=cloudflare.PagesProjectDeploymentConfigsPreviewArgs(
always_use_latest_compatibility_date=False,
compatibility_date="string",
compatibility_flags=["string"],
d1_databases={
"string": "any",
},
durable_object_namespaces={
"string": "any",
},
environment_variables={
"string": "any",
},
fail_open=False,
kv_namespaces={
"string": "any",
},
placement=cloudflare.PagesProjectDeploymentConfigsPreviewPlacementArgs(
mode="string",
),
r2_buckets={
"string": "any",
},
secrets={
"string": "any",
},
service_bindings=[cloudflare.PagesProjectDeploymentConfigsPreviewServiceBindingArgs(
name="string",
service="string",
environment="string",
)],
usage_model="string",
),
production=cloudflare.PagesProjectDeploymentConfigsProductionArgs(
always_use_latest_compatibility_date=False,
compatibility_date="string",
compatibility_flags=["string"],
d1_databases={
"string": "any",
},
durable_object_namespaces={
"string": "any",
},
environment_variables={
"string": "any",
},
fail_open=False,
kv_namespaces={
"string": "any",
},
placement=cloudflare.PagesProjectDeploymentConfigsProductionPlacementArgs(
mode="string",
),
r2_buckets={
"string": "any",
},
secrets={
"string": "any",
},
service_bindings=[cloudflare.PagesProjectDeploymentConfigsProductionServiceBindingArgs(
name="string",
service="string",
environment="string",
)],
usage_model="string",
),
),
source=cloudflare.PagesProjectSourceArgs(
config=cloudflare.PagesProjectSourceConfigArgs(
production_branch="string",
deployments_enabled=False,
owner="string",
pr_comments_enabled=False,
preview_branch_excludes=["string"],
preview_branch_includes=["string"],
preview_deployment_setting="string",
production_deployment_enabled=False,
repo_name="string",
),
type="string",
))
const pagesProjectResource = new cloudflare.PagesProject("pagesProjectResource", {
accountId: "string",
name: "string",
productionBranch: "string",
buildConfig: {
buildCaching: false,
buildCommand: "string",
destinationDir: "string",
rootDir: "string",
webAnalyticsTag: "string",
webAnalyticsToken: "string",
},
deploymentConfigs: {
preview: {
alwaysUseLatestCompatibilityDate: false,
compatibilityDate: "string",
compatibilityFlags: ["string"],
d1Databases: {
string: "any",
},
durableObjectNamespaces: {
string: "any",
},
environmentVariables: {
string: "any",
},
failOpen: false,
kvNamespaces: {
string: "any",
},
placement: {
mode: "string",
},
r2Buckets: {
string: "any",
},
secrets: {
string: "any",
},
serviceBindings: [{
name: "string",
service: "string",
environment: "string",
}],
usageModel: "string",
},
production: {
alwaysUseLatestCompatibilityDate: false,
compatibilityDate: "string",
compatibilityFlags: ["string"],
d1Databases: {
string: "any",
},
durableObjectNamespaces: {
string: "any",
},
environmentVariables: {
string: "any",
},
failOpen: false,
kvNamespaces: {
string: "any",
},
placement: {
mode: "string",
},
r2Buckets: {
string: "any",
},
secrets: {
string: "any",
},
serviceBindings: [{
name: "string",
service: "string",
environment: "string",
}],
usageModel: "string",
},
},
source: {
config: {
productionBranch: "string",
deploymentsEnabled: false,
owner: "string",
prCommentsEnabled: false,
previewBranchExcludes: ["string"],
previewBranchIncludes: ["string"],
previewDeploymentSetting: "string",
productionDeploymentEnabled: false,
repoName: "string",
},
type: "string",
},
});
type: cloudflare:PagesProject
properties:
accountId: string
buildConfig:
buildCaching: false
buildCommand: string
destinationDir: string
rootDir: string
webAnalyticsTag: string
webAnalyticsToken: string
deploymentConfigs:
preview:
alwaysUseLatestCompatibilityDate: false
compatibilityDate: string
compatibilityFlags:
- string
d1Databases:
string: any
durableObjectNamespaces:
string: any
environmentVariables:
string: any
failOpen: false
kvNamespaces:
string: any
placement:
mode: string
r2Buckets:
string: any
secrets:
string: any
serviceBindings:
- environment: string
name: string
service: string
usageModel: string
production:
alwaysUseLatestCompatibilityDate: false
compatibilityDate: string
compatibilityFlags:
- string
d1Databases:
string: any
durableObjectNamespaces:
string: any
environmentVariables:
string: any
failOpen: false
kvNamespaces:
string: any
placement:
mode: string
r2Buckets:
string: any
secrets:
string: any
serviceBindings:
- environment: string
name: string
service: string
usageModel: string
name: string
productionBranch: string
source:
config:
deploymentsEnabled: false
owner: string
prCommentsEnabled: false
previewBranchExcludes:
- string
previewBranchIncludes:
- string
previewDeploymentSetting: string
productionBranch: string
productionDeploymentEnabled: false
repoName: string
type: string
PagesProject Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The PagesProject resource accepts the following input properties:
- Account
Id string - The account identifier to target for the resource.
- Name string
- The global variable for the binding in your Worker code.
- Production
Branch string - Project production branch name.
- Build
Config PagesProject Build Config - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- Deployment
Configs PagesProject Deployment Configs - Configuration for deployments in a project.
- Source
Pages
Project Source - Configuration for the project source. Read more about the source configuration in the developer documentation.
- Account
Id string - The account identifier to target for the resource.
- Name string
- The global variable for the binding in your Worker code.
- Production
Branch string - Project production branch name.
- Build
Config PagesProject Build Config Args - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- Deployment
Configs PagesProject Deployment Configs Args - Configuration for deployments in a project.
- Source
Pages
Project Source Args - Configuration for the project source. Read more about the source configuration in the developer documentation.
- account
Id String - The account identifier to target for the resource.
- name String
- The global variable for the binding in your Worker code.
- production
Branch String - Project production branch name.
- build
Config PagesProject Build Config - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- deployment
Configs PagesProject Deployment Configs - Configuration for deployments in a project.
- source
Pages
Project Source - Configuration for the project source. Read more about the source configuration in the developer documentation.
- account
Id string - The account identifier to target for the resource.
- name string
- The global variable for the binding in your Worker code.
- production
Branch string - Project production branch name.
- build
Config PagesProject Build Config - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- deployment
Configs PagesProject Deployment Configs - Configuration for deployments in a project.
- source
Pages
Project Source - Configuration for the project source. Read more about the source configuration in the developer documentation.
- account_
id str - The account identifier to target for the resource.
- name str
- The global variable for the binding in your Worker code.
- production_
branch str - Project production branch name.
- build_
config PagesProject Build Config Args - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- deployment_
configs PagesProject Deployment Configs Args - Configuration for deployments in a project.
- source
Pages
Project Source Args - Configuration for the project source. Read more about the source configuration in the developer documentation.
- account
Id String - The account identifier to target for the resource.
- name String
- The global variable for the binding in your Worker code.
- production
Branch String - Project production branch name.
- build
Config Property Map - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- deployment
Configs Property Map - Configuration for deployments in a project.
- source Property Map
- Configuration for the project source. Read more about the source configuration in the developer documentation.
Outputs
All input properties are implicitly available as output properties. Additionally, the PagesProject resource produces the following output properties:
- created_
on str - When the project was created.
- domains Sequence[str]
- A list of associated custom domains for the project.
- id str
- The provider-assigned unique ID for this managed resource.
- subdomain str
- The Cloudflare subdomain associated with the project.
Look up Existing PagesProject Resource
Get an existing PagesProject resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PagesProjectState, opts?: CustomResourceOptions): PagesProject
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
build_config: Optional[PagesProjectBuildConfigArgs] = None,
created_on: Optional[str] = None,
deployment_configs: Optional[PagesProjectDeploymentConfigsArgs] = None,
domains: Optional[Sequence[str]] = None,
name: Optional[str] = None,
production_branch: Optional[str] = None,
source: Optional[PagesProjectSourceArgs] = None,
subdomain: Optional[str] = None) -> PagesProject
func GetPagesProject(ctx *Context, name string, id IDInput, state *PagesProjectState, opts ...ResourceOption) (*PagesProject, error)
public static PagesProject Get(string name, Input<string> id, PagesProjectState? state, CustomResourceOptions? opts = null)
public static PagesProject get(String name, Output<String> id, PagesProjectState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account
Id string - The account identifier to target for the resource.
- Build
Config PagesProject Build Config - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- Created
On string - When the project was created.
- Deployment
Configs PagesProject Deployment Configs - Configuration for deployments in a project.
- Domains List<string>
- A list of associated custom domains for the project.
- Name string
- The global variable for the binding in your Worker code.
- Production
Branch string - Project production branch name.
- Source
Pages
Project Source - Configuration for the project source. Read more about the source configuration in the developer documentation.
- Subdomain string
- The Cloudflare subdomain associated with the project.
- Account
Id string - The account identifier to target for the resource.
- Build
Config PagesProject Build Config Args - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- Created
On string - When the project was created.
- Deployment
Configs PagesProject Deployment Configs Args - Configuration for deployments in a project.
- Domains []string
- A list of associated custom domains for the project.
- Name string
- The global variable for the binding in your Worker code.
- Production
Branch string - Project production branch name.
- Source
Pages
Project Source Args - Configuration for the project source. Read more about the source configuration in the developer documentation.
- Subdomain string
- The Cloudflare subdomain associated with the project.
- account
Id String - The account identifier to target for the resource.
- build
Config PagesProject Build Config - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- created
On String - When the project was created.
- deployment
Configs PagesProject Deployment Configs - Configuration for deployments in a project.
- domains List<String>
- A list of associated custom domains for the project.
- name String
- The global variable for the binding in your Worker code.
- production
Branch String - Project production branch name.
- source
Pages
Project Source - Configuration for the project source. Read more about the source configuration in the developer documentation.
- subdomain String
- The Cloudflare subdomain associated with the project.
- account
Id string - The account identifier to target for the resource.
- build
Config PagesProject Build Config - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- created
On string - When the project was created.
- deployment
Configs PagesProject Deployment Configs - Configuration for deployments in a project.
- domains string[]
- A list of associated custom domains for the project.
- name string
- The global variable for the binding in your Worker code.
- production
Branch string - Project production branch name.
- source
Pages
Project Source - Configuration for the project source. Read more about the source configuration in the developer documentation.
- subdomain string
- The Cloudflare subdomain associated with the project.
- account_
id str - The account identifier to target for the resource.
- build_
config PagesProject Build Config Args - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- created_
on str - When the project was created.
- deployment_
configs PagesProject Deployment Configs Args - Configuration for deployments in a project.
- domains Sequence[str]
- A list of associated custom domains for the project.
- name str
- The global variable for the binding in your Worker code.
- production_
branch str - Project production branch name.
- source
Pages
Project Source Args - Configuration for the project source. Read more about the source configuration in the developer documentation.
- subdomain str
- The Cloudflare subdomain associated with the project.
- account
Id String - The account identifier to target for the resource.
- build
Config Property Map - Configuration for the project build process. Read more about the build configuration in the developer documentation.
- created
On String - When the project was created.
- deployment
Configs Property Map - Configuration for deployments in a project.
- domains List<String>
- A list of associated custom domains for the project.
- name String
- The global variable for the binding in your Worker code.
- production
Branch String - Project production branch name.
- source Property Map
- Configuration for the project source. Read more about the source configuration in the developer documentation.
- subdomain String
- The Cloudflare subdomain associated with the project.
Supporting Types
PagesProjectBuildConfig, PagesProjectBuildConfigArgs
- Build
Caching bool - Enable build caching for the project.
- Build
Command string - Command used to build project.
- Destination
Dir string - Output directory of the build.
- Root
Dir string - Your project's root directory, where Cloudflare runs the build command. If your site is not in a subdirectory, leave this path value empty.
- Web
Analytics stringTag - The classifying tag for analytics.
- Web
Analytics stringToken - The auth token for analytics.
- Build
Caching bool - Enable build caching for the project.
- Build
Command string - Command used to build project.
- Destination
Dir string - Output directory of the build.
- Root
Dir string - Your project's root directory, where Cloudflare runs the build command. If your site is not in a subdirectory, leave this path value empty.
- Web
Analytics stringTag - The classifying tag for analytics.
- Web
Analytics stringToken - The auth token for analytics.
- build
Caching Boolean - Enable build caching for the project.
- build
Command String - Command used to build project.
- destination
Dir String - Output directory of the build.
- root
Dir String - Your project's root directory, where Cloudflare runs the build command. If your site is not in a subdirectory, leave this path value empty.
- web
Analytics StringTag - The classifying tag for analytics.
- web
Analytics StringToken - The auth token for analytics.
- build
Caching boolean - Enable build caching for the project.
- build
Command string - Command used to build project.
- destination
Dir string - Output directory of the build.
- root
Dir string - Your project's root directory, where Cloudflare runs the build command. If your site is not in a subdirectory, leave this path value empty.
- web
Analytics stringTag - The classifying tag for analytics.
- web
Analytics stringToken - The auth token for analytics.
- build_
caching bool - Enable build caching for the project.
- build_
command str - Command used to build project.
- destination_
dir str - Output directory of the build.
- root_
dir str - Your project's root directory, where Cloudflare runs the build command. If your site is not in a subdirectory, leave this path value empty.
- web_
analytics_ strtag - The classifying tag for analytics.
- web_
analytics_ strtoken - The auth token for analytics.
- build
Caching Boolean - Enable build caching for the project.
- build
Command String - Command used to build project.
- destination
Dir String - Output directory of the build.
- root
Dir String - Your project's root directory, where Cloudflare runs the build command. If your site is not in a subdirectory, leave this path value empty.
- web
Analytics StringTag - The classifying tag for analytics.
- web
Analytics StringToken - The auth token for analytics.
PagesProjectDeploymentConfigs, PagesProjectDeploymentConfigsArgs
- Preview
Pages
Project Deployment Configs Preview - Configuration for preview deploys.
- Production
Pages
Project Deployment Configs Production - Configuration for production deploys.
- Preview
Pages
Project Deployment Configs Preview - Configuration for preview deploys.
- Production
Pages
Project Deployment Configs Production - Configuration for production deploys.
- preview
Pages
Project Deployment Configs Preview - Configuration for preview deploys.
- production
Pages
Project Deployment Configs Production - Configuration for production deploys.
- preview
Pages
Project Deployment Configs Preview - Configuration for preview deploys.
- production
Pages
Project Deployment Configs Production - Configuration for production deploys.
- preview
Pages
Project Deployment Configs Preview - Configuration for preview deploys.
- production
Pages
Project Deployment Configs Production - Configuration for production deploys.
- preview Property Map
- Configuration for preview deploys.
- production Property Map
- Configuration for production deploys.
PagesProjectDeploymentConfigsPreview, PagesProjectDeploymentConfigsPreviewArgs
- Always
Use boolLatest Compatibility Date - Use latest compatibility date for Pages Functions. Defaults to
false
. - Compatibility
Date string - Compatibility date used for Pages Functions.
- Compatibility
Flags List<string> - Compatibility flags used for Pages Functions.
- D1Databases Dictionary<string, object>
- D1 Databases used for Pages Functions. Defaults to
map[]
. - Durable
Object Dictionary<string, object>Namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - Environment
Variables Dictionary<string, object> - Environment variables for Pages Functions. Defaults to
map[]
. - Fail
Open bool - Fail open used for Pages Functions. Defaults to
false
. - Kv
Namespaces Dictionary<string, object> - KV namespaces used for Pages Functions. Defaults to
map[]
. - Placement
Pages
Project Deployment Configs Preview Placement - Configuration for placement in the Cloudflare Pages project.
- R2Buckets Dictionary<string, object>
- R2 Buckets used for Pages Functions. Defaults to
map[]
. - Secrets Dictionary<string, object>
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - Service
Bindings List<PagesProject Deployment Configs Preview Service Binding> - Services used for Pages Functions.
- Usage
Model string - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
- Always
Use boolLatest Compatibility Date - Use latest compatibility date for Pages Functions. Defaults to
false
. - Compatibility
Date string - Compatibility date used for Pages Functions.
- Compatibility
Flags []string - Compatibility flags used for Pages Functions.
- D1Databases map[string]interface{}
- D1 Databases used for Pages Functions. Defaults to
map[]
. - Durable
Object map[string]interface{}Namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - Environment
Variables map[string]interface{} - Environment variables for Pages Functions. Defaults to
map[]
. - Fail
Open bool - Fail open used for Pages Functions. Defaults to
false
. - Kv
Namespaces map[string]interface{} - KV namespaces used for Pages Functions. Defaults to
map[]
. - Placement
Pages
Project Deployment Configs Preview Placement - Configuration for placement in the Cloudflare Pages project.
- R2Buckets map[string]interface{}
- R2 Buckets used for Pages Functions. Defaults to
map[]
. - Secrets map[string]interface{}
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - Service
Bindings []PagesProject Deployment Configs Preview Service Binding - Services used for Pages Functions.
- Usage
Model string - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
- always
Use BooleanLatest Compatibility Date - Use latest compatibility date for Pages Functions. Defaults to
false
. - compatibility
Date String - Compatibility date used for Pages Functions.
- compatibility
Flags List<String> - Compatibility flags used for Pages Functions.
- d1Databases Map<String,Object>
- D1 Databases used for Pages Functions. Defaults to
map[]
. - durable
Object Map<String,Object>Namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - environment
Variables Map<String,Object> - Environment variables for Pages Functions. Defaults to
map[]
. - fail
Open Boolean - Fail open used for Pages Functions. Defaults to
false
. - kv
Namespaces Map<String,Object> - KV namespaces used for Pages Functions. Defaults to
map[]
. - placement
Pages
Project Deployment Configs Preview Placement - Configuration for placement in the Cloudflare Pages project.
- r2Buckets Map<String,Object>
- R2 Buckets used for Pages Functions. Defaults to
map[]
. - secrets Map<String,Object>
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - service
Bindings List<PagesProject Deployment Configs Preview Service Binding> - Services used for Pages Functions.
- usage
Model String - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
- always
Use booleanLatest Compatibility Date - Use latest compatibility date for Pages Functions. Defaults to
false
. - compatibility
Date string - Compatibility date used for Pages Functions.
- compatibility
Flags string[] - Compatibility flags used for Pages Functions.
- d1Databases {[key: string]: any}
- D1 Databases used for Pages Functions. Defaults to
map[]
. - durable
Object {[key: string]: any}Namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - environment
Variables {[key: string]: any} - Environment variables for Pages Functions. Defaults to
map[]
. - fail
Open boolean - Fail open used for Pages Functions. Defaults to
false
. - kv
Namespaces {[key: string]: any} - KV namespaces used for Pages Functions. Defaults to
map[]
. - placement
Pages
Project Deployment Configs Preview Placement - Configuration for placement in the Cloudflare Pages project.
- r2Buckets {[key: string]: any}
- R2 Buckets used for Pages Functions. Defaults to
map[]
. - secrets {[key: string]: any}
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - service
Bindings PagesProject Deployment Configs Preview Service Binding[] - Services used for Pages Functions.
- usage
Model string - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
- always_
use_ boollatest_ compatibility_ date - Use latest compatibility date for Pages Functions. Defaults to
false
. - compatibility_
date str - Compatibility date used for Pages Functions.
- compatibility_
flags Sequence[str] - Compatibility flags used for Pages Functions.
- d1_
databases Mapping[str, Any] - D1 Databases used for Pages Functions. Defaults to
map[]
. - durable_
object_ Mapping[str, Any]namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - environment_
variables Mapping[str, Any] - Environment variables for Pages Functions. Defaults to
map[]
. - fail_
open bool - Fail open used for Pages Functions. Defaults to
false
. - kv_
namespaces Mapping[str, Any] - KV namespaces used for Pages Functions. Defaults to
map[]
. - placement
Pages
Project Deployment Configs Preview Placement - Configuration for placement in the Cloudflare Pages project.
- r2_
buckets Mapping[str, Any] - R2 Buckets used for Pages Functions. Defaults to
map[]
. - secrets Mapping[str, Any]
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - service_
bindings Sequence[PagesProject Deployment Configs Preview Service Binding] - Services used for Pages Functions.
- usage_
model str - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
- always
Use BooleanLatest Compatibility Date - Use latest compatibility date for Pages Functions. Defaults to
false
. - compatibility
Date String - Compatibility date used for Pages Functions.
- compatibility
Flags List<String> - Compatibility flags used for Pages Functions.
- d1Databases Map<Any>
- D1 Databases used for Pages Functions. Defaults to
map[]
. - durable
Object Map<Any>Namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - environment
Variables Map<Any> - Environment variables for Pages Functions. Defaults to
map[]
. - fail
Open Boolean - Fail open used for Pages Functions. Defaults to
false
. - kv
Namespaces Map<Any> - KV namespaces used for Pages Functions. Defaults to
map[]
. - placement Property Map
- Configuration for placement in the Cloudflare Pages project.
- r2Buckets Map<Any>
- R2 Buckets used for Pages Functions. Defaults to
map[]
. - secrets Map<Any>
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - service
Bindings List<Property Map> - Services used for Pages Functions.
- usage
Model String - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
PagesProjectDeploymentConfigsPreviewPlacement, PagesProjectDeploymentConfigsPreviewPlacementArgs
- Mode string
- Placement Mode for the Pages Function.
- Mode string
- Placement Mode for the Pages Function.
- mode String
- Placement Mode for the Pages Function.
- mode string
- Placement Mode for the Pages Function.
- mode str
- Placement Mode for the Pages Function.
- mode String
- Placement Mode for the Pages Function.
PagesProjectDeploymentConfigsPreviewServiceBinding, PagesProjectDeploymentConfigsPreviewServiceBindingArgs
- Name string
- The global variable for the binding in your Worker code.
- Service string
- The name of the Worker to bind to.
- Environment string
- The name of the Worker environment to bind to.
- Name string
- The global variable for the binding in your Worker code.
- Service string
- The name of the Worker to bind to.
- Environment string
- The name of the Worker environment to bind to.
- name String
- The global variable for the binding in your Worker code.
- service String
- The name of the Worker to bind to.
- environment String
- The name of the Worker environment to bind to.
- name string
- The global variable for the binding in your Worker code.
- service string
- The name of the Worker to bind to.
- environment string
- The name of the Worker environment to bind to.
- name str
- The global variable for the binding in your Worker code.
- service str
- The name of the Worker to bind to.
- environment str
- The name of the Worker environment to bind to.
- name String
- The global variable for the binding in your Worker code.
- service String
- The name of the Worker to bind to.
- environment String
- The name of the Worker environment to bind to.
PagesProjectDeploymentConfigsProduction, PagesProjectDeploymentConfigsProductionArgs
- Always
Use boolLatest Compatibility Date - Use latest compatibility date for Pages Functions. Defaults to
false
. - Compatibility
Date string - Compatibility date used for Pages Functions.
- Compatibility
Flags List<string> - Compatibility flags used for Pages Functions.
- D1Databases Dictionary<string, object>
- D1 Databases used for Pages Functions. Defaults to
map[]
. - Durable
Object Dictionary<string, object>Namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - Environment
Variables Dictionary<string, object> - Environment variables for Pages Functions. Defaults to
map[]
. - Fail
Open bool - Fail open used for Pages Functions. Defaults to
false
. - Kv
Namespaces Dictionary<string, object> - KV namespaces used for Pages Functions. Defaults to
map[]
. - Placement
Pages
Project Deployment Configs Production Placement - Configuration for placement in the Cloudflare Pages project.
- R2Buckets Dictionary<string, object>
- R2 Buckets used for Pages Functions. Defaults to
map[]
. - Secrets Dictionary<string, object>
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - Service
Bindings List<PagesProject Deployment Configs Production Service Binding> - Services used for Pages Functions.
- Usage
Model string - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
- Always
Use boolLatest Compatibility Date - Use latest compatibility date for Pages Functions. Defaults to
false
. - Compatibility
Date string - Compatibility date used for Pages Functions.
- Compatibility
Flags []string - Compatibility flags used for Pages Functions.
- D1Databases map[string]interface{}
- D1 Databases used for Pages Functions. Defaults to
map[]
. - Durable
Object map[string]interface{}Namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - Environment
Variables map[string]interface{} - Environment variables for Pages Functions. Defaults to
map[]
. - Fail
Open bool - Fail open used for Pages Functions. Defaults to
false
. - Kv
Namespaces map[string]interface{} - KV namespaces used for Pages Functions. Defaults to
map[]
. - Placement
Pages
Project Deployment Configs Production Placement - Configuration for placement in the Cloudflare Pages project.
- R2Buckets map[string]interface{}
- R2 Buckets used for Pages Functions. Defaults to
map[]
. - Secrets map[string]interface{}
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - Service
Bindings []PagesProject Deployment Configs Production Service Binding - Services used for Pages Functions.
- Usage
Model string - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
- always
Use BooleanLatest Compatibility Date - Use latest compatibility date for Pages Functions. Defaults to
false
. - compatibility
Date String - Compatibility date used for Pages Functions.
- compatibility
Flags List<String> - Compatibility flags used for Pages Functions.
- d1Databases Map<String,Object>
- D1 Databases used for Pages Functions. Defaults to
map[]
. - durable
Object Map<String,Object>Namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - environment
Variables Map<String,Object> - Environment variables for Pages Functions. Defaults to
map[]
. - fail
Open Boolean - Fail open used for Pages Functions. Defaults to
false
. - kv
Namespaces Map<String,Object> - KV namespaces used for Pages Functions. Defaults to
map[]
. - placement
Pages
Project Deployment Configs Production Placement - Configuration for placement in the Cloudflare Pages project.
- r2Buckets Map<String,Object>
- R2 Buckets used for Pages Functions. Defaults to
map[]
. - secrets Map<String,Object>
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - service
Bindings List<PagesProject Deployment Configs Production Service Binding> - Services used for Pages Functions.
- usage
Model String - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
- always
Use booleanLatest Compatibility Date - Use latest compatibility date for Pages Functions. Defaults to
false
. - compatibility
Date string - Compatibility date used for Pages Functions.
- compatibility
Flags string[] - Compatibility flags used for Pages Functions.
- d1Databases {[key: string]: any}
- D1 Databases used for Pages Functions. Defaults to
map[]
. - durable
Object {[key: string]: any}Namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - environment
Variables {[key: string]: any} - Environment variables for Pages Functions. Defaults to
map[]
. - fail
Open boolean - Fail open used for Pages Functions. Defaults to
false
. - kv
Namespaces {[key: string]: any} - KV namespaces used for Pages Functions. Defaults to
map[]
. - placement
Pages
Project Deployment Configs Production Placement - Configuration for placement in the Cloudflare Pages project.
- r2Buckets {[key: string]: any}
- R2 Buckets used for Pages Functions. Defaults to
map[]
. - secrets {[key: string]: any}
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - service
Bindings PagesProject Deployment Configs Production Service Binding[] - Services used for Pages Functions.
- usage
Model string - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
- always_
use_ boollatest_ compatibility_ date - Use latest compatibility date for Pages Functions. Defaults to
false
. - compatibility_
date str - Compatibility date used for Pages Functions.
- compatibility_
flags Sequence[str] - Compatibility flags used for Pages Functions.
- d1_
databases Mapping[str, Any] - D1 Databases used for Pages Functions. Defaults to
map[]
. - durable_
object_ Mapping[str, Any]namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - environment_
variables Mapping[str, Any] - Environment variables for Pages Functions. Defaults to
map[]
. - fail_
open bool - Fail open used for Pages Functions. Defaults to
false
. - kv_
namespaces Mapping[str, Any] - KV namespaces used for Pages Functions. Defaults to
map[]
. - placement
Pages
Project Deployment Configs Production Placement - Configuration for placement in the Cloudflare Pages project.
- r2_
buckets Mapping[str, Any] - R2 Buckets used for Pages Functions. Defaults to
map[]
. - secrets Mapping[str, Any]
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - service_
bindings Sequence[PagesProject Deployment Configs Production Service Binding] - Services used for Pages Functions.
- usage_
model str - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
- always
Use BooleanLatest Compatibility Date - Use latest compatibility date for Pages Functions. Defaults to
false
. - compatibility
Date String - Compatibility date used for Pages Functions.
- compatibility
Flags List<String> - Compatibility flags used for Pages Functions.
- d1Databases Map<Any>
- D1 Databases used for Pages Functions. Defaults to
map[]
. - durable
Object Map<Any>Namespaces - Durable Object namespaces used for Pages Functions. Defaults to
map[]
. - environment
Variables Map<Any> - Environment variables for Pages Functions. Defaults to
map[]
. - fail
Open Boolean - Fail open used for Pages Functions. Defaults to
false
. - kv
Namespaces Map<Any> - KV namespaces used for Pages Functions. Defaults to
map[]
. - placement Property Map
- Configuration for placement in the Cloudflare Pages project.
- r2Buckets Map<Any>
- R2 Buckets used for Pages Functions. Defaults to
map[]
. - secrets Map<Any>
- Encrypted environment variables for Pages Functions. Defaults to
map[]
. - service
Bindings List<Property Map> - Services used for Pages Functions.
- usage
Model String - Usage model used for Pages Functions. Available values:
unbound
,bundled
,standard
. Defaults tobundled
.
PagesProjectDeploymentConfigsProductionPlacement, PagesProjectDeploymentConfigsProductionPlacementArgs
- Mode string
- Placement Mode for the Pages Function.
- Mode string
- Placement Mode for the Pages Function.
- mode String
- Placement Mode for the Pages Function.
- mode string
- Placement Mode for the Pages Function.
- mode str
- Placement Mode for the Pages Function.
- mode String
- Placement Mode for the Pages Function.
PagesProjectDeploymentConfigsProductionServiceBinding, PagesProjectDeploymentConfigsProductionServiceBindingArgs
- Name string
- The global variable for the binding in your Worker code.
- Service string
- The name of the Worker to bind to.
- Environment string
- The name of the Worker environment to bind to.
- Name string
- The global variable for the binding in your Worker code.
- Service string
- The name of the Worker to bind to.
- Environment string
- The name of the Worker environment to bind to.
- name String
- The global variable for the binding in your Worker code.
- service String
- The name of the Worker to bind to.
- environment String
- The name of the Worker environment to bind to.
- name string
- The global variable for the binding in your Worker code.
- service string
- The name of the Worker to bind to.
- environment string
- The name of the Worker environment to bind to.
- name str
- The global variable for the binding in your Worker code.
- service str
- The name of the Worker to bind to.
- environment str
- The name of the Worker environment to bind to.
- name String
- The global variable for the binding in your Worker code.
- service String
- The name of the Worker to bind to.
- environment String
- The name of the Worker environment to bind to.
PagesProjectSource, PagesProjectSourceArgs
- Config
Pages
Project Source Config - Configuration for the source of the Cloudflare Pages project.
- Type string
- Project host type.
- Config
Pages
Project Source Config - Configuration for the source of the Cloudflare Pages project.
- Type string
- Project host type.
- config
Pages
Project Source Config - Configuration for the source of the Cloudflare Pages project.
- type String
- Project host type.
- config
Pages
Project Source Config - Configuration for the source of the Cloudflare Pages project.
- type string
- Project host type.
- config
Pages
Project Source Config - Configuration for the source of the Cloudflare Pages project.
- type str
- Project host type.
- config Property Map
- Configuration for the source of the Cloudflare Pages project.
- type String
- Project host type.
PagesProjectSourceConfig, PagesProjectSourceConfigArgs
- Production
Branch string - Project production branch name.
- Deployments
Enabled bool - Toggle deployments on this repo. Defaults to
true
. - Owner string
- Project owner username. Modifying this attribute will force creation of a new resource.
- Pr
Comments boolEnabled - Enable Pages to comment on Pull Requests. Defaults to
true
. - Preview
Branch List<string>Excludes - Branches will be excluded from automatic deployment.
- Preview
Branch List<string>Includes - Branches will be included for automatic deployment.
- Preview
Deployment stringSetting - Preview Deployment Setting. Available values:
custom
,all
,none
. Defaults toall
. - Production
Deployment boolEnabled - Enable production deployments. Defaults to
true
. - Repo
Name string - Project repository name. Modifying this attribute will force creation of a new resource.
- Production
Branch string - Project production branch name.
- Deployments
Enabled bool - Toggle deployments on this repo. Defaults to
true
. - Owner string
- Project owner username. Modifying this attribute will force creation of a new resource.
- Pr
Comments boolEnabled - Enable Pages to comment on Pull Requests. Defaults to
true
. - Preview
Branch []stringExcludes - Branches will be excluded from automatic deployment.
- Preview
Branch []stringIncludes - Branches will be included for automatic deployment.
- Preview
Deployment stringSetting - Preview Deployment Setting. Available values:
custom
,all
,none
. Defaults toall
. - Production
Deployment boolEnabled - Enable production deployments. Defaults to
true
. - Repo
Name string - Project repository name. Modifying this attribute will force creation of a new resource.
- production
Branch String - Project production branch name.
- deployments
Enabled Boolean - Toggle deployments on this repo. Defaults to
true
. - owner String
- Project owner username. Modifying this attribute will force creation of a new resource.
- pr
Comments BooleanEnabled - Enable Pages to comment on Pull Requests. Defaults to
true
. - preview
Branch List<String>Excludes - Branches will be excluded from automatic deployment.
- preview
Branch List<String>Includes - Branches will be included for automatic deployment.
- preview
Deployment StringSetting - Preview Deployment Setting. Available values:
custom
,all
,none
. Defaults toall
. - production
Deployment BooleanEnabled - Enable production deployments. Defaults to
true
. - repo
Name String - Project repository name. Modifying this attribute will force creation of a new resource.
- production
Branch string - Project production branch name.
- deployments
Enabled boolean - Toggle deployments on this repo. Defaults to
true
. - owner string
- Project owner username. Modifying this attribute will force creation of a new resource.
- pr
Comments booleanEnabled - Enable Pages to comment on Pull Requests. Defaults to
true
. - preview
Branch string[]Excludes - Branches will be excluded from automatic deployment.
- preview
Branch string[]Includes - Branches will be included for automatic deployment.
- preview
Deployment stringSetting - Preview Deployment Setting. Available values:
custom
,all
,none
. Defaults toall
. - production
Deployment booleanEnabled - Enable production deployments. Defaults to
true
. - repo
Name string - Project repository name. Modifying this attribute will force creation of a new resource.
- production_
branch str - Project production branch name.
- deployments_
enabled bool - Toggle deployments on this repo. Defaults to
true
. - owner str
- Project owner username. Modifying this attribute will force creation of a new resource.
- pr_
comments_ boolenabled - Enable Pages to comment on Pull Requests. Defaults to
true
. - preview_
branch_ Sequence[str]excludes - Branches will be excluded from automatic deployment.
- preview_
branch_ Sequence[str]includes - Branches will be included for automatic deployment.
- preview_
deployment_ strsetting - Preview Deployment Setting. Available values:
custom
,all
,none
. Defaults toall
. - production_
deployment_ boolenabled - Enable production deployments. Defaults to
true
. - repo_
name str - Project repository name. Modifying this attribute will force creation of a new resource.
- production
Branch String - Project production branch name.
- deployments
Enabled Boolean - Toggle deployments on this repo. Defaults to
true
. - owner String
- Project owner username. Modifying this attribute will force creation of a new resource.
- pr
Comments BooleanEnabled - Enable Pages to comment on Pull Requests. Defaults to
true
. - preview
Branch List<String>Excludes - Branches will be excluded from automatic deployment.
- preview
Branch List<String>Includes - Branches will be included for automatic deployment.
- preview
Deployment StringSetting - Preview Deployment Setting. Available values:
custom
,all
,none
. Defaults toall
. - production
Deployment BooleanEnabled - Enable production deployments. Defaults to
true
. - repo
Name String - Project repository name. Modifying this attribute will force creation of a new resource.
Import
!> It is not possible to import a pages project with secret environment variables. If you have a secret environment variable, you must remove it from your project before importing it.
$ pulumi import cloudflare:index/pagesProject:PagesProject example <account_id>/<project_name>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cloudflare
Terraform Provider.