Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. PagesProject
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.PagesProject

Explore with Pulumi AI

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

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.

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 This property is required. string
The unique name of the resource.
args This property is required. PagesProjectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. PagesProjectArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PagesProjectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PagesProjectArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor 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", "string" },
            },
            DurableObjectNamespaces = 
            {
                { "string", "string" },
            },
            EnvironmentVariables = 
            {
                { "string", "string" },
            },
            FailOpen = false,
            KvNamespaces = 
            {
                { "string", "string" },
            },
            Placement = new Cloudflare.Inputs.PagesProjectDeploymentConfigsPreviewPlacementArgs
            {
                Mode = "string",
            },
            R2Buckets = 
            {
                { "string", "string" },
            },
            Secrets = 
            {
                { "string", "string" },
            },
            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", "string" },
            },
            DurableObjectNamespaces = 
            {
                { "string", "string" },
            },
            EnvironmentVariables = 
            {
                { "string", "string" },
            },
            FailOpen = false,
            KvNamespaces = 
            {
                { "string", "string" },
            },
            Placement = new Cloudflare.Inputs.PagesProjectDeploymentConfigsProductionPlacementArgs
            {
                Mode = "string",
            },
            R2Buckets = 
            {
                { "string", "string" },
            },
            Secrets = 
            {
                { "string", "string" },
            },
            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",
    },
});
Copy
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.StringMap{
				"string": pulumi.String("string"),
			},
			DurableObjectNamespaces: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			EnvironmentVariables: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			FailOpen: pulumi.Bool(false),
			KvNamespaces: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Placement: &cloudflare.PagesProjectDeploymentConfigsPreviewPlacementArgs{
				Mode: pulumi.String("string"),
			},
			R2Buckets: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Secrets: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			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.StringMap{
				"string": pulumi.String("string"),
			},
			DurableObjectNamespaces: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			EnvironmentVariables: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			FailOpen: pulumi.Bool(false),
			KvNamespaces: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Placement: &cloudflare.PagesProjectDeploymentConfigsProductionPlacementArgs{
				Mode: pulumi.String("string"),
			},
			R2Buckets: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Secrets: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			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"),
	},
})
Copy
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", "string"))
            .durableObjectNamespaces(Map.of("string", "string"))
            .environmentVariables(Map.of("string", "string"))
            .failOpen(false)
            .kvNamespaces(Map.of("string", "string"))
            .placement(PagesProjectDeploymentConfigsPreviewPlacementArgs.builder()
                .mode("string")
                .build())
            .r2Buckets(Map.of("string", "string"))
            .secrets(Map.of("string", "string"))
            .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", "string"))
            .durableObjectNamespaces(Map.of("string", "string"))
            .environmentVariables(Map.of("string", "string"))
            .failOpen(false)
            .kvNamespaces(Map.of("string", "string"))
            .placement(PagesProjectDeploymentConfigsProductionPlacementArgs.builder()
                .mode("string")
                .build())
            .r2Buckets(Map.of("string", "string"))
            .secrets(Map.of("string", "string"))
            .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());
Copy
pages_project_resource = cloudflare.PagesProject("pagesProjectResource",
    account_id="string",
    name="string",
    production_branch="string",
    build_config={
        "build_caching": False,
        "build_command": "string",
        "destination_dir": "string",
        "root_dir": "string",
        "web_analytics_tag": "string",
        "web_analytics_token": "string",
    },
    deployment_configs={
        "preview": {
            "always_use_latest_compatibility_date": False,
            "compatibility_date": "string",
            "compatibility_flags": ["string"],
            "d1_databases": {
                "string": "string",
            },
            "durable_object_namespaces": {
                "string": "string",
            },
            "environment_variables": {
                "string": "string",
            },
            "fail_open": False,
            "kv_namespaces": {
                "string": "string",
            },
            "placement": {
                "mode": "string",
            },
            "r2_buckets": {
                "string": "string",
            },
            "secrets": {
                "string": "string",
            },
            "service_bindings": [{
                "name": "string",
                "service": "string",
                "environment": "string",
            }],
            "usage_model": "string",
        },
        "production": {
            "always_use_latest_compatibility_date": False,
            "compatibility_date": "string",
            "compatibility_flags": ["string"],
            "d1_databases": {
                "string": "string",
            },
            "durable_object_namespaces": {
                "string": "string",
            },
            "environment_variables": {
                "string": "string",
            },
            "fail_open": False,
            "kv_namespaces": {
                "string": "string",
            },
            "placement": {
                "mode": "string",
            },
            "r2_buckets": {
                "string": "string",
            },
            "secrets": {
                "string": "string",
            },
            "service_bindings": [{
                "name": "string",
                "service": "string",
                "environment": "string",
            }],
            "usage_model": "string",
        },
    },
    source={
        "config": {
            "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",
    })
Copy
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: "string",
            },
            durableObjectNamespaces: {
                string: "string",
            },
            environmentVariables: {
                string: "string",
            },
            failOpen: false,
            kvNamespaces: {
                string: "string",
            },
            placement: {
                mode: "string",
            },
            r2Buckets: {
                string: "string",
            },
            secrets: {
                string: "string",
            },
            serviceBindings: [{
                name: "string",
                service: "string",
                environment: "string",
            }],
            usageModel: "string",
        },
        production: {
            alwaysUseLatestCompatibilityDate: false,
            compatibilityDate: "string",
            compatibilityFlags: ["string"],
            d1Databases: {
                string: "string",
            },
            durableObjectNamespaces: {
                string: "string",
            },
            environmentVariables: {
                string: "string",
            },
            failOpen: false,
            kvNamespaces: {
                string: "string",
            },
            placement: {
                mode: "string",
            },
            r2Buckets: {
                string: "string",
            },
            secrets: {
                string: "string",
            },
            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",
    },
});
Copy
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: string
            durableObjectNamespaces:
                string: string
            environmentVariables:
                string: string
            failOpen: false
            kvNamespaces:
                string: string
            placement:
                mode: string
            r2Buckets:
                string: string
            secrets:
                string: string
            serviceBindings:
                - environment: string
                  name: string
                  service: string
            usageModel: string
        production:
            alwaysUseLatestCompatibilityDate: false
            compatibilityDate: string
            compatibilityFlags:
                - string
            d1Databases:
                string: string
            durableObjectNamespaces:
                string: string
            environmentVariables:
                string: string
            failOpen: false
            kvNamespaces:
                string: string
            placement:
                mode: string
            r2Buckets:
                string: string
            secrets:
                string: string
            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
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PagesProject resource accepts the following input properties:

AccountId This property is required. string
The account identifier to target for the resource.
Name This property is required. string
Name of the project.
ProductionBranch This property is required. string
The name of the branch that is used for the production environment.
BuildConfig PagesProjectBuildConfig
Configuration for the project build process. Read more about the build configuration in the developer documentation.
DeploymentConfigs PagesProjectDeploymentConfigs
Configuration for deployments in a project.
Source PagesProjectSource
Configuration for the project source. Read more about the source configuration in the developer documentation.
AccountId This property is required. string
The account identifier to target for the resource.
Name This property is required. string
Name of the project.
ProductionBranch This property is required. string
The name of the branch that is used for the production environment.
BuildConfig PagesProjectBuildConfigArgs
Configuration for the project build process. Read more about the build configuration in the developer documentation.
DeploymentConfigs PagesProjectDeploymentConfigsArgs
Configuration for deployments in a project.
Source PagesProjectSourceArgs
Configuration for the project source. Read more about the source configuration in the developer documentation.
accountId This property is required. String
The account identifier to target for the resource.
name This property is required. String
Name of the project.
productionBranch This property is required. String
The name of the branch that is used for the production environment.
buildConfig PagesProjectBuildConfig
Configuration for the project build process. Read more about the build configuration in the developer documentation.
deploymentConfigs PagesProjectDeploymentConfigs
Configuration for deployments in a project.
source PagesProjectSource
Configuration for the project source. Read more about the source configuration in the developer documentation.
accountId This property is required. string
The account identifier to target for the resource.
name This property is required. string
Name of the project.
productionBranch This property is required. string
The name of the branch that is used for the production environment.
buildConfig PagesProjectBuildConfig
Configuration for the project build process. Read more about the build configuration in the developer documentation.
deploymentConfigs PagesProjectDeploymentConfigs
Configuration for deployments in a project.
source PagesProjectSource
Configuration for the project source. Read more about the source configuration in the developer documentation.
account_id This property is required. str
The account identifier to target for the resource.
name This property is required. str
Name of the project.
production_branch This property is required. str
The name of the branch that is used for the production environment.
build_config PagesProjectBuildConfigArgs
Configuration for the project build process. Read more about the build configuration in the developer documentation.
deployment_configs PagesProjectDeploymentConfigsArgs
Configuration for deployments in a project.
source PagesProjectSourceArgs
Configuration for the project source. Read more about the source configuration in the developer documentation.
accountId This property is required. String
The account identifier to target for the resource.
name This property is required. String
Name of the project.
productionBranch This property is required. String
The name of the branch that is used for the production environment.
buildConfig Property Map
Configuration for the project build process. Read more about the build configuration in the developer documentation.
deploymentConfigs 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:

CreatedOn string
When the project was created.
Domains List<string>
A list of associated custom domains for the project.
Id string
The provider-assigned unique ID for this managed resource.
Subdomain string
The Cloudflare subdomain associated with the project.
CreatedOn string
When the project was created.
Domains []string
A list of associated custom domains for the project.
Id string
The provider-assigned unique ID for this managed resource.
Subdomain string
The Cloudflare subdomain associated with the project.
createdOn String
When the project was created.
domains List<String>
A list of associated custom domains for the project.
id String
The provider-assigned unique ID for this managed resource.
subdomain String
The Cloudflare subdomain associated with the project.
createdOn string
When the project was created.
domains string[]
A list of associated custom domains for the project.
id string
The provider-assigned unique ID for this managed resource.
subdomain string
The Cloudflare subdomain associated with the project.
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.
createdOn String
When the project was created.
domains List<String>
A list of associated custom domains for the project.
id String
The provider-assigned unique ID for this managed resource.
subdomain String
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)
resources:  _:    type: cloudflare:PagesProject    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
AccountId string
The account identifier to target for the resource.
BuildConfig PagesProjectBuildConfig
Configuration for the project build process. Read more about the build configuration in the developer documentation.
CreatedOn string
When the project was created.
DeploymentConfigs PagesProjectDeploymentConfigs
Configuration for deployments in a project.
Domains List<string>
A list of associated custom domains for the project.
Name string
Name of the project.
ProductionBranch string
The name of the branch that is used for the production environment.
Source PagesProjectSource
Configuration for the project source. Read more about the source configuration in the developer documentation.
Subdomain string
The Cloudflare subdomain associated with the project.
AccountId string
The account identifier to target for the resource.
BuildConfig PagesProjectBuildConfigArgs
Configuration for the project build process. Read more about the build configuration in the developer documentation.
CreatedOn string
When the project was created.
DeploymentConfigs PagesProjectDeploymentConfigsArgs
Configuration for deployments in a project.
Domains []string
A list of associated custom domains for the project.
Name string
Name of the project.
ProductionBranch string
The name of the branch that is used for the production environment.
Source PagesProjectSourceArgs
Configuration for the project source. Read more about the source configuration in the developer documentation.
Subdomain string
The Cloudflare subdomain associated with the project.
accountId String
The account identifier to target for the resource.
buildConfig PagesProjectBuildConfig
Configuration for the project build process. Read more about the build configuration in the developer documentation.
createdOn String
When the project was created.
deploymentConfigs PagesProjectDeploymentConfigs
Configuration for deployments in a project.
domains List<String>
A list of associated custom domains for the project.
name String
Name of the project.
productionBranch String
The name of the branch that is used for the production environment.
source PagesProjectSource
Configuration for the project source. Read more about the source configuration in the developer documentation.
subdomain String
The Cloudflare subdomain associated with the project.
accountId string
The account identifier to target for the resource.
buildConfig PagesProjectBuildConfig
Configuration for the project build process. Read more about the build configuration in the developer documentation.
createdOn string
When the project was created.
deploymentConfigs PagesProjectDeploymentConfigs
Configuration for deployments in a project.
domains string[]
A list of associated custom domains for the project.
name string
Name of the project.
productionBranch string
The name of the branch that is used for the production environment.
source PagesProjectSource
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 PagesProjectBuildConfigArgs
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 PagesProjectDeploymentConfigsArgs
Configuration for deployments in a project.
domains Sequence[str]
A list of associated custom domains for the project.
name str
Name of the project.
production_branch str
The name of the branch that is used for the production environment.
source PagesProjectSourceArgs
Configuration for the project source. Read more about the source configuration in the developer documentation.
subdomain str
The Cloudflare subdomain associated with the project.
accountId String
The account identifier to target for the resource.
buildConfig Property Map
Configuration for the project build process. Read more about the build configuration in the developer documentation.
createdOn String
When the project was created.
deploymentConfigs Property Map
Configuration for deployments in a project.
domains List<String>
A list of associated custom domains for the project.
name String
Name of the project.
productionBranch String
The name of the branch that is used for the production environment.
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

BuildCaching bool
Enable build caching for the project.
BuildCommand string
Command used to build project.
DestinationDir string
Output directory of the build.
RootDir 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.
WebAnalyticsTag string
The classifying tag for analytics.
WebAnalyticsToken string
The auth token for analytics.
BuildCaching bool
Enable build caching for the project.
BuildCommand string
Command used to build project.
DestinationDir string
Output directory of the build.
RootDir 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.
WebAnalyticsTag string
The classifying tag for analytics.
WebAnalyticsToken string
The auth token for analytics.
buildCaching Boolean
Enable build caching for the project.
buildCommand String
Command used to build project.
destinationDir String
Output directory of the build.
rootDir 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.
webAnalyticsTag String
The classifying tag for analytics.
webAnalyticsToken String
The auth token for analytics.
buildCaching boolean
Enable build caching for the project.
buildCommand string
Command used to build project.
destinationDir string
Output directory of the build.
rootDir 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.
webAnalyticsTag string
The classifying tag for analytics.
webAnalyticsToken string
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_tag str
The classifying tag for analytics.
web_analytics_token str
The auth token for analytics.
buildCaching Boolean
Enable build caching for the project.
buildCommand String
Command used to build project.
destinationDir String
Output directory of the build.
rootDir 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.
webAnalyticsTag String
The classifying tag for analytics.
webAnalyticsToken String
The auth token for analytics.

PagesProjectDeploymentConfigs
, PagesProjectDeploymentConfigsArgs

Preview PagesProjectDeploymentConfigsPreview
Configuration for preview deploys.
Production PagesProjectDeploymentConfigsProduction
Configuration for production deploys.
Preview PagesProjectDeploymentConfigsPreview
Configuration for preview deploys.
Production PagesProjectDeploymentConfigsProduction
Configuration for production deploys.
preview PagesProjectDeploymentConfigsPreview
Configuration for preview deploys.
production PagesProjectDeploymentConfigsProduction
Configuration for production deploys.
preview PagesProjectDeploymentConfigsPreview
Configuration for preview deploys.
production PagesProjectDeploymentConfigsProduction
Configuration for production deploys.
preview PagesProjectDeploymentConfigsPreview
Configuration for preview deploys.
production PagesProjectDeploymentConfigsProduction
Configuration for production deploys.
preview Property Map
Configuration for preview deploys.
production Property Map
Configuration for production deploys.

PagesProjectDeploymentConfigsPreview
, PagesProjectDeploymentConfigsPreviewArgs

AlwaysUseLatestCompatibilityDate bool
Use latest compatibility date for Pages Functions. Defaults to false.
CompatibilityDate string
Compatibility date used for Pages Functions.
CompatibilityFlags List<string>
Compatibility flags used for Pages Functions.
D1Databases Dictionary<string, string>
D1 Databases used for Pages Functions. Defaults to map[].
DurableObjectNamespaces Dictionary<string, string>
Durable Object namespaces used for Pages Functions. Defaults to map[].
EnvironmentVariables Dictionary<string, string>
Environment variables for Pages Functions. Defaults to map[].
FailOpen bool
Fail open used for Pages Functions. Defaults to false.
KvNamespaces Dictionary<string, string>
KV namespaces used for Pages Functions. Defaults to map[].
Placement PagesProjectDeploymentConfigsPreviewPlacement
Configuration for placement in the Cloudflare Pages project.
R2Buckets Dictionary<string, string>
R2 Buckets used for Pages Functions. Defaults to map[].
Secrets Dictionary<string, string>
Encrypted environment variables for Pages Functions. Defaults to map[].
ServiceBindings List<PagesProjectDeploymentConfigsPreviewServiceBinding>
Services used for Pages Functions.
UsageModel string
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.
AlwaysUseLatestCompatibilityDate bool
Use latest compatibility date for Pages Functions. Defaults to false.
CompatibilityDate string
Compatibility date used for Pages Functions.
CompatibilityFlags []string
Compatibility flags used for Pages Functions.
D1Databases map[string]string
D1 Databases used for Pages Functions. Defaults to map[].
DurableObjectNamespaces map[string]string
Durable Object namespaces used for Pages Functions. Defaults to map[].
EnvironmentVariables map[string]string
Environment variables for Pages Functions. Defaults to map[].
FailOpen bool
Fail open used for Pages Functions. Defaults to false.
KvNamespaces map[string]string
KV namespaces used for Pages Functions. Defaults to map[].
Placement PagesProjectDeploymentConfigsPreviewPlacement
Configuration for placement in the Cloudflare Pages project.
R2Buckets map[string]string
R2 Buckets used for Pages Functions. Defaults to map[].
Secrets map[string]string
Encrypted environment variables for Pages Functions. Defaults to map[].
ServiceBindings []PagesProjectDeploymentConfigsPreviewServiceBinding
Services used for Pages Functions.
UsageModel string
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.
alwaysUseLatestCompatibilityDate Boolean
Use latest compatibility date for Pages Functions. Defaults to false.
compatibilityDate String
Compatibility date used for Pages Functions.
compatibilityFlags List<String>
Compatibility flags used for Pages Functions.
d1Databases Map<String,String>
D1 Databases used for Pages Functions. Defaults to map[].
durableObjectNamespaces Map<String,String>
Durable Object namespaces used for Pages Functions. Defaults to map[].
environmentVariables Map<String,String>
Environment variables for Pages Functions. Defaults to map[].
failOpen Boolean
Fail open used for Pages Functions. Defaults to false.
kvNamespaces Map<String,String>
KV namespaces used for Pages Functions. Defaults to map[].
placement PagesProjectDeploymentConfigsPreviewPlacement
Configuration for placement in the Cloudflare Pages project.
r2Buckets Map<String,String>
R2 Buckets used for Pages Functions. Defaults to map[].
secrets Map<String,String>
Encrypted environment variables for Pages Functions. Defaults to map[].
serviceBindings List<PagesProjectDeploymentConfigsPreviewServiceBinding>
Services used for Pages Functions.
usageModel String
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.
alwaysUseLatestCompatibilityDate boolean
Use latest compatibility date for Pages Functions. Defaults to false.
compatibilityDate string
Compatibility date used for Pages Functions.
compatibilityFlags string[]
Compatibility flags used for Pages Functions.
d1Databases {[key: string]: string}
D1 Databases used for Pages Functions. Defaults to map[].
durableObjectNamespaces {[key: string]: string}
Durable Object namespaces used for Pages Functions. Defaults to map[].
environmentVariables {[key: string]: string}
Environment variables for Pages Functions. Defaults to map[].
failOpen boolean
Fail open used for Pages Functions. Defaults to false.
kvNamespaces {[key: string]: string}
KV namespaces used for Pages Functions. Defaults to map[].
placement PagesProjectDeploymentConfigsPreviewPlacement
Configuration for placement in the Cloudflare Pages project.
r2Buckets {[key: string]: string}
R2 Buckets used for Pages Functions. Defaults to map[].
secrets {[key: string]: string}
Encrypted environment variables for Pages Functions. Defaults to map[].
serviceBindings PagesProjectDeploymentConfigsPreviewServiceBinding[]
Services used for Pages Functions.
usageModel string
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.
always_use_latest_compatibility_date bool
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, str]
D1 Databases used for Pages Functions. Defaults to map[].
durable_object_namespaces Mapping[str, str]
Durable Object namespaces used for Pages Functions. Defaults to map[].
environment_variables Mapping[str, str]
Environment variables for Pages Functions. Defaults to map[].
fail_open bool
Fail open used for Pages Functions. Defaults to false.
kv_namespaces Mapping[str, str]
KV namespaces used for Pages Functions. Defaults to map[].
placement PagesProjectDeploymentConfigsPreviewPlacement
Configuration for placement in the Cloudflare Pages project.
r2_buckets Mapping[str, str]
R2 Buckets used for Pages Functions. Defaults to map[].
secrets Mapping[str, str]
Encrypted environment variables for Pages Functions. Defaults to map[].
service_bindings Sequence[PagesProjectDeploymentConfigsPreviewServiceBinding]
Services used for Pages Functions.
usage_model str
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.
alwaysUseLatestCompatibilityDate Boolean
Use latest compatibility date for Pages Functions. Defaults to false.
compatibilityDate String
Compatibility date used for Pages Functions.
compatibilityFlags List<String>
Compatibility flags used for Pages Functions.
d1Databases Map<String>
D1 Databases used for Pages Functions. Defaults to map[].
durableObjectNamespaces Map<String>
Durable Object namespaces used for Pages Functions. Defaults to map[].
environmentVariables Map<String>
Environment variables for Pages Functions. Defaults to map[].
failOpen Boolean
Fail open used for Pages Functions. Defaults to false.
kvNamespaces Map<String>
KV namespaces used for Pages Functions. Defaults to map[].
placement Property Map
Configuration for placement in the Cloudflare Pages project.
r2Buckets Map<String>
R2 Buckets used for Pages Functions. Defaults to map[].
secrets Map<String>
Encrypted environment variables for Pages Functions. Defaults to map[].
serviceBindings List<Property Map>
Services used for Pages Functions.
usageModel String
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.

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 This property is required. string
The global variable for the binding in your Worker code.
Service This property is required. string
The name of the Worker to bind to.
Environment string
The name of the Worker environment to bind to.
Name This property is required. string
The global variable for the binding in your Worker code.
Service This property is required. string
The name of the Worker to bind to.
Environment string
The name of the Worker environment to bind to.
name This property is required. String
The global variable for the binding in your Worker code.
service This property is required. String
The name of the Worker to bind to.
environment String
The name of the Worker environment to bind to.
name This property is required. string
The global variable for the binding in your Worker code.
service This property is required. string
The name of the Worker to bind to.
environment string
The name of the Worker environment to bind to.
name This property is required. str
The global variable for the binding in your Worker code.
service This property is required. str
The name of the Worker to bind to.
environment str
The name of the Worker environment to bind to.
name This property is required. String
The global variable for the binding in your Worker code.
service This property is required. String
The name of the Worker to bind to.
environment String
The name of the Worker environment to bind to.

PagesProjectDeploymentConfigsProduction
, PagesProjectDeploymentConfigsProductionArgs

AlwaysUseLatestCompatibilityDate bool
Use latest compatibility date for Pages Functions. Defaults to false.
CompatibilityDate string
Compatibility date used for Pages Functions.
CompatibilityFlags List<string>
Compatibility flags used for Pages Functions.
D1Databases Dictionary<string, string>
D1 Databases used for Pages Functions. Defaults to map[].
DurableObjectNamespaces Dictionary<string, string>
Durable Object namespaces used for Pages Functions. Defaults to map[].
EnvironmentVariables Dictionary<string, string>
Environment variables for Pages Functions. Defaults to map[].
FailOpen bool
Fail open used for Pages Functions. Defaults to false.
KvNamespaces Dictionary<string, string>
KV namespaces used for Pages Functions. Defaults to map[].
Placement PagesProjectDeploymentConfigsProductionPlacement
Configuration for placement in the Cloudflare Pages project.
R2Buckets Dictionary<string, string>
R2 Buckets used for Pages Functions. Defaults to map[].
Secrets Dictionary<string, string>
Encrypted environment variables for Pages Functions. Defaults to map[].
ServiceBindings List<PagesProjectDeploymentConfigsProductionServiceBinding>
Services used for Pages Functions.
UsageModel string
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.
AlwaysUseLatestCompatibilityDate bool
Use latest compatibility date for Pages Functions. Defaults to false.
CompatibilityDate string
Compatibility date used for Pages Functions.
CompatibilityFlags []string
Compatibility flags used for Pages Functions.
D1Databases map[string]string
D1 Databases used for Pages Functions. Defaults to map[].
DurableObjectNamespaces map[string]string
Durable Object namespaces used for Pages Functions. Defaults to map[].
EnvironmentVariables map[string]string
Environment variables for Pages Functions. Defaults to map[].
FailOpen bool
Fail open used for Pages Functions. Defaults to false.
KvNamespaces map[string]string
KV namespaces used for Pages Functions. Defaults to map[].
Placement PagesProjectDeploymentConfigsProductionPlacement
Configuration for placement in the Cloudflare Pages project.
R2Buckets map[string]string
R2 Buckets used for Pages Functions. Defaults to map[].
Secrets map[string]string
Encrypted environment variables for Pages Functions. Defaults to map[].
ServiceBindings []PagesProjectDeploymentConfigsProductionServiceBinding
Services used for Pages Functions.
UsageModel string
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.
alwaysUseLatestCompatibilityDate Boolean
Use latest compatibility date for Pages Functions. Defaults to false.
compatibilityDate String
Compatibility date used for Pages Functions.
compatibilityFlags List<String>
Compatibility flags used for Pages Functions.
d1Databases Map<String,String>
D1 Databases used for Pages Functions. Defaults to map[].
durableObjectNamespaces Map<String,String>
Durable Object namespaces used for Pages Functions. Defaults to map[].
environmentVariables Map<String,String>
Environment variables for Pages Functions. Defaults to map[].
failOpen Boolean
Fail open used for Pages Functions. Defaults to false.
kvNamespaces Map<String,String>
KV namespaces used for Pages Functions. Defaults to map[].
placement PagesProjectDeploymentConfigsProductionPlacement
Configuration for placement in the Cloudflare Pages project.
r2Buckets Map<String,String>
R2 Buckets used for Pages Functions. Defaults to map[].
secrets Map<String,String>
Encrypted environment variables for Pages Functions. Defaults to map[].
serviceBindings List<PagesProjectDeploymentConfigsProductionServiceBinding>
Services used for Pages Functions.
usageModel String
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.
alwaysUseLatestCompatibilityDate boolean
Use latest compatibility date for Pages Functions. Defaults to false.
compatibilityDate string
Compatibility date used for Pages Functions.
compatibilityFlags string[]
Compatibility flags used for Pages Functions.
d1Databases {[key: string]: string}
D1 Databases used for Pages Functions. Defaults to map[].
durableObjectNamespaces {[key: string]: string}
Durable Object namespaces used for Pages Functions. Defaults to map[].
environmentVariables {[key: string]: string}
Environment variables for Pages Functions. Defaults to map[].
failOpen boolean
Fail open used for Pages Functions. Defaults to false.
kvNamespaces {[key: string]: string}
KV namespaces used for Pages Functions. Defaults to map[].
placement PagesProjectDeploymentConfigsProductionPlacement
Configuration for placement in the Cloudflare Pages project.
r2Buckets {[key: string]: string}
R2 Buckets used for Pages Functions. Defaults to map[].
secrets {[key: string]: string}
Encrypted environment variables for Pages Functions. Defaults to map[].
serviceBindings PagesProjectDeploymentConfigsProductionServiceBinding[]
Services used for Pages Functions.
usageModel string
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.
always_use_latest_compatibility_date bool
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, str]
D1 Databases used for Pages Functions. Defaults to map[].
durable_object_namespaces Mapping[str, str]
Durable Object namespaces used for Pages Functions. Defaults to map[].
environment_variables Mapping[str, str]
Environment variables for Pages Functions. Defaults to map[].
fail_open bool
Fail open used for Pages Functions. Defaults to false.
kv_namespaces Mapping[str, str]
KV namespaces used for Pages Functions. Defaults to map[].
placement PagesProjectDeploymentConfigsProductionPlacement
Configuration for placement in the Cloudflare Pages project.
r2_buckets Mapping[str, str]
R2 Buckets used for Pages Functions. Defaults to map[].
secrets Mapping[str, str]
Encrypted environment variables for Pages Functions. Defaults to map[].
service_bindings Sequence[PagesProjectDeploymentConfigsProductionServiceBinding]
Services used for Pages Functions.
usage_model str
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.
alwaysUseLatestCompatibilityDate Boolean
Use latest compatibility date for Pages Functions. Defaults to false.
compatibilityDate String
Compatibility date used for Pages Functions.
compatibilityFlags List<String>
Compatibility flags used for Pages Functions.
d1Databases Map<String>
D1 Databases used for Pages Functions. Defaults to map[].
durableObjectNamespaces Map<String>
Durable Object namespaces used for Pages Functions. Defaults to map[].
environmentVariables Map<String>
Environment variables for Pages Functions. Defaults to map[].
failOpen Boolean
Fail open used for Pages Functions. Defaults to false.
kvNamespaces Map<String>
KV namespaces used for Pages Functions. Defaults to map[].
placement Property Map
Configuration for placement in the Cloudflare Pages project.
r2Buckets Map<String>
R2 Buckets used for Pages Functions. Defaults to map[].
secrets Map<String>
Encrypted environment variables for Pages Functions. Defaults to map[].
serviceBindings List<Property Map>
Services used for Pages Functions.
usageModel String
Usage model used for Pages Functions. Available values: unbound, bundled, standard. Defaults to bundled.

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 This property is required. string
The global variable for the binding in your Worker code.
Service This property is required. string
The name of the Worker to bind to.
Environment string
The name of the Worker environment to bind to.
Name This property is required. string
The global variable for the binding in your Worker code.
Service This property is required. string
The name of the Worker to bind to.
Environment string
The name of the Worker environment to bind to.
name This property is required. String
The global variable for the binding in your Worker code.
service This property is required. String
The name of the Worker to bind to.
environment String
The name of the Worker environment to bind to.
name This property is required. string
The global variable for the binding in your Worker code.
service This property is required. string
The name of the Worker to bind to.
environment string
The name of the Worker environment to bind to.
name This property is required. str
The global variable for the binding in your Worker code.
service This property is required. str
The name of the Worker to bind to.
environment str
The name of the Worker environment to bind to.
name This property is required. String
The global variable for the binding in your Worker code.
service This property is required. String
The name of the Worker to bind to.
environment String
The name of the Worker environment to bind to.

PagesProjectSource
, PagesProjectSourceArgs

Config PagesProjectSourceConfig
Configuration for the source of the Cloudflare Pages project.
Type string
Project host type.
Config PagesProjectSourceConfig
Configuration for the source of the Cloudflare Pages project.
Type string
Project host type.
config PagesProjectSourceConfig
Configuration for the source of the Cloudflare Pages project.
type String
Project host type.
config PagesProjectSourceConfig
Configuration for the source of the Cloudflare Pages project.
type string
Project host type.
config PagesProjectSourceConfig
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

ProductionBranch This property is required. string
Project production branch name.
DeploymentsEnabled bool
Toggle deployments on this repo. Defaults to true.
Owner Changes to this property will trigger replacement. string
Project owner username. Modifying this attribute will force creation of a new resource.
PrCommentsEnabled bool
Enable Pages to comment on Pull Requests. Defaults to true.
PreviewBranchExcludes List<string>
Branches will be excluded from automatic deployment.
PreviewBranchIncludes List<string>
Branches will be included for automatic deployment.
PreviewDeploymentSetting string
Preview Deployment Setting. Available values: custom, all, none. Defaults to all.
ProductionDeploymentEnabled bool
Enable production deployments. Defaults to true.
RepoName Changes to this property will trigger replacement. string
Project repository name. Modifying this attribute will force creation of a new resource.
ProductionBranch This property is required. string
Project production branch name.
DeploymentsEnabled bool
Toggle deployments on this repo. Defaults to true.
Owner Changes to this property will trigger replacement. string
Project owner username. Modifying this attribute will force creation of a new resource.
PrCommentsEnabled bool
Enable Pages to comment on Pull Requests. Defaults to true.
PreviewBranchExcludes []string
Branches will be excluded from automatic deployment.
PreviewBranchIncludes []string
Branches will be included for automatic deployment.
PreviewDeploymentSetting string
Preview Deployment Setting. Available values: custom, all, none. Defaults to all.
ProductionDeploymentEnabled bool
Enable production deployments. Defaults to true.
RepoName Changes to this property will trigger replacement. string
Project repository name. Modifying this attribute will force creation of a new resource.
productionBranch This property is required. String
Project production branch name.
deploymentsEnabled Boolean
Toggle deployments on this repo. Defaults to true.
owner Changes to this property will trigger replacement. String
Project owner username. Modifying this attribute will force creation of a new resource.
prCommentsEnabled Boolean
Enable Pages to comment on Pull Requests. Defaults to true.
previewBranchExcludes List<String>
Branches will be excluded from automatic deployment.
previewBranchIncludes List<String>
Branches will be included for automatic deployment.
previewDeploymentSetting String
Preview Deployment Setting. Available values: custom, all, none. Defaults to all.
productionDeploymentEnabled Boolean
Enable production deployments. Defaults to true.
repoName Changes to this property will trigger replacement. String
Project repository name. Modifying this attribute will force creation of a new resource.
productionBranch This property is required. string
Project production branch name.
deploymentsEnabled boolean
Toggle deployments on this repo. Defaults to true.
owner Changes to this property will trigger replacement. string
Project owner username. Modifying this attribute will force creation of a new resource.
prCommentsEnabled boolean
Enable Pages to comment on Pull Requests. Defaults to true.
previewBranchExcludes string[]
Branches will be excluded from automatic deployment.
previewBranchIncludes string[]
Branches will be included for automatic deployment.
previewDeploymentSetting string
Preview Deployment Setting. Available values: custom, all, none. Defaults to all.
productionDeploymentEnabled boolean
Enable production deployments. Defaults to true.
repoName Changes to this property will trigger replacement. string
Project repository name. Modifying this attribute will force creation of a new resource.
production_branch This property is required. str
Project production branch name.
deployments_enabled bool
Toggle deployments on this repo. Defaults to true.
owner Changes to this property will trigger replacement. str
Project owner username. Modifying this attribute will force creation of a new resource.
pr_comments_enabled bool
Enable Pages to comment on Pull Requests. Defaults to true.
preview_branch_excludes Sequence[str]
Branches will be excluded from automatic deployment.
preview_branch_includes Sequence[str]
Branches will be included for automatic deployment.
preview_deployment_setting str
Preview Deployment Setting. Available values: custom, all, none. Defaults to all.
production_deployment_enabled bool
Enable production deployments. Defaults to true.
repo_name Changes to this property will trigger replacement. str
Project repository name. Modifying this attribute will force creation of a new resource.
productionBranch This property is required. String
Project production branch name.
deploymentsEnabled Boolean
Toggle deployments on this repo. Defaults to true.
owner Changes to this property will trigger replacement. String
Project owner username. Modifying this attribute will force creation of a new resource.
prCommentsEnabled Boolean
Enable Pages to comment on Pull Requests. Defaults to true.
previewBranchExcludes List<String>
Branches will be excluded from automatic deployment.
previewBranchIncludes List<String>
Branches will be included for automatic deployment.
previewDeploymentSetting String
Preview Deployment Setting. Available values: custom, all, none. Defaults to all.
productionDeploymentEnabled Boolean
Enable production deployments. Defaults to true.
repoName Changes to this property will trigger replacement. 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>
Copy

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.
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare