1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. PagesDomain
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.PagesDomain

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

    A DNS record for the domain is not automatically created. You need to create a cloudflare_record resource for the domain you want to use.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const examplePagesDomain = new cloudflare.PagesDomain("example_pages_domain", {
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
        projectName: "this-is-my-project-01",
        name: "example.com",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_pages_domain = cloudflare.PagesDomain("example_pages_domain",
        account_id="023e105f4ecef8ad9ca31a8372d0c353",
        project_name="this-is-my-project-01",
        name="example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.NewPagesDomain(ctx, "example_pages_domain", &cloudflare.PagesDomainArgs{
    			AccountId:   pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    			ProjectName: pulumi.String("this-is-my-project-01"),
    			Name:        pulumi.String("example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var examplePagesDomain = new Cloudflare.PagesDomain("example_pages_domain", new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
            ProjectName = "this-is-my-project-01",
            Name = "example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.PagesDomain;
    import com.pulumi.cloudflare.PagesDomainArgs;
    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) {
            var examplePagesDomain = new PagesDomain("examplePagesDomain", PagesDomainArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .projectName("this-is-my-project-01")
                .name("example.com")
                .build());
    
        }
    }
    
    resources:
      examplePagesDomain:
        type: cloudflare:PagesDomain
        name: example_pages_domain
        properties:
          accountId: 023e105f4ecef8ad9ca31a8372d0c353
          projectName: this-is-my-project-01
          name: example.com
    

    Create PagesDomain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PagesDomain(name: string, args: PagesDomainArgs, opts?: CustomResourceOptions);
    @overload
    def PagesDomain(resource_name: str,
                    args: PagesDomainArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def PagesDomain(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    account_id: Optional[str] = None,
                    name: Optional[str] = None,
                    project_name: Optional[str] = None)
    func NewPagesDomain(ctx *Context, name string, args PagesDomainArgs, opts ...ResourceOption) (*PagesDomain, error)
    public PagesDomain(string name, PagesDomainArgs args, CustomResourceOptions? opts = null)
    public PagesDomain(String name, PagesDomainArgs args)
    public PagesDomain(String name, PagesDomainArgs args, CustomResourceOptions options)
    
    type: cloudflare:PagesDomain
    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 PagesDomainArgs
    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 PagesDomainArgs
    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 PagesDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PagesDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PagesDomainArgs
    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 pagesDomainResource = new Cloudflare.PagesDomain("pagesDomainResource", new()
    {
        AccountId = "string",
        Name = "string",
        ProjectName = "string",
    });
    
    example, err := cloudflare.NewPagesDomain(ctx, "pagesDomainResource", &cloudflare.PagesDomainArgs{
    	AccountId:   pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	ProjectName: pulumi.String("string"),
    })
    
    var pagesDomainResource = new PagesDomain("pagesDomainResource", PagesDomainArgs.builder()
        .accountId("string")
        .name("string")
        .projectName("string")
        .build());
    
    pages_domain_resource = cloudflare.PagesDomain("pagesDomainResource",
        account_id="string",
        name="string",
        project_name="string")
    
    const pagesDomainResource = new cloudflare.PagesDomain("pagesDomainResource", {
        accountId: "string",
        name: "string",
        projectName: "string",
    });
    
    type: cloudflare:PagesDomain
    properties:
        accountId: string
        name: string
        projectName: string
    

    PagesDomain 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 PagesDomain resource accepts the following input properties:

    AccountId string
    Identifier
    Name string
    ProjectName string
    Name of the project.
    AccountId string
    Identifier
    Name string
    ProjectName string
    Name of the project.
    accountId String
    Identifier
    name String
    projectName String
    Name of the project.
    accountId string
    Identifier
    name string
    projectName string
    Name of the project.
    account_id str
    Identifier
    name str
    project_name str
    Name of the project.
    accountId String
    Identifier
    name String
    projectName String
    Name of the project.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PagesDomain resource produces the following output properties:

    CertificateAuthority string
    Available values: "google", "lets_encrypt".
    CreatedOn string
    DomainId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    ValidationData PagesDomainValidationData
    VerificationData PagesDomainVerificationData
    ZoneTag string
    CertificateAuthority string
    Available values: "google", "lets_encrypt".
    CreatedOn string
    DomainId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    ValidationData PagesDomainValidationData
    VerificationData PagesDomainVerificationData
    ZoneTag string
    certificateAuthority String
    Available values: "google", "lets_encrypt".
    createdOn String
    domainId String
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    validationData PagesDomainValidationData
    verificationData PagesDomainVerificationData
    zoneTag String
    certificateAuthority string
    Available values: "google", "lets_encrypt".
    createdOn string
    domainId string
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    validationData PagesDomainValidationData
    verificationData PagesDomainVerificationData
    zoneTag string
    certificate_authority str
    Available values: "google", "lets_encrypt".
    created_on str
    domain_id str
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    validation_data PagesDomainValidationData
    verification_data PagesDomainVerificationData
    zone_tag str
    certificateAuthority String
    Available values: "google", "lets_encrypt".
    createdOn String
    domainId String
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    validationData Property Map
    verificationData Property Map
    zoneTag String

    Look up Existing PagesDomain Resource

    Get an existing PagesDomain 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?: PagesDomainState, opts?: CustomResourceOptions): PagesDomain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            certificate_authority: Optional[str] = None,
            created_on: Optional[str] = None,
            domain_id: Optional[str] = None,
            name: Optional[str] = None,
            project_name: Optional[str] = None,
            status: Optional[str] = None,
            validation_data: Optional[PagesDomainValidationDataArgs] = None,
            verification_data: Optional[PagesDomainVerificationDataArgs] = None,
            zone_tag: Optional[str] = None) -> PagesDomain
    func GetPagesDomain(ctx *Context, name string, id IDInput, state *PagesDomainState, opts ...ResourceOption) (*PagesDomain, error)
    public static PagesDomain Get(string name, Input<string> id, PagesDomainState? state, CustomResourceOptions? opts = null)
    public static PagesDomain get(String name, Output<String> id, PagesDomainState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:PagesDomain    get:      id: ${id}
    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.
    The following state arguments are supported:
    AccountId string
    Identifier
    CertificateAuthority string
    Available values: "google", "lets_encrypt".
    CreatedOn string
    DomainId string
    Name string
    ProjectName string
    Name of the project.
    Status string
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    ValidationData PagesDomainValidationData
    VerificationData PagesDomainVerificationData
    ZoneTag string
    AccountId string
    Identifier
    CertificateAuthority string
    Available values: "google", "lets_encrypt".
    CreatedOn string
    DomainId string
    Name string
    ProjectName string
    Name of the project.
    Status string
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    ValidationData PagesDomainValidationDataArgs
    VerificationData PagesDomainVerificationDataArgs
    ZoneTag string
    accountId String
    Identifier
    certificateAuthority String
    Available values: "google", "lets_encrypt".
    createdOn String
    domainId String
    name String
    projectName String
    Name of the project.
    status String
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    validationData PagesDomainValidationData
    verificationData PagesDomainVerificationData
    zoneTag String
    accountId string
    Identifier
    certificateAuthority string
    Available values: "google", "lets_encrypt".
    createdOn string
    domainId string
    name string
    projectName string
    Name of the project.
    status string
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    validationData PagesDomainValidationData
    verificationData PagesDomainVerificationData
    zoneTag string
    account_id str
    Identifier
    certificate_authority str
    Available values: "google", "lets_encrypt".
    created_on str
    domain_id str
    name str
    project_name str
    Name of the project.
    status str
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    validation_data PagesDomainValidationDataArgs
    verification_data PagesDomainVerificationDataArgs
    zone_tag str
    accountId String
    Identifier
    certificateAuthority String
    Available values: "google", "lets_encrypt".
    createdOn String
    domainId String
    name String
    projectName String
    Name of the project.
    status String
    Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
    validationData Property Map
    verificationData Property Map
    zoneTag String

    Supporting Types

    PagesDomainValidationData, PagesDomainValidationDataArgs

    ErrorMessage string
    Method string
    Available values: "http", "txt".
    Status string
    Available values: "initializing", "pending", "active", "deactivated", "error".
    TxtName string
    TxtValue string
    ErrorMessage string
    Method string
    Available values: "http", "txt".
    Status string
    Available values: "initializing", "pending", "active", "deactivated", "error".
    TxtName string
    TxtValue string
    errorMessage String
    method String
    Available values: "http", "txt".
    status String
    Available values: "initializing", "pending", "active", "deactivated", "error".
    txtName String
    txtValue String
    errorMessage string
    method string
    Available values: "http", "txt".
    status string
    Available values: "initializing", "pending", "active", "deactivated", "error".
    txtName string
    txtValue string
    error_message str
    method str
    Available values: "http", "txt".
    status str
    Available values: "initializing", "pending", "active", "deactivated", "error".
    txt_name str
    txt_value str
    errorMessage String
    method String
    Available values: "http", "txt".
    status String
    Available values: "initializing", "pending", "active", "deactivated", "error".
    txtName String
    txtValue String

    PagesDomainVerificationData, PagesDomainVerificationDataArgs

    ErrorMessage string
    Status string
    Available values: "pending", "active", "deactivated", "blocked", "error".
    ErrorMessage string
    Status string
    Available values: "pending", "active", "deactivated", "blocked", "error".
    errorMessage String
    status String
    Available values: "pending", "active", "deactivated", "blocked", "error".
    errorMessage string
    status string
    Available values: "pending", "active", "deactivated", "blocked", "error".
    error_message str
    status str
    Available values: "pending", "active", "deactivated", "blocked", "error".
    errorMessage String
    status String
    Available values: "pending", "active", "deactivated", "blocked", "error".

    Import

    $ pulumi import cloudflare:index/pagesDomain:PagesDomain example '<account_id>/<project_name>/<domain_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.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi