GradientEdge CDK Utils
    Preparing search index...

    Interface CloudflarePagesStaticSiteProps

    Properties for the CloudflarePagesStaticSite construct

    interface CloudflarePagesStaticSiteProps {
        accountId: string;
        apiToken: string;
        debug?: boolean;
        domainName: string;
        extraContexts?: string[];
        name: string;
        regionContextPath?: string;
        resourceGroupName?: string;
        siteAssetDir: string;
        siteBranch?: string;
        siteCnameRecord?: DnsRecordProps;
        siteDeployMessage: string;
        sitePagesProject: PagesProjectProps;
        siteSubDomain: string;
        siteZone: ZoneProps;
        skipStageForARecords?: boolean;
        stage: string;
        stageContextPath?: string;
        stageRegionContextPath?: string;
        subDomain?: string;
        useExistingZone?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accountId apiToken debug? domainName extraContexts? name regionContextPath? resourceGroupName? siteAssetDir siteBranch? siteCnameRecord? siteDeployMessage sitePagesProject siteSubDomain siteZone skipStageForARecords? stage stageContextPath? stageRegionContextPath? subDomain? useExistingZone?

    Properties

    accountId: string

    The Cloudflare account identifier

    apiToken: string

    The Cloudflare API token used for authentication

    debug?: boolean

    Enable debug logging output

    domainName: string

    The root domain name for the deployment

    extraContexts?: string[]

    Additional CDK context file paths to load

    name: string

    The name identifier for the stack or construct

    regionContextPath?: string

    The relative path to region-specific context files

    resourceGroupName?: string

    Optional Azure resource group name used when resolving secrets from Azure Key Vault

    siteAssetDir: string

    The local directory path containing the static site assets to deploy

    siteBranch?: string

    The git branch to deploy from, defaults to 'main'

    siteCnameRecord?: DnsRecordProps

    The DNS CNAME record properties for the static site

    siteDeployMessage: string

    The deployment message used when deploying the pages project

    sitePagesProject: PagesProjectProps

    The Cloudflare Pages project properties

    siteSubDomain: string

    The subdomain for the static site (e.g. 'www' for www.example.com)

    siteZone: ZoneProps

    The Cloudflare zone properties for the static site

    skipStageForARecords?: boolean

    Whether to omit the stage prefix for Route53 A records

    stage: string

    The deployment stage (e.g. dev, tst, uat, prd)

    stageContextPath?: string

    The relative path to stage-specific context files

    stageRegionContextPath?: string

    The relative path to stage-region-specific context files

    subDomain?: string

    The subdomain prefix for the deployment

    useExistingZone?: boolean

    Whether to use an existing Cloudflare zone instead of creating a new one

    Settings

    Member Visibility

    On This Page

    Properties