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

cloudflare.getPagesProjects

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const examplePagesProjects = cloudflare.getPagesProjects({
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_pages_projects = cloudflare.get_pages_projects(account_id="023e105f4ecef8ad9ca31a8372d0c353")
    
    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.LookupPagesProjects(ctx, &cloudflare.LookupPagesProjectsArgs{
    			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
    		}, nil)
    		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 examplePagesProjects = Cloudflare.GetPagesProjects.Invoke(new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CloudflareFunctions;
    import com.pulumi.cloudflare.inputs.GetPagesProjectsArgs;
    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) {
            final var examplePagesProjects = CloudflareFunctions.getPagesProjects(GetPagesProjectsArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .build());
    
        }
    }
    
    variables:
      examplePagesProjects:
        fn::invoke:
          function: cloudflare:getPagesProjects
          arguments:
            accountId: 023e105f4ecef8ad9ca31a8372d0c353
    

    Using getPagesProjects

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPagesProjects(args: GetPagesProjectsArgs, opts?: InvokeOptions): Promise<GetPagesProjectsResult>
    function getPagesProjectsOutput(args: GetPagesProjectsOutputArgs, opts?: InvokeOptions): Output<GetPagesProjectsResult>
    def get_pages_projects(account_id: Optional[str] = None,
                           max_items: Optional[int] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPagesProjectsResult
    def get_pages_projects_output(account_id: Optional[pulumi.Input[str]] = None,
                           max_items: Optional[pulumi.Input[int]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPagesProjectsResult]
    func LookupPagesProjects(ctx *Context, args *LookupPagesProjectsArgs, opts ...InvokeOption) (*LookupPagesProjectsResult, error)
    func LookupPagesProjectsOutput(ctx *Context, args *LookupPagesProjectsOutputArgs, opts ...InvokeOption) LookupPagesProjectsResultOutput

    > Note: This function is named LookupPagesProjects in the Go SDK.

    public static class GetPagesProjects 
    {
        public static Task<GetPagesProjectsResult> InvokeAsync(GetPagesProjectsArgs args, InvokeOptions? opts = null)
        public static Output<GetPagesProjectsResult> Invoke(GetPagesProjectsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPagesProjectsResult> getPagesProjects(GetPagesProjectsArgs args, InvokeOptions options)
    public static Output<GetPagesProjectsResult> getPagesProjects(GetPagesProjectsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getPagesProjects:getPagesProjects
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    Identifier
    MaxItems int
    Max items to fetch, default: 1000
    AccountId string
    Identifier
    MaxItems int
    Max items to fetch, default: 1000
    accountId String
    Identifier
    maxItems Integer
    Max items to fetch, default: 1000
    accountId string
    Identifier
    maxItems number
    Max items to fetch, default: 1000
    account_id str
    Identifier
    max_items int
    Max items to fetch, default: 1000
    accountId String
    Identifier
    maxItems Number
    Max items to fetch, default: 1000

    getPagesProjects Result

    The following output properties are available:

    AccountId string
    Identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    Results List<GetPagesProjectsResult>
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    AccountId string
    Identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    Results []GetPagesProjectsResult
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    accountId String
    Identifier
    id String
    The provider-assigned unique ID for this managed resource.
    results List<GetPagesProjectsResult>
    The items returned by the data source
    maxItems Integer
    Max items to fetch, default: 1000
    accountId string
    Identifier
    id string
    The provider-assigned unique ID for this managed resource.
    results GetPagesProjectsResult[]
    The items returned by the data source
    maxItems number
    Max items to fetch, default: 1000
    account_id str
    Identifier
    id str
    The provider-assigned unique ID for this managed resource.
    results Sequence[GetPagesProjectsResult]
    The items returned by the data source
    max_items int
    Max items to fetch, default: 1000
    accountId String
    Identifier
    id String
    The provider-assigned unique ID for this managed resource.
    results List<Property Map>
    The items returned by the data source
    maxItems Number
    Max items to fetch, default: 1000

    Supporting Types

    GetPagesProjectsResult

    Aliases List<string>
    A list of alias URLs pointing to this deployment.
    BuildConfig GetPagesProjectsResultBuildConfig
    Configs for the project build process.
    CreatedOn string
    When the deployment was created.
    DeploymentTrigger GetPagesProjectsResultDeploymentTrigger
    Info about what caused the deployment.
    EnvVars Dictionary<string, GetPagesProjectsResultEnvVars>
    Environment variables used for builds and Pages Functions.
    Environment string
    Type of deploy. Available values: "preview", "production".
    Id string
    Id of the deployment.
    IsSkipped bool
    If the deployment has been skipped.
    LatestStage GetPagesProjectsResultLatestStage
    The status of the deployment.
    ModifiedOn string
    When the deployment was last modified.
    ProjectId string
    Id of the project.
    ProjectName string
    Name of the project.
    ShortId string
    Short Id (8 character) of the deployment.
    Source GetPagesProjectsResultSource
    Stages List<GetPagesProjectsResultStage>
    List of past stages.
    Url string
    The live URL to view this deployment.
    Aliases []string
    A list of alias URLs pointing to this deployment.
    BuildConfig GetPagesProjectsResultBuildConfig
    Configs for the project build process.
    CreatedOn string
    When the deployment was created.
    DeploymentTrigger GetPagesProjectsResultDeploymentTrigger
    Info about what caused the deployment.
    EnvVars map[string]GetPagesProjectsResultEnvVars
    Environment variables used for builds and Pages Functions.
    Environment string
    Type of deploy. Available values: "preview", "production".
    Id string
    Id of the deployment.
    IsSkipped bool
    If the deployment has been skipped.
    LatestStage GetPagesProjectsResultLatestStage
    The status of the deployment.
    ModifiedOn string
    When the deployment was last modified.
    ProjectId string
    Id of the project.
    ProjectName string
    Name of the project.
    ShortId string
    Short Id (8 character) of the deployment.
    Source GetPagesProjectsResultSource
    Stages []GetPagesProjectsResultStage
    List of past stages.
    Url string
    The live URL to view this deployment.
    aliases List<String>
    A list of alias URLs pointing to this deployment.
    buildConfig GetPagesProjectsResultBuildConfig
    Configs for the project build process.
    createdOn String
    When the deployment was created.
    deploymentTrigger GetPagesProjectsResultDeploymentTrigger
    Info about what caused the deployment.
    envVars Map<String,GetPagesProjectsResultEnvVars>
    Environment variables used for builds and Pages Functions.
    environment String
    Type of deploy. Available values: "preview", "production".
    id String
    Id of the deployment.
    isSkipped Boolean
    If the deployment has been skipped.
    latestStage GetPagesProjectsResultLatestStage
    The status of the deployment.
    modifiedOn String
    When the deployment was last modified.
    projectId String
    Id of the project.
    projectName String
    Name of the project.
    shortId String
    Short Id (8 character) of the deployment.
    source GetPagesProjectsResultSource
    stages List<GetPagesProjectsResultStage>
    List of past stages.
    url String
    The live URL to view this deployment.
    aliases string[]
    A list of alias URLs pointing to this deployment.
    buildConfig GetPagesProjectsResultBuildConfig
    Configs for the project build process.
    createdOn string
    When the deployment was created.
    deploymentTrigger GetPagesProjectsResultDeploymentTrigger
    Info about what caused the deployment.
    envVars {[key: string]: GetPagesProjectsResultEnvVars}
    Environment variables used for builds and Pages Functions.
    environment string
    Type of deploy. Available values: "preview", "production".
    id string
    Id of the deployment.
    isSkipped boolean
    If the deployment has been skipped.
    latestStage GetPagesProjectsResultLatestStage
    The status of the deployment.
    modifiedOn string
    When the deployment was last modified.
    projectId string
    Id of the project.
    projectName string
    Name of the project.
    shortId string
    Short Id (8 character) of the deployment.
    source GetPagesProjectsResultSource
    stages GetPagesProjectsResultStage[]
    List of past stages.
    url string
    The live URL to view this deployment.
    aliases Sequence[str]
    A list of alias URLs pointing to this deployment.
    build_config GetPagesProjectsResultBuildConfig
    Configs for the project build process.
    created_on str
    When the deployment was created.
    deployment_trigger GetPagesProjectsResultDeploymentTrigger
    Info about what caused the deployment.
    env_vars Mapping[str, GetPagesProjectsResultEnvVars]
    Environment variables used for builds and Pages Functions.
    environment str
    Type of deploy. Available values: "preview", "production".
    id str
    Id of the deployment.
    is_skipped bool
    If the deployment has been skipped.
    latest_stage GetPagesProjectsResultLatestStage
    The status of the deployment.
    modified_on str
    When the deployment was last modified.
    project_id str
    Id of the project.
    project_name str
    Name of the project.
    short_id str
    Short Id (8 character) of the deployment.
    source GetPagesProjectsResultSource
    stages Sequence[GetPagesProjectsResultStage]
    List of past stages.
    url str
    The live URL to view this deployment.
    aliases List<String>
    A list of alias URLs pointing to this deployment.
    buildConfig Property Map
    Configs for the project build process.
    createdOn String
    When the deployment was created.
    deploymentTrigger Property Map
    Info about what caused the deployment.
    envVars Map<Property Map>
    Environment variables used for builds and Pages Functions.
    environment String
    Type of deploy. Available values: "preview", "production".
    id String
    Id of the deployment.
    isSkipped Boolean
    If the deployment has been skipped.
    latestStage Property Map
    The status of the deployment.
    modifiedOn String
    When the deployment was last modified.
    projectId String
    Id of the project.
    projectName String
    Name of the project.
    shortId String
    Short Id (8 character) of the deployment.
    source Property Map
    stages List<Property Map>
    List of past stages.
    url String
    The live URL to view this deployment.

    GetPagesProjectsResultBuildConfig

    BuildCaching bool
    Enable build caching for the project.
    BuildCommand string
    Command used to build project.
    DestinationDir string
    Output directory of the build.
    RootDir string
    Directory to run the command.
    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
    Directory to run the command.
    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
    Directory to run the command.
    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
    Directory to run the command.
    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
    Directory to run the command.
    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
    Directory to run the command.
    webAnalyticsTag String
    The classifying tag for analytics.
    webAnalyticsToken String
    The auth token for analytics.

    GetPagesProjectsResultDeploymentTrigger

    Metadata GetPagesProjectsResultDeploymentTriggerMetadata
    Additional info about the trigger.
    Type string
    What caused the deployment. Available values: "push", "ad_hoc".
    Metadata GetPagesProjectsResultDeploymentTriggerMetadata
    Additional info about the trigger.
    Type string
    What caused the deployment. Available values: "push", "ad_hoc".
    metadata GetPagesProjectsResultDeploymentTriggerMetadata
    Additional info about the trigger.
    type String
    What caused the deployment. Available values: "push", "ad_hoc".
    metadata GetPagesProjectsResultDeploymentTriggerMetadata
    Additional info about the trigger.
    type string
    What caused the deployment. Available values: "push", "ad_hoc".
    metadata GetPagesProjectsResultDeploymentTriggerMetadata
    Additional info about the trigger.
    type str
    What caused the deployment. Available values: "push", "ad_hoc".
    metadata Property Map
    Additional info about the trigger.
    type String
    What caused the deployment. Available values: "push", "ad_hoc".

    GetPagesProjectsResultDeploymentTriggerMetadata

    Branch string
    Where the trigger happened.
    CommitHash string
    Hash of the deployment trigger commit.
    CommitMessage string
    Message of the deployment trigger commit.
    Branch string
    Where the trigger happened.
    CommitHash string
    Hash of the deployment trigger commit.
    CommitMessage string
    Message of the deployment trigger commit.
    branch String
    Where the trigger happened.
    commitHash String
    Hash of the deployment trigger commit.
    commitMessage String
    Message of the deployment trigger commit.
    branch string
    Where the trigger happened.
    commitHash string
    Hash of the deployment trigger commit.
    commitMessage string
    Message of the deployment trigger commit.
    branch str
    Where the trigger happened.
    commit_hash str
    Hash of the deployment trigger commit.
    commit_message str
    Message of the deployment trigger commit.
    branch String
    Where the trigger happened.
    commitHash String
    Hash of the deployment trigger commit.
    commitMessage String
    Message of the deployment trigger commit.

    GetPagesProjectsResultEnvVars

    Type string
    Available values: "plain_text".
    Value string
    Environment variable value.
    Type string
    Available values: "plain_text".
    Value string
    Environment variable value.
    type String
    Available values: "plain_text".
    value String
    Environment variable value.
    type string
    Available values: "plain_text".
    value string
    Environment variable value.
    type str
    Available values: "plain_text".
    value str
    Environment variable value.
    type String
    Available values: "plain_text".
    value String
    Environment variable value.

    GetPagesProjectsResultLatestStage

    EndedOn string
    When the stage ended.
    Name string
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    StartedOn string
    When the stage started.
    Status string
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".
    EndedOn string
    When the stage ended.
    Name string
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    StartedOn string
    When the stage started.
    Status string
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".
    endedOn String
    When the stage ended.
    name String
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    startedOn String
    When the stage started.
    status String
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".
    endedOn string
    When the stage ended.
    name string
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    startedOn string
    When the stage started.
    status string
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".
    ended_on str
    When the stage ended.
    name str
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    started_on str
    When the stage started.
    status str
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".
    endedOn String
    When the stage ended.
    name String
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    startedOn String
    When the stage started.
    status String
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".

    GetPagesProjectsResultSource

    GetPagesProjectsResultSourceConfig

    DeploymentsEnabled bool
    Owner string
    PathExcludes List<string>
    PathIncludes List<string>
    PrCommentsEnabled bool
    PreviewBranchExcludes List<string>
    PreviewBranchIncludes List<string>
    PreviewDeploymentSetting string
    Available values: "all", "none", "custom".
    ProductionBranch string
    ProductionDeploymentsEnabled bool
    RepoName string
    deploymentsEnabled Boolean
    owner String
    pathExcludes List<String>
    pathIncludes List<String>
    prCommentsEnabled Boolean
    previewBranchExcludes List<String>
    previewBranchIncludes List<String>
    previewDeploymentSetting String
    Available values: "all", "none", "custom".
    productionBranch String
    productionDeploymentsEnabled Boolean
    repoName String
    deploymentsEnabled boolean
    owner string
    pathExcludes string[]
    pathIncludes string[]
    prCommentsEnabled boolean
    previewBranchExcludes string[]
    previewBranchIncludes string[]
    previewDeploymentSetting string
    Available values: "all", "none", "custom".
    productionBranch string
    productionDeploymentsEnabled boolean
    repoName string
    deploymentsEnabled Boolean
    owner String
    pathExcludes List<String>
    pathIncludes List<String>
    prCommentsEnabled Boolean
    previewBranchExcludes List<String>
    previewBranchIncludes List<String>
    previewDeploymentSetting String
    Available values: "all", "none", "custom".
    productionBranch String
    productionDeploymentsEnabled Boolean
    repoName String

    GetPagesProjectsResultStage

    EndedOn string
    When the stage ended.
    Name string
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    StartedOn string
    When the stage started.
    Status string
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".
    EndedOn string
    When the stage ended.
    Name string
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    StartedOn string
    When the stage started.
    Status string
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".
    endedOn String
    When the stage ended.
    name String
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    startedOn String
    When the stage started.
    status String
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".
    endedOn string
    When the stage ended.
    name string
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    startedOn string
    When the stage started.
    status string
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".
    ended_on str
    When the stage ended.
    name str
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    started_on str
    When the stage started.
    status str
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".
    endedOn String
    When the stage ended.
    name String
    The current build stage. Available values: "queued", "initialize", "clone_repo", "build", "deploy".
    startedOn String
    When the stage started.
    status String
    State of the current stage. Available values: "success", "idle", "active", "failure", "canceled".

    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