@pulumi/cloudflare 6.8.0 → 6.9.0-alpha.1757365806
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/accessApplication.js +78 -78
- package/accessApplication.js.map +1 -1
- package/accessCaCertificate.js +10 -10
- package/accessCaCertificate.js.map +1 -1
- package/accessCustomPage.js +14 -14
- package/accessCustomPage.js.map +1 -1
- package/accessGroup.js +17 -17
- package/accessGroup.js.map +1 -1
- package/accessIdentityProvider.js +16 -16
- package/accessIdentityProvider.js.map +1 -1
- package/accessKeysConfiguration.js +9 -9
- package/accessKeysConfiguration.js.map +1 -1
- package/accessMutualTlsCertificate.js +15 -15
- package/accessMutualTlsCertificate.js.map +1 -1
- package/accessMutualTlsHostnameSettings.js +11 -11
- package/accessMutualTlsHostnameSettings.js.map +1 -1
- package/accessOrganization.js +27 -27
- package/accessOrganization.js.map +1 -1
- package/accessPolicy.js +28 -28
- package/accessPolicy.js.map +1 -1
- package/accessRule.js +17 -17
- package/accessRule.js.map +1 -1
- package/accessServiceToken.js +13 -13
- package/accessServiceToken.js.map +1 -1
- package/accessTag.js +7 -7
- package/accessTag.js.map +1 -1
- package/account.js +11 -11
- package/account.js.map +1 -1
- package/accountDnsSettings.js +6 -6
- package/accountDnsSettings.js.map +1 -1
- package/accountDnsSettingsInternalView.js +12 -12
- package/accountDnsSettingsInternalView.js.map +1 -1
- package/accountMember.js +14 -14
- package/accountMember.js.map +1 -1
- package/accountSubscription.js +13 -13
- package/accountSubscription.js.map +1 -1
- package/accountToken.js +22 -22
- package/accountToken.js.map +1 -1
- package/addressMap.js +18 -18
- package/addressMap.js.map +1 -1
- package/apiShield.js +10 -10
- package/apiShield.js.map +1 -1
- package/apiShieldDiscoveryOperation.d.ts +12 -6
- package/apiShieldDiscoveryOperation.js +9 -9
- package/apiShieldDiscoveryOperation.js.map +1 -1
- package/apiShieldOperation.js +16 -16
- package/apiShieldOperation.js.map +1 -1
- package/apiShieldOperationSchemaValidationSettings.d.ts +21 -12
- package/apiShieldOperationSchemaValidationSettings.js +9 -9
- package/apiShieldOperationSchemaValidationSettings.js.map +1 -1
- package/apiShieldSchema.js +20 -20
- package/apiShieldSchema.js.map +1 -1
- package/apiShieldSchemaValidationSettings.d.ts +21 -9
- package/apiShieldSchemaValidationSettings.js +9 -9
- package/apiShieldSchemaValidationSettings.js.map +1 -1
- package/apiToken.js +19 -19
- package/apiToken.js.map +1 -1
- package/argoSmartRouting.js +9 -9
- package/argoSmartRouting.js.map +1 -1
- package/argoTieredCaching.js +9 -9
- package/argoTieredCaching.js.map +1 -1
- package/authenticatedOriginPulls.js +23 -23
- package/authenticatedOriginPulls.js.map +1 -1
- package/authenticatedOriginPullsCertificate.js +17 -17
- package/authenticatedOriginPullsCertificate.js.map +1 -1
- package/authenticatedOriginPullsSettings.js +7 -7
- package/authenticatedOriginPullsSettings.js.map +1 -1
- package/botManagement.js +32 -32
- package/botManagement.js.map +1 -1
- package/byoIpPrefix.js +22 -22
- package/byoIpPrefix.js.map +1 -1
- package/callsSfuApp.js +12 -12
- package/callsSfuApp.js.map +1 -1
- package/callsTurnApp.js +12 -12
- package/callsTurnApp.js.map +1 -1
- package/certificatePack.js +24 -24
- package/certificatePack.js.map +1 -1
- package/cloudConnectorRules.js +6 -6
- package/cloudConnectorRules.js.map +1 -1
- package/cloudforceOneRequest.js +22 -22
- package/cloudforceOneRequest.js.map +1 -1
- package/cloudforceOneRequestAsset.js +19 -19
- package/cloudforceOneRequestAsset.js.map +1 -1
- package/cloudforceOneRequestMessage.js +13 -13
- package/cloudforceOneRequestMessage.js.map +1 -1
- package/cloudforceOneRequestPriority.js +26 -26
- package/cloudforceOneRequestPriority.js.map +1 -1
- package/config/vars.d.ts +5 -13
- package/config/vars.js.map +1 -1
- package/contentScanningExpression.js +7 -7
- package/contentScanningExpression.js.map +1 -1
- package/customHostname.js +21 -21
- package/customHostname.js.map +1 -1
- package/customHostnameFallbackOrigin.js +11 -11
- package/customHostnameFallbackOrigin.js.map +1 -1
- package/customPages.js +18 -18
- package/customPages.js.map +1 -1
- package/customSsl.js +27 -27
- package/customSsl.js.map +1 -1
- package/d1database.js +16 -16
- package/d1database.js.map +1 -1
- package/deviceManagedNetworks.js +14 -14
- package/deviceManagedNetworks.js.map +1 -1
- package/devicePostureIntegration.js +16 -16
- package/devicePostureIntegration.js.map +1 -1
- package/devicePostureRule.js +20 -20
- package/devicePostureRule.js.map +1 -1
- package/dlpCustomProfile.js +27 -27
- package/dlpCustomProfile.js.map +1 -1
- package/dlpPredefinedProfile.js +25 -25
- package/dlpPredefinedProfile.js.map +1 -1
- package/dnsFirewall.js +28 -28
- package/dnsFirewall.js.map +1 -1
- package/dnsRecord.js +33 -33
- package/dnsRecord.js.map +1 -1
- package/dnsZoneTransfersAcl.js +10 -10
- package/dnsZoneTransfersAcl.js.map +1 -1
- package/dnsZoneTransfersIncoming.js +17 -17
- package/dnsZoneTransfersIncoming.js.map +1 -1
- package/dnsZoneTransfersOutgoing.js +14 -14
- package/dnsZoneTransfersOutgoing.js.map +1 -1
- package/dnsZoneTransfersPeer.js +15 -15
- package/dnsZoneTransfersPeer.js.map +1 -1
- package/dnsZoneTransfersTsig.js +13 -13
- package/dnsZoneTransfersTsig.js.map +1 -1
- package/emailRoutingAddress.js +11 -11
- package/emailRoutingAddress.js.map +1 -1
- package/emailRoutingCatchAll.js +15 -15
- package/emailRoutingCatchAll.js.map +1 -1
- package/emailRoutingDns.js +18 -18
- package/emailRoutingDns.js.map +1 -1
- package/emailRoutingRule.js +17 -17
- package/emailRoutingRule.js.map +1 -1
- package/emailRoutingSettings.js +11 -11
- package/emailRoutingSettings.js.map +1 -1
- package/emailSecurityBlockSender.js +17 -17
- package/emailSecurityBlockSender.js.map +1 -1
- package/emailSecurityImpersonationRegistry.js +20 -20
- package/emailSecurityImpersonationRegistry.js.map +1 -1
- package/emailSecurityTrustedDomains.js +18 -18
- package/emailSecurityTrustedDomains.js.map +1 -1
- package/filter.js +15 -15
- package/filter.js.map +1 -1
- package/firewallRule.js +15 -15
- package/firewallRule.js.map +1 -1
- package/healthcheck.js +36 -36
- package/healthcheck.js.map +1 -1
- package/hostnameTlsSetting.js +16 -16
- package/hostnameTlsSetting.js.map +1 -1
- package/hyperdriveConfig.js +18 -18
- package/hyperdriveConfig.js.map +1 -1
- package/image.js +21 -21
- package/image.js.map +1 -1
- package/imageVariant.js +10 -10
- package/imageVariant.js.map +1 -1
- package/keylessCertificate.js +24 -24
- package/keylessCertificate.js.map +1 -1
- package/leakedCredentialCheck.js +6 -6
- package/leakedCredentialCheck.js.map +1 -1
- package/leakedCredentialCheckRule.js +8 -8
- package/leakedCredentialCheckRule.js.map +1 -1
- package/list.js +16 -16
- package/list.js.map +1 -1
- package/listItem.js +20 -20
- package/listItem.js.map +1 -1
- package/loadBalancer.js +48 -48
- package/loadBalancer.js.map +1 -1
- package/loadBalancerMonitor.js +38 -38
- package/loadBalancerMonitor.js.map +1 -1
- package/loadBalancerPool.js +36 -36
- package/loadBalancerPool.js.map +1 -1
- package/logpullRetention.js +6 -6
- package/logpullRetention.js.map +1 -1
- package/logpushJob.js +35 -35
- package/logpushJob.js.map +1 -1
- package/logpushOwnershipChallenge.js +11 -11
- package/logpushOwnershipChallenge.js.map +1 -1
- package/magicNetworkMonitoringConfiguration.js +13 -13
- package/magicNetworkMonitoringConfiguration.js.map +1 -1
- package/magicNetworkMonitoringRule.js +22 -22
- package/magicNetworkMonitoringRule.js.map +1 -1
- package/magicTransitConnector.js +17 -17
- package/magicTransitConnector.js.map +1 -1
- package/magicTransitSite.js +17 -17
- package/magicTransitSite.js.map +1 -1
- package/magicTransitSiteAcl.js +24 -24
- package/magicTransitSiteAcl.js.map +1 -1
- package/magicTransitSiteLan.js +22 -22
- package/magicTransitSiteLan.js.map +1 -1
- package/magicTransitSiteWan.js +19 -19
- package/magicTransitSiteWan.js.map +1 -1
- package/magicWanGreTunnel.js +28 -28
- package/magicWanGreTunnel.js.map +1 -1
- package/magicWanIpsecTunnel.js +29 -29
- package/magicWanIpsecTunnel.js.map +1 -1
- package/magicWanStaticRoute.js +21 -21
- package/magicWanStaticRoute.js.map +1 -1
- package/managedHeaders.js +10 -10
- package/managedHeaders.js.map +1 -1
- package/managedTransforms.js +10 -10
- package/managedTransforms.js.map +1 -1
- package/mtlsCertificate.js +20 -20
- package/mtlsCertificate.js.map +1 -1
- package/notificationPolicy.js +23 -23
- package/notificationPolicy.js.map +1 -1
- package/notificationPolicyWebhooks.js +16 -16
- package/notificationPolicyWebhooks.js.map +1 -1
- package/observatoryScheduledTest.js +11 -11
- package/observatoryScheduledTest.js.map +1 -1
- package/originCaCertificate.js +11 -11
- package/originCaCertificate.js.map +1 -1
- package/package.json +2 -2
- package/pageRule.js +16 -16
- package/pageRule.js.map +1 -1
- package/pageShieldPolicy.js +19 -19
- package/pageShieldPolicy.js.map +1 -1
- package/pagesDomain.js +17 -17
- package/pagesDomain.js.map +1 -1
- package/pagesProject.js +20 -20
- package/pagesProject.js.map +1 -1
- package/provider.d.ts +10 -26
- package/provider.js +6 -6
- package/provider.js.map +1 -1
- package/queue.js +16 -16
- package/queue.js.map +1 -1
- package/queueConsumer.js +19 -19
- package/queueConsumer.js.map +1 -1
- package/r2bucket.js +14 -14
- package/r2bucket.js.map +1 -1
- package/r2bucketCors.js +11 -11
- package/r2bucketCors.js.map +1 -1
- package/r2bucketEventNotification.js +15 -15
- package/r2bucketEventNotification.js.map +1 -1
- package/r2bucketLifecycle.js +11 -11
- package/r2bucketLifecycle.js.map +1 -1
- package/r2bucketLock.js +11 -11
- package/r2bucketLock.js.map +1 -1
- package/r2bucketSippy.js +14 -14
- package/r2bucketSippy.js.map +1 -1
- package/r2customDomain.js +24 -24
- package/r2customDomain.js.map +1 -1
- package/r2managedDomain.js +14 -14
- package/r2managedDomain.js.map +1 -1
- package/rateLimit.js +19 -19
- package/rateLimit.js.map +1 -1
- package/record.js +33 -33
- package/record.js.map +1 -1
- package/regionalHostname.js +13 -13
- package/regionalHostname.js.map +1 -1
- package/regionalTieredCache.js +8 -8
- package/regionalTieredCache.js.map +1 -1
- package/registrarDomain.js +13 -13
- package/registrarDomain.js.map +1 -1
- package/riskBehavior.js +7 -7
- package/riskBehavior.js.map +1 -1
- package/ruleset.js +20 -20
- package/ruleset.js.map +1 -1
- package/schemaValidationOperationSettings.d.ts +21 -12
- package/schemaValidationOperationSettings.js +10 -10
- package/schemaValidationOperationSettings.js.map +1 -1
- package/schemaValidationSchemas.js +18 -18
- package/schemaValidationSchemas.js.map +1 -1
- package/schemaValidationSettings.d.ts +36 -15
- package/schemaValidationSettings.js +9 -9
- package/schemaValidationSettings.js.map +1 -1
- package/snippet.js +15 -15
- package/snippet.js.map +1 -1
- package/snippetRules.js +7 -7
- package/snippetRules.js.map +1 -1
- package/snippets.js +15 -15
- package/snippets.js.map +1 -1
- package/spectrumApplication.js +30 -30
- package/spectrumApplication.js.map +1 -1
- package/staticRoute.js +21 -21
- package/staticRoute.js.map +1 -1
- package/stream.js +37 -37
- package/stream.js.map +1 -1
- package/streamAudioTrack.js +15 -15
- package/streamAudioTrack.js.map +1 -1
- package/streamCaptionLanguage.js +15 -15
- package/streamCaptionLanguage.js.map +1 -1
- package/streamDownload.js +7 -7
- package/streamDownload.js.map +1 -1
- package/streamKey.js +7 -7
- package/streamKey.js.map +1 -1
- package/streamLiveInput.js +24 -24
- package/streamLiveInput.js.map +1 -1
- package/streamWatermark.js +25 -25
- package/streamWatermark.js.map +1 -1
- package/streamWebhook.js +7 -7
- package/streamWebhook.js.map +1 -1
- package/teamsAccount.js +8 -8
- package/teamsAccount.js.map +1 -1
- package/teamsList.js +17 -17
- package/teamsList.js.map +1 -1
- package/teamsLocation.js +24 -24
- package/teamsLocation.js.map +1 -1
- package/teamsProxyEndpoint.js +13 -13
- package/teamsProxyEndpoint.js.map +1 -1
- package/teamsRule.js +38 -38
- package/teamsRule.js.map +1 -1
- package/tieredCache.js +9 -9
- package/tieredCache.js.map +1 -1
- package/totalTls.js +10 -10
- package/totalTls.js.map +1 -1
- package/tunnel.js +21 -21
- package/tunnel.js.map +1 -1
- package/tunnelConfig.js +13 -13
- package/tunnelConfig.js.map +1 -1
- package/tunnelRoute.js +16 -16
- package/tunnelRoute.js.map +1 -1
- package/tunnelVirtualNetwork.js +15 -15
- package/tunnelVirtualNetwork.js.map +1 -1
- package/turnstileWidget.js +27 -27
- package/turnstileWidget.js.map +1 -1
- package/urlNormalizationSettings.js +10 -10
- package/urlNormalizationSettings.js.map +1 -1
- package/user.js +19 -19
- package/user.js.map +1 -1
- package/userAgentBlockingRule.js +14 -14
- package/userAgentBlockingRule.js.map +1 -1
- package/utilities.js +18 -29
- package/utilities.js.map +1 -1
- package/waitingRoom.d.ts +351 -312
- package/waitingRoom.js +54 -54
- package/waitingRoom.js.map +1 -1
- package/waitingRoomEvent.js +42 -42
- package/waitingRoomEvent.js.map +1 -1
- package/waitingRoomRules.js +10 -10
- package/waitingRoomRules.js.map +1 -1
- package/waitingRoomSettings.js +6 -6
- package/waitingRoomSettings.js.map +1 -1
- package/web3Hostname.js +17 -17
- package/web3Hostname.js.map +1 -1
- package/webAnalyticsRule.js +17 -17
- package/webAnalyticsRule.js.map +1 -1
- package/webAnalyticsSite.js +20 -20
- package/webAnalyticsSite.js.map +1 -1
- package/worker.js +19 -19
- package/worker.js.map +1 -1
- package/workerCronTrigger.js +10 -10
- package/workerCronTrigger.js.map +1 -1
- package/workerDomain.js +17 -17
- package/workerDomain.js.map +1 -1
- package/workerScript.js +53 -53
- package/workerScript.js.map +1 -1
- package/workerVersion.js +32 -32
- package/workerVersion.js.map +1 -1
- package/workersCronTrigger.js +10 -10
- package/workersCronTrigger.js.map +1 -1
- package/workersCustomDomain.js +17 -17
- package/workersCustomDomain.js.map +1 -1
- package/workersDeployment.js +18 -18
- package/workersDeployment.js.map +1 -1
- package/workersForPlatformsDispatchNamespace.js +14 -14
- package/workersForPlatformsDispatchNamespace.js.map +1 -1
- package/workersForPlatformsNamespace.js +14 -14
- package/workersForPlatformsNamespace.js.map +1 -1
- package/workersKv.js +15 -15
- package/workersKv.js.map +1 -1
- package/workersKvNamespace.js +8 -8
- package/workersKvNamespace.js.map +1 -1
- package/workersRoute.js +9 -9
- package/workersRoute.js.map +1 -1
- package/workersScript.js +53 -53
- package/workersScript.js.map +1 -1
- package/workersScriptSubdomain.js +12 -12
- package/workersScriptSubdomain.js.map +1 -1
- package/zeroTrustAccessApplication.js +78 -78
- package/zeroTrustAccessApplication.js.map +1 -1
- package/zeroTrustAccessCustomPage.js +14 -14
- package/zeroTrustAccessCustomPage.js.map +1 -1
- package/zeroTrustAccessGroup.js +17 -17
- package/zeroTrustAccessGroup.js.map +1 -1
- package/zeroTrustAccessIdentityProvider.js +16 -16
- package/zeroTrustAccessIdentityProvider.js.map +1 -1
- package/zeroTrustAccessInfrastructureTarget.js +12 -12
- package/zeroTrustAccessInfrastructureTarget.js.map +1 -1
- package/zeroTrustAccessKeyConfiguration.js +9 -9
- package/zeroTrustAccessKeyConfiguration.js.map +1 -1
- package/zeroTrustAccessMtlsCertificate.js +15 -15
- package/zeroTrustAccessMtlsCertificate.js.map +1 -1
- package/zeroTrustAccessMtlsHostnameSettings.js +11 -11
- package/zeroTrustAccessMtlsHostnameSettings.js.map +1 -1
- package/zeroTrustAccessPolicy.js +28 -28
- package/zeroTrustAccessPolicy.js.map +1 -1
- package/zeroTrustAccessServiceToken.js +13 -13
- package/zeroTrustAccessServiceToken.js.map +1 -1
- package/zeroTrustAccessShortLivedCertificate.js +10 -10
- package/zeroTrustAccessShortLivedCertificate.js.map +1 -1
- package/zeroTrustAccessTag.js +7 -7
- package/zeroTrustAccessTag.js.map +1 -1
- package/zeroTrustDeviceCustomProfile.js +56 -56
- package/zeroTrustDeviceCustomProfile.js.map +1 -1
- package/zeroTrustDeviceCustomProfileLocalDomainFallback.js +10 -10
- package/zeroTrustDeviceCustomProfileLocalDomainFallback.js.map +1 -1
- package/zeroTrustDeviceDefaultProfile.js +42 -42
- package/zeroTrustDeviceDefaultProfile.js.map +1 -1
- package/zeroTrustDeviceDefaultProfileCertificates.js +7 -7
- package/zeroTrustDeviceDefaultProfileCertificates.js.map +1 -1
- package/zeroTrustDeviceDefaultProfileLocalDomainFallback.js +7 -7
- package/zeroTrustDeviceDefaultProfileLocalDomainFallback.js.map +1 -1
- package/zeroTrustDeviceManagedNetworks.js +14 -14
- package/zeroTrustDeviceManagedNetworks.js.map +1 -1
- package/zeroTrustDevicePostureIntegration.js +16 -16
- package/zeroTrustDevicePostureIntegration.js.map +1 -1
- package/zeroTrustDevicePostureRule.js +20 -20
- package/zeroTrustDevicePostureRule.js.map +1 -1
- package/zeroTrustDeviceSettings.js +14 -14
- package/zeroTrustDeviceSettings.js.map +1 -1
- package/zeroTrustDexTest.js +23 -23
- package/zeroTrustDexTest.js.map +1 -1
- package/zeroTrustDlpCustomEntry.js +24 -24
- package/zeroTrustDlpCustomEntry.js.map +1 -1
- package/zeroTrustDlpCustomProfile.js +27 -27
- package/zeroTrustDlpCustomProfile.js.map +1 -1
- package/zeroTrustDlpDataset.d.ts +18 -8
- package/zeroTrustDlpDataset.js +26 -26
- package/zeroTrustDlpDataset.js.map +1 -1
- package/zeroTrustDlpEntry.js +25 -25
- package/zeroTrustDlpEntry.js.map +1 -1
- package/zeroTrustDlpIntegrationEntry.js +22 -22
- package/zeroTrustDlpIntegrationEntry.js.map +1 -1
- package/zeroTrustDlpPredefinedEntry.js +22 -22
- package/zeroTrustDlpPredefinedEntry.js.map +1 -1
- package/zeroTrustDlpPredefinedProfile.js +25 -25
- package/zeroTrustDlpPredefinedProfile.js.map +1 -1
- package/zeroTrustDnsLocation.js +24 -24
- package/zeroTrustDnsLocation.js.map +1 -1
- package/zeroTrustGatewayCertificate.js +17 -17
- package/zeroTrustGatewayCertificate.js.map +1 -1
- package/zeroTrustGatewayLogging.js +8 -8
- package/zeroTrustGatewayLogging.js.map +1 -1
- package/zeroTrustGatewayPolicy.js +38 -38
- package/zeroTrustGatewayPolicy.js.map +1 -1
- package/zeroTrustGatewayProxyEndpoint.js +13 -13
- package/zeroTrustGatewayProxyEndpoint.js.map +1 -1
- package/zeroTrustGatewaySettings.js +8 -8
- package/zeroTrustGatewaySettings.js.map +1 -1
- package/zeroTrustList.js +17 -17
- package/zeroTrustList.js.map +1 -1
- package/zeroTrustLocalFallbackDomain.js +10 -10
- package/zeroTrustLocalFallbackDomain.js.map +1 -1
- package/zeroTrustOrganization.js +27 -27
- package/zeroTrustOrganization.js.map +1 -1
- package/zeroTrustRiskBehavior.js +7 -7
- package/zeroTrustRiskBehavior.js.map +1 -1
- package/zeroTrustRiskScoringIntegration.js +17 -17
- package/zeroTrustRiskScoringIntegration.js.map +1 -1
- package/zeroTrustTunnelCloudflared.js +21 -21
- package/zeroTrustTunnelCloudflared.js.map +1 -1
- package/zeroTrustTunnelCloudflaredConfig.js +13 -13
- package/zeroTrustTunnelCloudflaredConfig.js.map +1 -1
- package/zeroTrustTunnelCloudflaredRoute.js +16 -16
- package/zeroTrustTunnelCloudflaredRoute.js.map +1 -1
- package/zeroTrustTunnelCloudflaredVirtualNetwork.js +15 -15
- package/zeroTrustTunnelCloudflaredVirtualNetwork.js.map +1 -1
- package/zeroTrustTunnelWarpConnector.js +20 -20
- package/zeroTrustTunnelWarpConnector.js.map +1 -1
- package/zone.js +30 -30
- package/zone.js.map +1 -1
- package/zoneCacheReserve.js +8 -8
- package/zoneCacheReserve.js.map +1 -1
- package/zoneCacheVariants.js +9 -9
- package/zoneCacheVariants.js.map +1 -1
- package/zoneDnsSettings.js +22 -22
- package/zoneDnsSettings.js.map +1 -1
- package/zoneDnssec.d.ts +45 -27
- package/zoneDnssec.js +22 -22
- package/zoneDnssec.js.map +1 -1
- package/zoneHold.js +9 -9
- package/zoneHold.js.map +1 -1
- package/zoneLockdown.js +18 -18
- package/zoneLockdown.js.map +1 -1
- package/zoneSetting.js +15 -15
- package/zoneSetting.js.map +1 -1
- package/zoneSubscription.js +13 -13
- package/zoneSubscription.js.map +1 -1
package/waitingRoom.d.ts
CHANGED
|
@@ -80,11 +80,8 @@ export declare class WaitingRoom extends pulumi.CustomResource {
|
|
|
80
80
|
*/
|
|
81
81
|
readonly customPageHtml: pulumi.Output<string>;
|
|
82
82
|
/**
|
|
83
|
-
* The language of the default page template. If no defaultTemplateLanguage is provided, then `en-US` (English) will be
|
|
84
|
-
*
|
|
85
|
-
* "nl-NL", "pl-PL", "id-ID", "tr-TR", "ar-EG", "ru-RU", "fa-IR", "bg-BG", "hr-HR", "cs-CZ", "da-DK", "fi-FI", "lt-LT",
|
|
86
|
-
* "ms-MY", "nb-NO", "ro-RO", "el-GR", "he-IL", "hi-IN", "hu-HU", "sr-BA", "sk-SK", "sl-SI", "sv-SE", "tl-PH", "th-TH",
|
|
87
|
-
* "uk-UA", "vi-VN".
|
|
83
|
+
* The language of the default page template. If no defaultTemplateLanguage is provided, then `en-US` (English) will be used.
|
|
84
|
+
* Available values: "en-US", "es-ES", "de-DE", "fr-FR", "it-IT", "ja-JP", "ko-KR", "pt-BR", "zh-CN", "zh-TW", "nl-NL", "pl-PL", "id-ID", "tr-TR", "ar-EG", "ru-RU", "fa-IR", "bg-BG", "hr-HR", "cs-CZ", "da-DK", "fi-FI", "lt-LT", "ms-MY", "nb-NO", "ro-RO", "el-GR", "he-IL", "hi-IN", "hu-HU", "sr-BA", "sk-SK", "sl-SI", "sv-SE", "tl-PH", "th-TH", "uk-UA", "vi-VN".
|
|
88
85
|
*/
|
|
89
86
|
readonly defaultTemplateLanguage: pulumi.Output<string>;
|
|
90
87
|
/**
|
|
@@ -92,9 +89,7 @@ export declare class WaitingRoom extends pulumi.CustomResource {
|
|
|
92
89
|
*/
|
|
93
90
|
readonly description: pulumi.Output<string>;
|
|
94
91
|
/**
|
|
95
|
-
* Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an
|
|
96
|
-
* accepted user will have sessionDuration minutes to browse the site. After that, they will have to go through the waiting
|
|
97
|
-
* room again. If `false`, a user's session cookie will be automatically renewed on every request.
|
|
92
|
+
* Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have sessionDuration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request.
|
|
98
93
|
*/
|
|
99
94
|
readonly disableSessionRenewal: pulumi.Output<boolean>;
|
|
100
95
|
/**
|
|
@@ -106,68 +101,97 @@ export declare class WaitingRoom extends pulumi.CustomResource {
|
|
|
106
101
|
*/
|
|
107
102
|
readonly host: pulumi.Output<string>;
|
|
108
103
|
/**
|
|
109
|
-
* Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
* `
|
|
118
|
-
*
|
|
119
|
-
* `
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
* `
|
|
131
|
-
* `
|
|
132
|
-
*
|
|
133
|
-
* `
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
104
|
+
* Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields:
|
|
105
|
+
* 1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).
|
|
106
|
+
* 2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.
|
|
107
|
+
* 3. `waitTime`: Valid only when `waitTimeKnown` is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When `queueingMethod` is **random**, this is set to `waitTime50Percentile`.
|
|
108
|
+
* 4. `waitTime25Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).
|
|
109
|
+
* 5. `waitTime50Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before `waitTime50Percentile` and half are expected to be let in after it.
|
|
110
|
+
* 6. `waitTime75Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).
|
|
111
|
+
* 7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.
|
|
112
|
+
* 8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.
|
|
113
|
+
* 9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.
|
|
114
|
+
* 10. `lastUpdated`: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after `refreshIntervalSeconds` past this time. If the user makes a request too soon, it will be ignored and `lastUpdated` will not change.
|
|
115
|
+
* 11. `refreshIntervalSeconds`: Integer indicating the number of seconds after `lastUpdated` until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the `queueingMethod` is `reject`, there is no specified refresh time —\_it will always be **zero**.
|
|
116
|
+
* 12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.
|
|
117
|
+
* 13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.
|
|
118
|
+
* 14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.
|
|
119
|
+
* 15. `isPassthroughQueue`: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when `queueAll` is **true** or `isEventPrequeueing` is **true** because in all other cases requests will go directly to the origin.
|
|
120
|
+
* 16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.
|
|
121
|
+
* 17. `isEventActive`: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties `prequeueStartTime`, `eventStartTime`, and `eventEndTime` in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.
|
|
122
|
+
* 18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.
|
|
123
|
+
* 19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.
|
|
124
|
+
* 20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.
|
|
125
|
+
* 21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.
|
|
126
|
+
* 22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.
|
|
127
|
+
* 23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.
|
|
128
|
+
* 24. `turnstile`: Empty when turnstile isn't enabled. String displaying an html tag to display the Turnstile widget. Please add the `{{{turnstile}}}` tag to the `customHtml` template to ensure the Turnstile widget appears.
|
|
129
|
+
* 25. `infiniteQueue`: Boolean indicating whether the response is for a user in the infinite queue.
|
|
130
|
+
*
|
|
131
|
+
* An example cURL to a waiting room could be:
|
|
132
|
+
*
|
|
133
|
+
* curl -X GET "https://example.com/waitingroom" \
|
|
134
|
+
* -H "Accept: application/json"
|
|
135
|
+
*
|
|
136
|
+
* If `jsonResponseEnabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **fifo** and no event is active could be:
|
|
137
|
+
*
|
|
138
|
+
* {
|
|
139
|
+
* "cfWaitingRoom": {
|
|
140
|
+
* "inWaitingRoom": true,
|
|
141
|
+
* "waitTimeKnown": true,
|
|
142
|
+
* "waitTime": 10,
|
|
143
|
+
* "waitTime25Percentile": 0,
|
|
144
|
+
* "waitTime50Percentile": 0,
|
|
145
|
+
* "waitTime75Percentile": 0,
|
|
146
|
+
* "waitTimeFormatted": "10 minutes",
|
|
147
|
+
* "queueIsFull": false,
|
|
148
|
+
* "queueAll": false,
|
|
149
|
+
* "lastUpdated": "2020-08-03T23:46:00.000Z",
|
|
150
|
+
* "refreshIntervalSeconds": 20,
|
|
151
|
+
* "queueingMethod": "fifo",
|
|
152
|
+
* "isFIFOQueue": true,
|
|
153
|
+
* "isRandomQueue": false,
|
|
154
|
+
* "isPassthroughQueue": false,
|
|
155
|
+
* "isRejectQueue": false,
|
|
156
|
+
* "isEventActive": false,
|
|
157
|
+
* "isEventPrequeueing": false,
|
|
158
|
+
* "timeUntilEventStart": 0,
|
|
159
|
+
* "timeUntilEventStartFormatted": "unavailable",
|
|
160
|
+
* "timeUntilEventEnd": 0,
|
|
161
|
+
* "timeUntilEventEndFormatted": "unavailable",
|
|
162
|
+
* "shuffleAtEventStart": false
|
|
163
|
+
* }
|
|
164
|
+
* }
|
|
165
|
+
*
|
|
166
|
+
* If `jsonResponseEnabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **random** and an event is active could be:
|
|
167
|
+
*
|
|
168
|
+
* {
|
|
169
|
+
* "cfWaitingRoom": {
|
|
170
|
+
* "inWaitingRoom": true,
|
|
171
|
+
* "waitTimeKnown": true,
|
|
172
|
+
* "waitTime": 10,
|
|
173
|
+
* "waitTime25Percentile": 5,
|
|
174
|
+
* "waitTime50Percentile": 10,
|
|
175
|
+
* "waitTime75Percentile": 15,
|
|
176
|
+
* "waitTimeFormatted": "5 minutes to 15 minutes",
|
|
177
|
+
* "queueIsFull": false,
|
|
178
|
+
* "queueAll": false,
|
|
179
|
+
* "lastUpdated": "2020-08-03T23:46:00.000Z",
|
|
180
|
+
* "refreshIntervalSeconds": 20,
|
|
181
|
+
* "queueingMethod": "random",
|
|
182
|
+
* "isFIFOQueue": false,
|
|
183
|
+
* "isRandomQueue": true,
|
|
184
|
+
* "isPassthroughQueue": false,
|
|
185
|
+
* "isRejectQueue": false,
|
|
186
|
+
* "isEventActive": true,
|
|
187
|
+
* "isEventPrequeueing": false,
|
|
188
|
+
* "timeUntilEventStart": 0,
|
|
189
|
+
* "timeUntilEventStartFormatted": "unavailable",
|
|
190
|
+
* "timeUntilEventEnd": 15,
|
|
191
|
+
* "timeUntilEventEndFormatted": "15 minutes",
|
|
192
|
+
* "shuffleAtEventStart": true
|
|
193
|
+
* }
|
|
194
|
+
* }
|
|
171
195
|
*/
|
|
172
196
|
readonly jsonResponseEnabled: pulumi.Output<boolean>;
|
|
173
197
|
readonly modifiedOn: pulumi.Output<string>;
|
|
@@ -188,43 +212,29 @@ export declare class WaitingRoom extends pulumi.CustomResource {
|
|
|
188
212
|
*/
|
|
189
213
|
readonly nextEventStartTime: pulumi.Output<string>;
|
|
190
214
|
/**
|
|
191
|
-
* Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well.
|
|
192
|
-
* If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen.
|
|
193
|
-
* Wildcards and query parameters are not supported.
|
|
215
|
+
* Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
|
|
194
216
|
*/
|
|
195
217
|
readonly path: pulumi.Output<string>;
|
|
196
218
|
/**
|
|
197
|
-
* If queueAll is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can
|
|
198
|
-
* get to the route once this field is set and estimated time will become unavailable.
|
|
219
|
+
* If queueAll is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.
|
|
199
220
|
*/
|
|
200
221
|
readonly queueAll: pulumi.Output<boolean>;
|
|
201
222
|
/**
|
|
202
|
-
* Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
* waiting room
|
|
206
|
-
*
|
|
207
|
-
*
|
|
208
|
-
* waiting room and into the origin website. As a result, any configured limits will not be respected while this is
|
|
209
|
-
* enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are
|
|
210
|
-
* still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a
|
|
211
|
-
* waiting room event, or vice versa. 4. `reject`: Users will be immediately rejected from the waiting room. As a result,
|
|
212
|
-
* no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while
|
|
213
|
-
* performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are
|
|
214
|
-
* not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and
|
|
215
|
-
* otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`,
|
|
216
|
-
* `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is
|
|
217
|
-
* prequeueing, the waiting room page **will not refresh automatically**. Available values: "fifo", "random",
|
|
218
|
-
* "passthrough", "reject".
|
|
223
|
+
* Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queueAll` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:
|
|
224
|
+
* 1. `fifo` **(default)**: First-In-First-Out queue where customers gain access in the order they arrived.
|
|
225
|
+
* 2. `random`: Random queue where customers gain access randomly, regardless of arrival time.
|
|
226
|
+
* 3. `passthrough`: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.
|
|
227
|
+
* 4. `reject`: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`, `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**.
|
|
228
|
+
* Available values: "fifo", "random", "passthrough", "reject".
|
|
219
229
|
*/
|
|
220
230
|
readonly queueingMethod: pulumi.Output<string>;
|
|
221
231
|
/**
|
|
222
|
-
* HTTP status code returned to a user while in the queue.
|
|
232
|
+
* HTTP status code returned to a user while in the queue.
|
|
233
|
+
* Available values: 200, 202, 429.
|
|
223
234
|
*/
|
|
224
235
|
readonly queueingStatusCode: pulumi.Output<number>;
|
|
225
236
|
/**
|
|
226
|
-
* Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by
|
|
227
|
-
* Cloudflare again in that time period, they will be treated as a new user that visits the route.
|
|
237
|
+
* Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.
|
|
228
238
|
*/
|
|
229
239
|
readonly sessionDuration: pulumi.Output<number>;
|
|
230
240
|
/**
|
|
@@ -236,18 +246,21 @@ export declare class WaitingRoom extends pulumi.CustomResource {
|
|
|
236
246
|
*/
|
|
237
247
|
readonly totalActiveUsers: pulumi.Output<number>;
|
|
238
248
|
/**
|
|
239
|
-
* Which action to take when a bot is detected using Turnstile. `log` will
|
|
240
|
-
*
|
|
241
|
-
*
|
|
242
|
-
*
|
|
249
|
+
* Which action to take when a bot is detected using Turnstile. `log` will
|
|
250
|
+
* have no impact on queueing behavior, simply keeping track of how many
|
|
251
|
+
* bots are detected in Waiting Room Analytics. `infiniteQueue` will send
|
|
252
|
+
* bots to a false queueing state, where they will never reach your
|
|
253
|
+
* origin. `infiniteQueue` requires Advanced Waiting Room.
|
|
254
|
+
* Available values: "log", "infiniteQueue".
|
|
243
255
|
*/
|
|
244
256
|
readonly turnstileAction: pulumi.Output<string>;
|
|
245
257
|
/**
|
|
246
|
-
* Which Turnstile widget type to use for detecting bot traffic. See
|
|
247
|
-
* documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types)
|
|
248
|
-
* widget types. Set to `off` to disable the
|
|
249
|
-
*
|
|
250
|
-
*
|
|
258
|
+
* Which Turnstile widget type to use for detecting bot traffic. See
|
|
259
|
+
* [the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types)
|
|
260
|
+
* for the definitions of these widget types. Set to `off` to disable the
|
|
261
|
+
* Turnstile integration entirely. Setting this to anything other than
|
|
262
|
+
* `off` or `invisible` requires Advanced Waiting Room.
|
|
263
|
+
* Available values: "off", "invisible", "visibleNonInteractive", "visibleManaged".
|
|
251
264
|
*/
|
|
252
265
|
readonly turnstileMode: pulumi.Output<string>;
|
|
253
266
|
/**
|
|
@@ -285,11 +298,8 @@ export interface WaitingRoomState {
|
|
|
285
298
|
*/
|
|
286
299
|
customPageHtml?: pulumi.Input<string>;
|
|
287
300
|
/**
|
|
288
|
-
* The language of the default page template. If no defaultTemplateLanguage is provided, then `en-US` (English) will be
|
|
289
|
-
*
|
|
290
|
-
* "nl-NL", "pl-PL", "id-ID", "tr-TR", "ar-EG", "ru-RU", "fa-IR", "bg-BG", "hr-HR", "cs-CZ", "da-DK", "fi-FI", "lt-LT",
|
|
291
|
-
* "ms-MY", "nb-NO", "ro-RO", "el-GR", "he-IL", "hi-IN", "hu-HU", "sr-BA", "sk-SK", "sl-SI", "sv-SE", "tl-PH", "th-TH",
|
|
292
|
-
* "uk-UA", "vi-VN".
|
|
301
|
+
* The language of the default page template. If no defaultTemplateLanguage is provided, then `en-US` (English) will be used.
|
|
302
|
+
* Available values: "en-US", "es-ES", "de-DE", "fr-FR", "it-IT", "ja-JP", "ko-KR", "pt-BR", "zh-CN", "zh-TW", "nl-NL", "pl-PL", "id-ID", "tr-TR", "ar-EG", "ru-RU", "fa-IR", "bg-BG", "hr-HR", "cs-CZ", "da-DK", "fi-FI", "lt-LT", "ms-MY", "nb-NO", "ro-RO", "el-GR", "he-IL", "hi-IN", "hu-HU", "sr-BA", "sk-SK", "sl-SI", "sv-SE", "tl-PH", "th-TH", "uk-UA", "vi-VN".
|
|
293
303
|
*/
|
|
294
304
|
defaultTemplateLanguage?: pulumi.Input<string>;
|
|
295
305
|
/**
|
|
@@ -297,9 +307,7 @@ export interface WaitingRoomState {
|
|
|
297
307
|
*/
|
|
298
308
|
description?: pulumi.Input<string>;
|
|
299
309
|
/**
|
|
300
|
-
* Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an
|
|
301
|
-
* accepted user will have sessionDuration minutes to browse the site. After that, they will have to go through the waiting
|
|
302
|
-
* room again. If `false`, a user's session cookie will be automatically renewed on every request.
|
|
310
|
+
* Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have sessionDuration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request.
|
|
303
311
|
*/
|
|
304
312
|
disableSessionRenewal?: pulumi.Input<boolean>;
|
|
305
313
|
/**
|
|
@@ -311,68 +319,97 @@ export interface WaitingRoomState {
|
|
|
311
319
|
*/
|
|
312
320
|
host?: pulumi.Input<string>;
|
|
313
321
|
/**
|
|
314
|
-
* Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
322
|
-
* `
|
|
323
|
-
*
|
|
324
|
-
* `
|
|
325
|
-
*
|
|
326
|
-
*
|
|
327
|
-
*
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
*
|
|
331
|
-
*
|
|
332
|
-
*
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
* `
|
|
336
|
-
* `
|
|
337
|
-
*
|
|
338
|
-
* `
|
|
339
|
-
*
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
*
|
|
345
|
-
*
|
|
346
|
-
*
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
-
*
|
|
354
|
-
*
|
|
355
|
-
*
|
|
356
|
-
*
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
*
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
*
|
|
366
|
-
*
|
|
367
|
-
*
|
|
368
|
-
*
|
|
369
|
-
*
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
*
|
|
322
|
+
* Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields:
|
|
323
|
+
* 1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).
|
|
324
|
+
* 2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.
|
|
325
|
+
* 3. `waitTime`: Valid only when `waitTimeKnown` is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When `queueingMethod` is **random**, this is set to `waitTime50Percentile`.
|
|
326
|
+
* 4. `waitTime25Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).
|
|
327
|
+
* 5. `waitTime50Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before `waitTime50Percentile` and half are expected to be let in after it.
|
|
328
|
+
* 6. `waitTime75Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).
|
|
329
|
+
* 7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.
|
|
330
|
+
* 8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.
|
|
331
|
+
* 9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.
|
|
332
|
+
* 10. `lastUpdated`: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after `refreshIntervalSeconds` past this time. If the user makes a request too soon, it will be ignored and `lastUpdated` will not change.
|
|
333
|
+
* 11. `refreshIntervalSeconds`: Integer indicating the number of seconds after `lastUpdated` until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the `queueingMethod` is `reject`, there is no specified refresh time —\_it will always be **zero**.
|
|
334
|
+
* 12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.
|
|
335
|
+
* 13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.
|
|
336
|
+
* 14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.
|
|
337
|
+
* 15. `isPassthroughQueue`: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when `queueAll` is **true** or `isEventPrequeueing` is **true** because in all other cases requests will go directly to the origin.
|
|
338
|
+
* 16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.
|
|
339
|
+
* 17. `isEventActive`: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties `prequeueStartTime`, `eventStartTime`, and `eventEndTime` in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.
|
|
340
|
+
* 18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.
|
|
341
|
+
* 19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.
|
|
342
|
+
* 20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.
|
|
343
|
+
* 21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.
|
|
344
|
+
* 22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.
|
|
345
|
+
* 23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.
|
|
346
|
+
* 24. `turnstile`: Empty when turnstile isn't enabled. String displaying an html tag to display the Turnstile widget. Please add the `{{{turnstile}}}` tag to the `customHtml` template to ensure the Turnstile widget appears.
|
|
347
|
+
* 25. `infiniteQueue`: Boolean indicating whether the response is for a user in the infinite queue.
|
|
348
|
+
*
|
|
349
|
+
* An example cURL to a waiting room could be:
|
|
350
|
+
*
|
|
351
|
+
* curl -X GET "https://example.com/waitingroom" \
|
|
352
|
+
* -H "Accept: application/json"
|
|
353
|
+
*
|
|
354
|
+
* If `jsonResponseEnabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **fifo** and no event is active could be:
|
|
355
|
+
*
|
|
356
|
+
* {
|
|
357
|
+
* "cfWaitingRoom": {
|
|
358
|
+
* "inWaitingRoom": true,
|
|
359
|
+
* "waitTimeKnown": true,
|
|
360
|
+
* "waitTime": 10,
|
|
361
|
+
* "waitTime25Percentile": 0,
|
|
362
|
+
* "waitTime50Percentile": 0,
|
|
363
|
+
* "waitTime75Percentile": 0,
|
|
364
|
+
* "waitTimeFormatted": "10 minutes",
|
|
365
|
+
* "queueIsFull": false,
|
|
366
|
+
* "queueAll": false,
|
|
367
|
+
* "lastUpdated": "2020-08-03T23:46:00.000Z",
|
|
368
|
+
* "refreshIntervalSeconds": 20,
|
|
369
|
+
* "queueingMethod": "fifo",
|
|
370
|
+
* "isFIFOQueue": true,
|
|
371
|
+
* "isRandomQueue": false,
|
|
372
|
+
* "isPassthroughQueue": false,
|
|
373
|
+
* "isRejectQueue": false,
|
|
374
|
+
* "isEventActive": false,
|
|
375
|
+
* "isEventPrequeueing": false,
|
|
376
|
+
* "timeUntilEventStart": 0,
|
|
377
|
+
* "timeUntilEventStartFormatted": "unavailable",
|
|
378
|
+
* "timeUntilEventEnd": 0,
|
|
379
|
+
* "timeUntilEventEndFormatted": "unavailable",
|
|
380
|
+
* "shuffleAtEventStart": false
|
|
381
|
+
* }
|
|
382
|
+
* }
|
|
383
|
+
*
|
|
384
|
+
* If `jsonResponseEnabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **random** and an event is active could be:
|
|
385
|
+
*
|
|
386
|
+
* {
|
|
387
|
+
* "cfWaitingRoom": {
|
|
388
|
+
* "inWaitingRoom": true,
|
|
389
|
+
* "waitTimeKnown": true,
|
|
390
|
+
* "waitTime": 10,
|
|
391
|
+
* "waitTime25Percentile": 5,
|
|
392
|
+
* "waitTime50Percentile": 10,
|
|
393
|
+
* "waitTime75Percentile": 15,
|
|
394
|
+
* "waitTimeFormatted": "5 minutes to 15 minutes",
|
|
395
|
+
* "queueIsFull": false,
|
|
396
|
+
* "queueAll": false,
|
|
397
|
+
* "lastUpdated": "2020-08-03T23:46:00.000Z",
|
|
398
|
+
* "refreshIntervalSeconds": 20,
|
|
399
|
+
* "queueingMethod": "random",
|
|
400
|
+
* "isFIFOQueue": false,
|
|
401
|
+
* "isRandomQueue": true,
|
|
402
|
+
* "isPassthroughQueue": false,
|
|
403
|
+
* "isRejectQueue": false,
|
|
404
|
+
* "isEventActive": true,
|
|
405
|
+
* "isEventPrequeueing": false,
|
|
406
|
+
* "timeUntilEventStart": 0,
|
|
407
|
+
* "timeUntilEventStartFormatted": "unavailable",
|
|
408
|
+
* "timeUntilEventEnd": 15,
|
|
409
|
+
* "timeUntilEventEndFormatted": "15 minutes",
|
|
410
|
+
* "shuffleAtEventStart": true
|
|
411
|
+
* }
|
|
412
|
+
* }
|
|
376
413
|
*/
|
|
377
414
|
jsonResponseEnabled?: pulumi.Input<boolean>;
|
|
378
415
|
modifiedOn?: pulumi.Input<string>;
|
|
@@ -393,43 +430,29 @@ export interface WaitingRoomState {
|
|
|
393
430
|
*/
|
|
394
431
|
nextEventStartTime?: pulumi.Input<string>;
|
|
395
432
|
/**
|
|
396
|
-
* Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well.
|
|
397
|
-
* If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen.
|
|
398
|
-
* Wildcards and query parameters are not supported.
|
|
433
|
+
* Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
|
|
399
434
|
*/
|
|
400
435
|
path?: pulumi.Input<string>;
|
|
401
436
|
/**
|
|
402
|
-
* If queueAll is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can
|
|
403
|
-
* get to the route once this field is set and estimated time will become unavailable.
|
|
437
|
+
* If queueAll is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.
|
|
404
438
|
*/
|
|
405
439
|
queueAll?: pulumi.Input<boolean>;
|
|
406
440
|
/**
|
|
407
|
-
* Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
* waiting room
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
* waiting room and into the origin website. As a result, any configured limits will not be respected while this is
|
|
414
|
-
* enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are
|
|
415
|
-
* still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a
|
|
416
|
-
* waiting room event, or vice versa. 4. `reject`: Users will be immediately rejected from the waiting room. As a result,
|
|
417
|
-
* no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while
|
|
418
|
-
* performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are
|
|
419
|
-
* not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and
|
|
420
|
-
* otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`,
|
|
421
|
-
* `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is
|
|
422
|
-
* prequeueing, the waiting room page **will not refresh automatically**. Available values: "fifo", "random",
|
|
423
|
-
* "passthrough", "reject".
|
|
441
|
+
* Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queueAll` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:
|
|
442
|
+
* 1. `fifo` **(default)**: First-In-First-Out queue where customers gain access in the order they arrived.
|
|
443
|
+
* 2. `random`: Random queue where customers gain access randomly, regardless of arrival time.
|
|
444
|
+
* 3. `passthrough`: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.
|
|
445
|
+
* 4. `reject`: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`, `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**.
|
|
446
|
+
* Available values: "fifo", "random", "passthrough", "reject".
|
|
424
447
|
*/
|
|
425
448
|
queueingMethod?: pulumi.Input<string>;
|
|
426
449
|
/**
|
|
427
|
-
* HTTP status code returned to a user while in the queue.
|
|
450
|
+
* HTTP status code returned to a user while in the queue.
|
|
451
|
+
* Available values: 200, 202, 429.
|
|
428
452
|
*/
|
|
429
453
|
queueingStatusCode?: pulumi.Input<number>;
|
|
430
454
|
/**
|
|
431
|
-
* Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by
|
|
432
|
-
* Cloudflare again in that time period, they will be treated as a new user that visits the route.
|
|
455
|
+
* Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.
|
|
433
456
|
*/
|
|
434
457
|
sessionDuration?: pulumi.Input<number>;
|
|
435
458
|
/**
|
|
@@ -441,18 +464,21 @@ export interface WaitingRoomState {
|
|
|
441
464
|
*/
|
|
442
465
|
totalActiveUsers?: pulumi.Input<number>;
|
|
443
466
|
/**
|
|
444
|
-
* Which action to take when a bot is detected using Turnstile. `log` will
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
467
|
+
* Which action to take when a bot is detected using Turnstile. `log` will
|
|
468
|
+
* have no impact on queueing behavior, simply keeping track of how many
|
|
469
|
+
* bots are detected in Waiting Room Analytics. `infiniteQueue` will send
|
|
470
|
+
* bots to a false queueing state, where they will never reach your
|
|
471
|
+
* origin. `infiniteQueue` requires Advanced Waiting Room.
|
|
472
|
+
* Available values: "log", "infiniteQueue".
|
|
448
473
|
*/
|
|
449
474
|
turnstileAction?: pulumi.Input<string>;
|
|
450
475
|
/**
|
|
451
|
-
* Which Turnstile widget type to use for detecting bot traffic. See
|
|
452
|
-
* documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types)
|
|
453
|
-
* widget types. Set to `off` to disable the
|
|
454
|
-
*
|
|
455
|
-
*
|
|
476
|
+
* Which Turnstile widget type to use for detecting bot traffic. See
|
|
477
|
+
* [the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types)
|
|
478
|
+
* for the definitions of these widget types. Set to `off` to disable the
|
|
479
|
+
* Turnstile integration entirely. Setting this to anything other than
|
|
480
|
+
* `off` or `invisible` requires Advanced Waiting Room.
|
|
481
|
+
* Available values: "off", "invisible", "visibleNonInteractive", "visibleManaged".
|
|
456
482
|
*/
|
|
457
483
|
turnstileMode?: pulumi.Input<string>;
|
|
458
484
|
/**
|
|
@@ -481,11 +507,8 @@ export interface WaitingRoomArgs {
|
|
|
481
507
|
*/
|
|
482
508
|
customPageHtml?: pulumi.Input<string>;
|
|
483
509
|
/**
|
|
484
|
-
* The language of the default page template. If no defaultTemplateLanguage is provided, then `en-US` (English) will be
|
|
485
|
-
*
|
|
486
|
-
* "nl-NL", "pl-PL", "id-ID", "tr-TR", "ar-EG", "ru-RU", "fa-IR", "bg-BG", "hr-HR", "cs-CZ", "da-DK", "fi-FI", "lt-LT",
|
|
487
|
-
* "ms-MY", "nb-NO", "ro-RO", "el-GR", "he-IL", "hi-IN", "hu-HU", "sr-BA", "sk-SK", "sl-SI", "sv-SE", "tl-PH", "th-TH",
|
|
488
|
-
* "uk-UA", "vi-VN".
|
|
510
|
+
* The language of the default page template. If no defaultTemplateLanguage is provided, then `en-US` (English) will be used.
|
|
511
|
+
* Available values: "en-US", "es-ES", "de-DE", "fr-FR", "it-IT", "ja-JP", "ko-KR", "pt-BR", "zh-CN", "zh-TW", "nl-NL", "pl-PL", "id-ID", "tr-TR", "ar-EG", "ru-RU", "fa-IR", "bg-BG", "hr-HR", "cs-CZ", "da-DK", "fi-FI", "lt-LT", "ms-MY", "nb-NO", "ro-RO", "el-GR", "he-IL", "hi-IN", "hu-HU", "sr-BA", "sk-SK", "sl-SI", "sv-SE", "tl-PH", "th-TH", "uk-UA", "vi-VN".
|
|
489
512
|
*/
|
|
490
513
|
defaultTemplateLanguage?: pulumi.Input<string>;
|
|
491
514
|
/**
|
|
@@ -493,9 +516,7 @@ export interface WaitingRoomArgs {
|
|
|
493
516
|
*/
|
|
494
517
|
description?: pulumi.Input<string>;
|
|
495
518
|
/**
|
|
496
|
-
* Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an
|
|
497
|
-
* accepted user will have sessionDuration minutes to browse the site. After that, they will have to go through the waiting
|
|
498
|
-
* room again. If `false`, a user's session cookie will be automatically renewed on every request.
|
|
519
|
+
* Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have sessionDuration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request.
|
|
499
520
|
*/
|
|
500
521
|
disableSessionRenewal?: pulumi.Input<boolean>;
|
|
501
522
|
/**
|
|
@@ -507,68 +528,97 @@ export interface WaitingRoomArgs {
|
|
|
507
528
|
*/
|
|
508
529
|
host: pulumi.Input<string>;
|
|
509
530
|
/**
|
|
510
|
-
* Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header
|
|
511
|
-
*
|
|
512
|
-
*
|
|
513
|
-
*
|
|
514
|
-
*
|
|
515
|
-
*
|
|
516
|
-
*
|
|
517
|
-
*
|
|
518
|
-
* `
|
|
519
|
-
*
|
|
520
|
-
* `
|
|
521
|
-
*
|
|
522
|
-
*
|
|
523
|
-
*
|
|
524
|
-
*
|
|
525
|
-
*
|
|
526
|
-
*
|
|
527
|
-
*
|
|
528
|
-
*
|
|
529
|
-
*
|
|
530
|
-
*
|
|
531
|
-
* `
|
|
532
|
-
* `
|
|
533
|
-
*
|
|
534
|
-
* `
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
*
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
*
|
|
543
|
-
*
|
|
544
|
-
*
|
|
545
|
-
*
|
|
546
|
-
*
|
|
547
|
-
*
|
|
548
|
-
*
|
|
549
|
-
*
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
-
*
|
|
555
|
-
*
|
|
556
|
-
*
|
|
557
|
-
*
|
|
558
|
-
*
|
|
559
|
-
*
|
|
560
|
-
*
|
|
561
|
-
*
|
|
562
|
-
*
|
|
563
|
-
*
|
|
564
|
-
*
|
|
565
|
-
*
|
|
566
|
-
*
|
|
567
|
-
*
|
|
568
|
-
*
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
*
|
|
531
|
+
* Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields:
|
|
532
|
+
* 1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).
|
|
533
|
+
* 2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.
|
|
534
|
+
* 3. `waitTime`: Valid only when `waitTimeKnown` is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When `queueingMethod` is **random**, this is set to `waitTime50Percentile`.
|
|
535
|
+
* 4. `waitTime25Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).
|
|
536
|
+
* 5. `waitTime50Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before `waitTime50Percentile` and half are expected to be let in after it.
|
|
537
|
+
* 6. `waitTime75Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).
|
|
538
|
+
* 7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.
|
|
539
|
+
* 8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.
|
|
540
|
+
* 9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.
|
|
541
|
+
* 10. `lastUpdated`: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after `refreshIntervalSeconds` past this time. If the user makes a request too soon, it will be ignored and `lastUpdated` will not change.
|
|
542
|
+
* 11. `refreshIntervalSeconds`: Integer indicating the number of seconds after `lastUpdated` until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the `queueingMethod` is `reject`, there is no specified refresh time —\_it will always be **zero**.
|
|
543
|
+
* 12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.
|
|
544
|
+
* 13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.
|
|
545
|
+
* 14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.
|
|
546
|
+
* 15. `isPassthroughQueue`: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when `queueAll` is **true** or `isEventPrequeueing` is **true** because in all other cases requests will go directly to the origin.
|
|
547
|
+
* 16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.
|
|
548
|
+
* 17. `isEventActive`: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties `prequeueStartTime`, `eventStartTime`, and `eventEndTime` in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.
|
|
549
|
+
* 18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.
|
|
550
|
+
* 19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.
|
|
551
|
+
* 20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.
|
|
552
|
+
* 21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.
|
|
553
|
+
* 22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.
|
|
554
|
+
* 23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.
|
|
555
|
+
* 24. `turnstile`: Empty when turnstile isn't enabled. String displaying an html tag to display the Turnstile widget. Please add the `{{{turnstile}}}` tag to the `customHtml` template to ensure the Turnstile widget appears.
|
|
556
|
+
* 25. `infiniteQueue`: Boolean indicating whether the response is for a user in the infinite queue.
|
|
557
|
+
*
|
|
558
|
+
* An example cURL to a waiting room could be:
|
|
559
|
+
*
|
|
560
|
+
* curl -X GET "https://example.com/waitingroom" \
|
|
561
|
+
* -H "Accept: application/json"
|
|
562
|
+
*
|
|
563
|
+
* If `jsonResponseEnabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **fifo** and no event is active could be:
|
|
564
|
+
*
|
|
565
|
+
* {
|
|
566
|
+
* "cfWaitingRoom": {
|
|
567
|
+
* "inWaitingRoom": true,
|
|
568
|
+
* "waitTimeKnown": true,
|
|
569
|
+
* "waitTime": 10,
|
|
570
|
+
* "waitTime25Percentile": 0,
|
|
571
|
+
* "waitTime50Percentile": 0,
|
|
572
|
+
* "waitTime75Percentile": 0,
|
|
573
|
+
* "waitTimeFormatted": "10 minutes",
|
|
574
|
+
* "queueIsFull": false,
|
|
575
|
+
* "queueAll": false,
|
|
576
|
+
* "lastUpdated": "2020-08-03T23:46:00.000Z",
|
|
577
|
+
* "refreshIntervalSeconds": 20,
|
|
578
|
+
* "queueingMethod": "fifo",
|
|
579
|
+
* "isFIFOQueue": true,
|
|
580
|
+
* "isRandomQueue": false,
|
|
581
|
+
* "isPassthroughQueue": false,
|
|
582
|
+
* "isRejectQueue": false,
|
|
583
|
+
* "isEventActive": false,
|
|
584
|
+
* "isEventPrequeueing": false,
|
|
585
|
+
* "timeUntilEventStart": 0,
|
|
586
|
+
* "timeUntilEventStartFormatted": "unavailable",
|
|
587
|
+
* "timeUntilEventEnd": 0,
|
|
588
|
+
* "timeUntilEventEndFormatted": "unavailable",
|
|
589
|
+
* "shuffleAtEventStart": false
|
|
590
|
+
* }
|
|
591
|
+
* }
|
|
592
|
+
*
|
|
593
|
+
* If `jsonResponseEnabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **random** and an event is active could be:
|
|
594
|
+
*
|
|
595
|
+
* {
|
|
596
|
+
* "cfWaitingRoom": {
|
|
597
|
+
* "inWaitingRoom": true,
|
|
598
|
+
* "waitTimeKnown": true,
|
|
599
|
+
* "waitTime": 10,
|
|
600
|
+
* "waitTime25Percentile": 5,
|
|
601
|
+
* "waitTime50Percentile": 10,
|
|
602
|
+
* "waitTime75Percentile": 15,
|
|
603
|
+
* "waitTimeFormatted": "5 minutes to 15 minutes",
|
|
604
|
+
* "queueIsFull": false,
|
|
605
|
+
* "queueAll": false,
|
|
606
|
+
* "lastUpdated": "2020-08-03T23:46:00.000Z",
|
|
607
|
+
* "refreshIntervalSeconds": 20,
|
|
608
|
+
* "queueingMethod": "random",
|
|
609
|
+
* "isFIFOQueue": false,
|
|
610
|
+
* "isRandomQueue": true,
|
|
611
|
+
* "isPassthroughQueue": false,
|
|
612
|
+
* "isRejectQueue": false,
|
|
613
|
+
* "isEventActive": true,
|
|
614
|
+
* "isEventPrequeueing": false,
|
|
615
|
+
* "timeUntilEventStart": 0,
|
|
616
|
+
* "timeUntilEventStartFormatted": "unavailable",
|
|
617
|
+
* "timeUntilEventEnd": 15,
|
|
618
|
+
* "timeUntilEventEndFormatted": "15 minutes",
|
|
619
|
+
* "shuffleAtEventStart": true
|
|
620
|
+
* }
|
|
621
|
+
* }
|
|
572
622
|
*/
|
|
573
623
|
jsonResponseEnabled?: pulumi.Input<boolean>;
|
|
574
624
|
/**
|
|
@@ -580,43 +630,29 @@ export interface WaitingRoomArgs {
|
|
|
580
630
|
*/
|
|
581
631
|
newUsersPerMinute: pulumi.Input<number>;
|
|
582
632
|
/**
|
|
583
|
-
* Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well.
|
|
584
|
-
* If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen.
|
|
585
|
-
* Wildcards and query parameters are not supported.
|
|
633
|
+
* Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
|
|
586
634
|
*/
|
|
587
635
|
path?: pulumi.Input<string>;
|
|
588
636
|
/**
|
|
589
|
-
* If queueAll is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can
|
|
590
|
-
* get to the route once this field is set and estimated time will become unavailable.
|
|
637
|
+
* If queueAll is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.
|
|
591
638
|
*/
|
|
592
639
|
queueAll?: pulumi.Input<boolean>;
|
|
593
640
|
/**
|
|
594
|
-
* Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only
|
|
595
|
-
*
|
|
596
|
-
*
|
|
597
|
-
* waiting room
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
* waiting room and into the origin website. As a result, any configured limits will not be respected while this is
|
|
601
|
-
* enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are
|
|
602
|
-
* still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a
|
|
603
|
-
* waiting room event, or vice versa. 4. `reject`: Users will be immediately rejected from the waiting room. As a result,
|
|
604
|
-
* no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while
|
|
605
|
-
* performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are
|
|
606
|
-
* not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and
|
|
607
|
-
* otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`,
|
|
608
|
-
* `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is
|
|
609
|
-
* prequeueing, the waiting room page **will not refresh automatically**. Available values: "fifo", "random",
|
|
610
|
-
* "passthrough", "reject".
|
|
641
|
+
* Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queueAll` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:
|
|
642
|
+
* 1. `fifo` **(default)**: First-In-First-Out queue where customers gain access in the order they arrived.
|
|
643
|
+
* 2. `random`: Random queue where customers gain access randomly, regardless of arrival time.
|
|
644
|
+
* 3. `passthrough`: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.
|
|
645
|
+
* 4. `reject`: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`, `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**.
|
|
646
|
+
* Available values: "fifo", "random", "passthrough", "reject".
|
|
611
647
|
*/
|
|
612
648
|
queueingMethod?: pulumi.Input<string>;
|
|
613
649
|
/**
|
|
614
|
-
* HTTP status code returned to a user while in the queue.
|
|
650
|
+
* HTTP status code returned to a user while in the queue.
|
|
651
|
+
* Available values: 200, 202, 429.
|
|
615
652
|
*/
|
|
616
653
|
queueingStatusCode?: pulumi.Input<number>;
|
|
617
654
|
/**
|
|
618
|
-
* Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by
|
|
619
|
-
* Cloudflare again in that time period, they will be treated as a new user that visits the route.
|
|
655
|
+
* Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.
|
|
620
656
|
*/
|
|
621
657
|
sessionDuration?: pulumi.Input<number>;
|
|
622
658
|
/**
|
|
@@ -628,18 +664,21 @@ export interface WaitingRoomArgs {
|
|
|
628
664
|
*/
|
|
629
665
|
totalActiveUsers: pulumi.Input<number>;
|
|
630
666
|
/**
|
|
631
|
-
* Which action to take when a bot is detected using Turnstile. `log` will
|
|
632
|
-
*
|
|
633
|
-
*
|
|
634
|
-
*
|
|
667
|
+
* Which action to take when a bot is detected using Turnstile. `log` will
|
|
668
|
+
* have no impact on queueing behavior, simply keeping track of how many
|
|
669
|
+
* bots are detected in Waiting Room Analytics. `infiniteQueue` will send
|
|
670
|
+
* bots to a false queueing state, where they will never reach your
|
|
671
|
+
* origin. `infiniteQueue` requires Advanced Waiting Room.
|
|
672
|
+
* Available values: "log", "infiniteQueue".
|
|
635
673
|
*/
|
|
636
674
|
turnstileAction?: pulumi.Input<string>;
|
|
637
675
|
/**
|
|
638
|
-
* Which Turnstile widget type to use for detecting bot traffic. See
|
|
639
|
-
* documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types)
|
|
640
|
-
* widget types. Set to `off` to disable the
|
|
641
|
-
*
|
|
642
|
-
*
|
|
676
|
+
* Which Turnstile widget type to use for detecting bot traffic. See
|
|
677
|
+
* [the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types)
|
|
678
|
+
* for the definitions of these widget types. Set to `off` to disable the
|
|
679
|
+
* Turnstile integration entirely. Setting this to anything other than
|
|
680
|
+
* `off` or `invisible` requires Advanced Waiting Room.
|
|
681
|
+
* Available values: "off", "invisible", "visibleNonInteractive", "visibleManaged".
|
|
643
682
|
*/
|
|
644
683
|
turnstileMode?: pulumi.Input<string>;
|
|
645
684
|
/**
|