@pulumi/cloudflare 6.7.0-alpha.1756491364 → 6.7.0
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/accessMutualTlsCertificate.d.ts +1 -1
- package/accessOrganization.d.ts +2 -2
- package/argoSmartRouting.d.ts +19 -3
- package/argoSmartRouting.js +4 -0
- package/argoSmartRouting.js.map +1 -1
- package/botManagement.d.ts +13 -0
- package/botManagement.js +3 -0
- package/botManagement.js.map +1 -1
- package/certificatePack.d.ts +18 -0
- package/certificatePack.js +4 -0
- package/certificatePack.js.map +1 -1
- package/customPages.d.ts +3 -3
- package/filter.d.ts +28 -6
- package/filter.js +13 -6
- package/filter.js.map +1 -1
- package/getArgoSmartRouting.d.ts +14 -1
- package/getArgoSmartRouting.js.map +1 -1
- package/getBotManagement.d.ts +4 -0
- package/getBotManagement.js.map +1 -1
- package/getCustomPages.d.ts +3 -3
- package/getList.d.ts +3 -3
- package/getListItem.d.ts +30 -1
- package/getListItem.js.map +1 -1
- package/getLoadBalancer.d.ts +6 -5
- package/getLoadBalancer.js.map +1 -1
- package/getLoadBalancerMonitor.d.ts +3 -3
- package/getLoadBalancerMonitors.d.ts +3 -3
- package/getLoadBalancerPool.d.ts +3 -3
- package/getLoadBalancerPools.d.ts +3 -3
- package/getLogpushDatasetField.d.ts +3 -3
- package/getLogpushDatasetJob.d.ts +9 -9
- package/getLogpushJob.d.ts +6 -6
- package/getR2CustomDomain.d.ts +4 -0
- package/getR2CustomDomain.js.map +1 -1
- package/getSnippet.d.ts +80 -0
- package/getSnippet.js +50 -0
- package/getSnippet.js.map +1 -0
- package/getSnippetList.d.ts +51 -0
- package/getSnippetList.js +24 -0
- package/getSnippetList.js.map +1 -0
- package/getSnippets.d.ts +0 -2
- package/getSnippets.js +0 -2
- package/getSnippets.js.map +1 -1
- package/getSnippetsList.d.ts +0 -24
- package/getSnippetsList.js +0 -24
- package/getSnippetsList.js.map +1 -1
- package/getStreams.d.ts +17 -3
- package/getStreams.js +4 -0
- package/getStreams.js.map +1 -1
- package/getUrlNormalizationSettings.d.ts +1 -1
- package/getWorkersForPlatformsDispatchNamespace.d.ts +4 -0
- package/getWorkersForPlatformsDispatchNamespace.js.map +1 -1
- package/getWorkersScripts.d.ts +14 -0
- package/getWorkersScripts.js +4 -0
- package/getWorkersScripts.js.map +1 -1
- package/getZeroTrustGatewayCertificate.d.ts +7 -7
- package/getZeroTrustGatewayPolicy.d.ts +0 -3
- package/getZeroTrustGatewayPolicy.js.map +1 -1
- package/getZeroTrustTunnelCloudflared.d.ts +7 -0
- package/getZeroTrustTunnelCloudflared.js.map +1 -1
- package/getZeroTrustTunnelCloudflaredRoutes.d.ts +1 -3
- package/getZeroTrustTunnelCloudflaredRoutes.js +0 -2
- package/getZeroTrustTunnelCloudflaredRoutes.js.map +1 -1
- package/getZeroTrustTunnelWarpConnector.d.ts +7 -0
- package/getZeroTrustTunnelWarpConnector.js.map +1 -1
- package/index.d.ts +9 -0
- package/index.js +21 -10
- package/index.js.map +1 -1
- package/loadBalancer.d.ts +12 -9
- package/loadBalancer.js.map +1 -1
- package/loadBalancerMonitor.d.ts +10 -10
- package/loadBalancerPool.d.ts +3 -3
- package/logpushJob.d.ts +16 -16
- package/logpushOwnershipChallenge.d.ts +3 -3
- package/magicWanGreTunnel.d.ts +38 -0
- package/magicWanGreTunnel.js +28 -0
- package/magicWanGreTunnel.js.map +1 -1
- package/magicWanIpsecTunnel.d.ts +38 -0
- package/magicWanIpsecTunnel.js +28 -0
- package/magicWanIpsecTunnel.js.map +1 -1
- package/package.json +2 -2
- package/r2customDomain.d.ts +13 -0
- package/r2customDomain.js +3 -0
- package/r2customDomain.js.map +1 -1
- package/ruleset.d.ts +23 -7
- package/ruleset.js +4 -0
- package/ruleset.js.map +1 -1
- package/snippet.d.ts +105 -0
- package/snippet.js +74 -0
- package/snippet.js.map +1 -0
- package/snippetRules.d.ts +0 -40
- package/snippetRules.js +0 -10
- package/snippetRules.js.map +1 -1
- package/snippets.d.ts +0 -3
- package/snippets.js +0 -3
- package/snippets.js.map +1 -1
- package/spectrumApplication.d.ts +5 -5
- package/spectrumApplication.js +3 -3
- package/teamsList.d.ts +1 -1
- package/teamsRule.d.ts +1 -28
- package/teamsRule.js.map +1 -1
- package/tunnel.d.ts +4 -0
- package/tunnel.js.map +1 -1
- package/tunnelRoute.d.ts +1 -1
- package/tunnelVirtualNetwork.d.ts +1 -1
- package/types/input.d.ts +215 -187
- package/types/output.d.ts +372 -266
- package/urlNormalizationSettings.d.ts +3 -3
- package/workerScript.d.ts +46 -28
- package/workerScript.js +1 -1
- package/workerScript.js.map +1 -1
- package/workersForPlatformsDispatchNamespace.d.ts +8 -0
- package/workersForPlatformsDispatchNamespace.js +2 -0
- package/workersForPlatformsDispatchNamespace.js.map +1 -1
- package/workersForPlatformsNamespace.d.ts +8 -0
- package/workersForPlatformsNamespace.js +2 -0
- package/workersForPlatformsNamespace.js.map +1 -1
- package/workersKv.d.ts +9 -0
- package/workersKv.js.map +1 -1
- package/workersScript.d.ts +46 -28
- package/workersScript.js +1 -1
- package/workersScript.js.map +1 -1
- package/zeroTrustAccessMtlsCertificate.d.ts +1 -1
- package/zeroTrustGatewayCertificate.d.ts +14 -14
- package/zeroTrustGatewayPolicy.d.ts +1 -28
- package/zeroTrustGatewayPolicy.js.map +1 -1
- package/zeroTrustList.d.ts +1 -1
- package/zeroTrustOrganization.d.ts +2 -2
- package/zeroTrustTunnelCloudflared.d.ts +4 -0
- package/zeroTrustTunnelCloudflared.js.map +1 -1
- package/zeroTrustTunnelCloudflaredRoute.d.ts +1 -1
- package/zeroTrustTunnelCloudflaredVirtualNetwork.d.ts +1 -1
- package/zeroTrustTunnelWarpConnector.d.ts +14 -0
- package/zeroTrustTunnelWarpConnector.js +2 -0
- package/zeroTrustTunnelWarpConnector.js.map +1 -1
package/types/output.d.ts
CHANGED
|
@@ -3163,6 +3163,34 @@ export interface BotManagementStaleZoneConfiguration {
|
|
|
3163
3163
|
*/
|
|
3164
3164
|
suppressSessionScore: boolean;
|
|
3165
3165
|
}
|
|
3166
|
+
export interface CertificatePackValidationError {
|
|
3167
|
+
/**
|
|
3168
|
+
* A domain validation error.
|
|
3169
|
+
*/
|
|
3170
|
+
message: string;
|
|
3171
|
+
}
|
|
3172
|
+
export interface CertificatePackValidationRecord {
|
|
3173
|
+
/**
|
|
3174
|
+
* The set of email addresses that the certificate authority (CA) will use to complete domain validation.
|
|
3175
|
+
*/
|
|
3176
|
+
emails: string[];
|
|
3177
|
+
/**
|
|
3178
|
+
* The content that the certificate authority (CA) will expect to find at the httpUrl during the domain validation.
|
|
3179
|
+
*/
|
|
3180
|
+
httpBody: string;
|
|
3181
|
+
/**
|
|
3182
|
+
* The url that will be checked during domain validation.
|
|
3183
|
+
*/
|
|
3184
|
+
httpUrl: string;
|
|
3185
|
+
/**
|
|
3186
|
+
* The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
|
|
3187
|
+
*/
|
|
3188
|
+
txtName: string;
|
|
3189
|
+
/**
|
|
3190
|
+
* The TXT record that the certificate authority (CA) will check during domain validation.
|
|
3191
|
+
*/
|
|
3192
|
+
txtValue: string;
|
|
3193
|
+
}
|
|
3166
3194
|
export interface CloudConnectorRulesRule {
|
|
3167
3195
|
description?: string;
|
|
3168
3196
|
enabled?: boolean;
|
|
@@ -3687,13 +3715,13 @@ export interface DnsRecordData {
|
|
|
3687
3715
|
*/
|
|
3688
3716
|
digestType?: number;
|
|
3689
3717
|
/**
|
|
3690
|
-
*
|
|
3718
|
+
* Fingerprint.
|
|
3691
3719
|
*/
|
|
3692
3720
|
fingerprint?: string;
|
|
3693
3721
|
/**
|
|
3694
3722
|
* Flags for the CAA record.
|
|
3695
3723
|
*/
|
|
3696
|
-
flags?:
|
|
3724
|
+
flags?: any;
|
|
3697
3725
|
/**
|
|
3698
3726
|
* Key Tag.
|
|
3699
3727
|
*/
|
|
@@ -3757,7 +3785,7 @@ export interface DnsRecordData {
|
|
|
3757
3785
|
*/
|
|
3758
3786
|
preference?: number;
|
|
3759
3787
|
/**
|
|
3760
|
-
*
|
|
3788
|
+
* Priority.
|
|
3761
3789
|
*/
|
|
3762
3790
|
priority?: number;
|
|
3763
3791
|
/**
|
|
@@ -3793,7 +3821,7 @@ export interface DnsRecordData {
|
|
|
3793
3821
|
*/
|
|
3794
3822
|
tag?: string;
|
|
3795
3823
|
/**
|
|
3796
|
-
*
|
|
3824
|
+
* Target.
|
|
3797
3825
|
*/
|
|
3798
3826
|
target?: string;
|
|
3799
3827
|
/**
|
|
@@ -3996,6 +4024,28 @@ export interface EmailSecurityTrustedDomainsBody {
|
|
|
3996
4024
|
isSimilarity: boolean;
|
|
3997
4025
|
pattern: string;
|
|
3998
4026
|
}
|
|
4027
|
+
export interface FilterBody {
|
|
4028
|
+
/**
|
|
4029
|
+
* An informative summary of the filter.
|
|
4030
|
+
*/
|
|
4031
|
+
description?: string;
|
|
4032
|
+
/**
|
|
4033
|
+
* The filter expression. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).
|
|
4034
|
+
*/
|
|
4035
|
+
expression?: string;
|
|
4036
|
+
/**
|
|
4037
|
+
* The unique identifier of the filter.
|
|
4038
|
+
*/
|
|
4039
|
+
id: string;
|
|
4040
|
+
/**
|
|
4041
|
+
* When true, indicates that the filter is currently paused.
|
|
4042
|
+
*/
|
|
4043
|
+
paused?: boolean;
|
|
4044
|
+
/**
|
|
4045
|
+
* A short reference tag. Allows you to select related filters.
|
|
4046
|
+
*/
|
|
4047
|
+
ref?: string;
|
|
4048
|
+
}
|
|
3999
4049
|
export interface FirewallRuleAction {
|
|
4000
4050
|
/**
|
|
4001
4051
|
* The action to perform.
|
|
@@ -6797,7 +6847,7 @@ export interface GetDnsRecordData {
|
|
|
6797
6847
|
*/
|
|
6798
6848
|
digestType: number;
|
|
6799
6849
|
/**
|
|
6800
|
-
*
|
|
6850
|
+
* Fingerprint.
|
|
6801
6851
|
*/
|
|
6802
6852
|
fingerprint: string;
|
|
6803
6853
|
/**
|
|
@@ -6867,7 +6917,7 @@ export interface GetDnsRecordData {
|
|
|
6867
6917
|
*/
|
|
6868
6918
|
preference: number;
|
|
6869
6919
|
/**
|
|
6870
|
-
*
|
|
6920
|
+
* Priority.
|
|
6871
6921
|
*/
|
|
6872
6922
|
priority: number;
|
|
6873
6923
|
/**
|
|
@@ -6903,7 +6953,7 @@ export interface GetDnsRecordData {
|
|
|
6903
6953
|
*/
|
|
6904
6954
|
tag: string;
|
|
6905
6955
|
/**
|
|
6906
|
-
*
|
|
6956
|
+
* Target.
|
|
6907
6957
|
*/
|
|
6908
6958
|
target: string;
|
|
6909
6959
|
/**
|
|
@@ -7219,7 +7269,7 @@ export interface GetDnsRecordsResultData {
|
|
|
7219
7269
|
*/
|
|
7220
7270
|
digestType: number;
|
|
7221
7271
|
/**
|
|
7222
|
-
*
|
|
7272
|
+
* Fingerprint.
|
|
7223
7273
|
*/
|
|
7224
7274
|
fingerprint: string;
|
|
7225
7275
|
/**
|
|
@@ -7289,7 +7339,7 @@ export interface GetDnsRecordsResultData {
|
|
|
7289
7339
|
*/
|
|
7290
7340
|
preference: number;
|
|
7291
7341
|
/**
|
|
7292
|
-
*
|
|
7342
|
+
* Priority.
|
|
7293
7343
|
*/
|
|
7294
7344
|
priority: number;
|
|
7295
7345
|
/**
|
|
@@ -7325,7 +7375,7 @@ export interface GetDnsRecordsResultData {
|
|
|
7325
7375
|
*/
|
|
7326
7376
|
tag: string;
|
|
7327
7377
|
/**
|
|
7328
|
-
*
|
|
7378
|
+
* Target.
|
|
7329
7379
|
*/
|
|
7330
7380
|
target: string;
|
|
7331
7381
|
/**
|
|
@@ -8363,7 +8413,77 @@ export interface GetLeakedCredentialCheckRulesResult {
|
|
|
8363
8413
|
*/
|
|
8364
8414
|
username: string;
|
|
8365
8415
|
}
|
|
8416
|
+
export interface GetListItemHostname {
|
|
8417
|
+
/**
|
|
8418
|
+
* Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.
|
|
8419
|
+
*/
|
|
8420
|
+
excludeExactHostname: boolean;
|
|
8421
|
+
urlHostname: string;
|
|
8422
|
+
}
|
|
8423
|
+
export interface GetListItemRedirect {
|
|
8424
|
+
includeSubdomains: boolean;
|
|
8425
|
+
preservePathSuffix: boolean;
|
|
8426
|
+
preserveQueryString: boolean;
|
|
8427
|
+
sourceUrl: string;
|
|
8428
|
+
/**
|
|
8429
|
+
* Available values: 301, 302, 307, 308.
|
|
8430
|
+
*/
|
|
8431
|
+
statusCode: number;
|
|
8432
|
+
subpathMatching: boolean;
|
|
8433
|
+
targetUrl: string;
|
|
8434
|
+
}
|
|
8366
8435
|
export interface GetListItemsResult {
|
|
8436
|
+
/**
|
|
8437
|
+
* Defines a non-negative 32 bit integer.
|
|
8438
|
+
*/
|
|
8439
|
+
asn: number;
|
|
8440
|
+
/**
|
|
8441
|
+
* Defines an informative summary of the list item.
|
|
8442
|
+
*/
|
|
8443
|
+
comment: string;
|
|
8444
|
+
/**
|
|
8445
|
+
* The RFC 3339 timestamp of when the item was created.
|
|
8446
|
+
*/
|
|
8447
|
+
createdOn: string;
|
|
8448
|
+
/**
|
|
8449
|
+
* Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
|
|
8450
|
+
*/
|
|
8451
|
+
hostname: outputs.GetListItemsResultHostname;
|
|
8452
|
+
/**
|
|
8453
|
+
* Defines the unique ID of the item in the List.
|
|
8454
|
+
*/
|
|
8455
|
+
id: string;
|
|
8456
|
+
/**
|
|
8457
|
+
* An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
|
|
8458
|
+
*/
|
|
8459
|
+
ip: string;
|
|
8460
|
+
/**
|
|
8461
|
+
* The RFC 3339 timestamp of when the item was last modified.
|
|
8462
|
+
*/
|
|
8463
|
+
modifiedOn: string;
|
|
8464
|
+
/**
|
|
8465
|
+
* The definition of the redirect.
|
|
8466
|
+
*/
|
|
8467
|
+
redirect: outputs.GetListItemsResultRedirect;
|
|
8468
|
+
}
|
|
8469
|
+
export interface GetListItemsResultHostname {
|
|
8470
|
+
/**
|
|
8471
|
+
* Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.
|
|
8472
|
+
*/
|
|
8473
|
+
excludeExactHostname: boolean;
|
|
8474
|
+
urlHostname: string;
|
|
8475
|
+
}
|
|
8476
|
+
export interface GetListItemsResultRedirect {
|
|
8477
|
+
includeSubdomains: boolean;
|
|
8478
|
+
preservePathSuffix: boolean;
|
|
8479
|
+
preserveQueryString: boolean;
|
|
8480
|
+
sourceUrl: string;
|
|
8481
|
+
/**
|
|
8482
|
+
* Available values: 301, 302, 307, 308.
|
|
8483
|
+
*/
|
|
8484
|
+
statusCode: number;
|
|
8485
|
+
subpathMatching: boolean;
|
|
8486
|
+
targetUrl: string;
|
|
8367
8487
|
}
|
|
8368
8488
|
export interface GetListsResult {
|
|
8369
8489
|
/**
|
|
@@ -8835,7 +8955,7 @@ export interface GetLoadBalancerRuleOverrides {
|
|
|
8835
8955
|
*/
|
|
8836
8956
|
locationStrategy: outputs.GetLoadBalancerRuleOverridesLocationStrategy;
|
|
8837
8957
|
/**
|
|
8838
|
-
*
|
|
8958
|
+
* Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country*pool, then region*pool mapping if it exists else to default_pools.
|
|
8839
8959
|
*/
|
|
8840
8960
|
popPools: {
|
|
8841
8961
|
[key: string]: string[];
|
|
@@ -8851,7 +8971,8 @@ export interface GetLoadBalancerRuleOverrides {
|
|
|
8851
8971
|
[key: string]: string[];
|
|
8852
8972
|
};
|
|
8853
8973
|
/**
|
|
8854
|
-
* Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are:
|
|
8974
|
+
* Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ipCookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `sessionAffinityTtl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `sessionAffinityAttributes` for additional required configuration.
|
|
8975
|
+
* Available values: "none", "cookie", "ipCookie", "header".
|
|
8855
8976
|
*/
|
|
8856
8977
|
sessionAffinity: string;
|
|
8857
8978
|
/**
|
|
@@ -8859,7 +8980,7 @@ export interface GetLoadBalancerRuleOverrides {
|
|
|
8859
8980
|
*/
|
|
8860
8981
|
sessionAffinityAttributes: outputs.GetLoadBalancerRuleOverridesSessionAffinityAttributes;
|
|
8861
8982
|
/**
|
|
8862
|
-
* Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `sessionAffinity` policy are:
|
|
8983
|
+
* Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `sessionAffinity` policy are: - `"cookie"` / `"ipCookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.
|
|
8863
8984
|
*/
|
|
8864
8985
|
sessionAffinityTtl: number;
|
|
8865
8986
|
/**
|
|
@@ -8909,7 +9030,7 @@ export interface GetLoadBalancerRuleOverridesSessionAffinityAttributes {
|
|
|
8909
9030
|
*/
|
|
8910
9031
|
headers: string[];
|
|
8911
9032
|
/**
|
|
8912
|
-
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
|
|
9033
|
+
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.
|
|
8913
9034
|
*/
|
|
8914
9035
|
requireAllHeaders: boolean;
|
|
8915
9036
|
/**
|
|
@@ -8923,7 +9044,8 @@ export interface GetLoadBalancerRuleOverridesSessionAffinityAttributes {
|
|
|
8923
9044
|
*/
|
|
8924
9045
|
secure: string;
|
|
8925
9046
|
/**
|
|
8926
|
-
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:
|
|
9047
|
+
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.
|
|
9048
|
+
* Available values: "none", "temporary", "sticky".
|
|
8927
9049
|
*/
|
|
8928
9050
|
zeroDowntimeFailover: string;
|
|
8929
9051
|
}
|
|
@@ -8937,7 +9059,7 @@ export interface GetLoadBalancerSessionAffinityAttributes {
|
|
|
8937
9059
|
*/
|
|
8938
9060
|
headers: string[];
|
|
8939
9061
|
/**
|
|
8940
|
-
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
|
|
9062
|
+
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.
|
|
8941
9063
|
*/
|
|
8942
9064
|
requireAllHeaders: boolean;
|
|
8943
9065
|
/**
|
|
@@ -8951,7 +9073,8 @@ export interface GetLoadBalancerSessionAffinityAttributes {
|
|
|
8951
9073
|
*/
|
|
8952
9074
|
secure: string;
|
|
8953
9075
|
/**
|
|
8954
|
-
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:
|
|
9076
|
+
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.
|
|
9077
|
+
* Available values: "none", "temporary", "sticky".
|
|
8955
9078
|
*/
|
|
8956
9079
|
zeroDowntimeFailover: string;
|
|
8957
9080
|
}
|
|
@@ -8998,7 +9121,7 @@ export interface GetLoadBalancersResult {
|
|
|
8998
9121
|
*/
|
|
8999
9122
|
networks: string[];
|
|
9000
9123
|
/**
|
|
9001
|
-
*
|
|
9124
|
+
* Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country*pool, then region*pool mapping if it exists else to default_pools.
|
|
9002
9125
|
*/
|
|
9003
9126
|
popPools: {
|
|
9004
9127
|
[key: string]: string[];
|
|
@@ -9022,7 +9145,8 @@ export interface GetLoadBalancersResult {
|
|
|
9022
9145
|
*/
|
|
9023
9146
|
rules: outputs.GetLoadBalancersResultRule[];
|
|
9024
9147
|
/**
|
|
9025
|
-
* Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are:
|
|
9148
|
+
* Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ipCookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `sessionAffinityTtl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `sessionAffinityAttributes` for additional required configuration.
|
|
9149
|
+
* Available values: "none", "cookie", "ipCookie", "header".
|
|
9026
9150
|
*/
|
|
9027
9151
|
sessionAffinity: string;
|
|
9028
9152
|
/**
|
|
@@ -9030,7 +9154,7 @@ export interface GetLoadBalancersResult {
|
|
|
9030
9154
|
*/
|
|
9031
9155
|
sessionAffinityAttributes: outputs.GetLoadBalancersResultSessionAffinityAttributes;
|
|
9032
9156
|
/**
|
|
9033
|
-
* Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `sessionAffinity` policy are:
|
|
9157
|
+
* Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `sessionAffinity` policy are: - `"cookie"` / `"ipCookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.
|
|
9034
9158
|
*/
|
|
9035
9159
|
sessionAffinityTtl: number;
|
|
9036
9160
|
/**
|
|
@@ -9143,7 +9267,7 @@ export interface GetLoadBalancersResultRuleOverrides {
|
|
|
9143
9267
|
*/
|
|
9144
9268
|
locationStrategy: outputs.GetLoadBalancersResultRuleOverridesLocationStrategy;
|
|
9145
9269
|
/**
|
|
9146
|
-
*
|
|
9270
|
+
* Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country*pool, then region*pool mapping if it exists else to default_pools.
|
|
9147
9271
|
*/
|
|
9148
9272
|
popPools: {
|
|
9149
9273
|
[key: string]: string[];
|
|
@@ -9159,7 +9283,8 @@ export interface GetLoadBalancersResultRuleOverrides {
|
|
|
9159
9283
|
[key: string]: string[];
|
|
9160
9284
|
};
|
|
9161
9285
|
/**
|
|
9162
|
-
* Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are:
|
|
9286
|
+
* Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ipCookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `sessionAffinityTtl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `sessionAffinityAttributes` for additional required configuration.
|
|
9287
|
+
* Available values: "none", "cookie", "ipCookie", "header".
|
|
9163
9288
|
*/
|
|
9164
9289
|
sessionAffinity: string;
|
|
9165
9290
|
/**
|
|
@@ -9167,7 +9292,7 @@ export interface GetLoadBalancersResultRuleOverrides {
|
|
|
9167
9292
|
*/
|
|
9168
9293
|
sessionAffinityAttributes: outputs.GetLoadBalancersResultRuleOverridesSessionAffinityAttributes;
|
|
9169
9294
|
/**
|
|
9170
|
-
* Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `sessionAffinity` policy are:
|
|
9295
|
+
* Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `sessionAffinity` policy are: - `"cookie"` / `"ipCookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.
|
|
9171
9296
|
*/
|
|
9172
9297
|
sessionAffinityTtl: number;
|
|
9173
9298
|
/**
|
|
@@ -9217,7 +9342,7 @@ export interface GetLoadBalancersResultRuleOverridesSessionAffinityAttributes {
|
|
|
9217
9342
|
*/
|
|
9218
9343
|
headers: string[];
|
|
9219
9344
|
/**
|
|
9220
|
-
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
|
|
9345
|
+
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.
|
|
9221
9346
|
*/
|
|
9222
9347
|
requireAllHeaders: boolean;
|
|
9223
9348
|
/**
|
|
@@ -9231,7 +9356,8 @@ export interface GetLoadBalancersResultRuleOverridesSessionAffinityAttributes {
|
|
|
9231
9356
|
*/
|
|
9232
9357
|
secure: string;
|
|
9233
9358
|
/**
|
|
9234
|
-
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:
|
|
9359
|
+
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.
|
|
9360
|
+
* Available values: "none", "temporary", "sticky".
|
|
9235
9361
|
*/
|
|
9236
9362
|
zeroDowntimeFailover: string;
|
|
9237
9363
|
}
|
|
@@ -9245,7 +9371,7 @@ export interface GetLoadBalancersResultSessionAffinityAttributes {
|
|
|
9245
9371
|
*/
|
|
9246
9372
|
headers: string[];
|
|
9247
9373
|
/**
|
|
9248
|
-
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
|
|
9374
|
+
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.
|
|
9249
9375
|
*/
|
|
9250
9376
|
requireAllHeaders: boolean;
|
|
9251
9377
|
/**
|
|
@@ -9259,7 +9385,8 @@ export interface GetLoadBalancersResultSessionAffinityAttributes {
|
|
|
9259
9385
|
*/
|
|
9260
9386
|
secure: string;
|
|
9261
9387
|
/**
|
|
9262
|
-
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:
|
|
9388
|
+
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.
|
|
9389
|
+
* Available values: "none", "temporary", "sticky".
|
|
9263
9390
|
*/
|
|
9264
9391
|
zeroDowntimeFailover: string;
|
|
9265
9392
|
}
|
|
@@ -9370,11 +9497,11 @@ export interface GetLogpushJobOutputOptions {
|
|
|
9370
9497
|
export interface GetLogpushJobsResult {
|
|
9371
9498
|
/**
|
|
9372
9499
|
* Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).
|
|
9373
|
-
* Available values: "access*requests", "audit*logs", "biso*user*actions", "casb*findings", "device*posture*results", "dlp*forensic*copies", "dns*firewall*logs", "dns*logs", "email*security*alerts", "firewall*events", "gateway*dns", "gateway*http", "gateway*network", "http*requests", "magic*ids*detections", "nel*reports", "network*analytics*logs", "page*shield*events", "sinkhole*http*logs", "spectrum*events", "ssh*logs", "workers*trace*events", "zaraz*events", "zero*trust*network*sessions".
|
|
9500
|
+
* Available values: "access*requests", "audit*logs", "audit*logs*v2", "biso*user*actions", "casb*findings", "device*posture*results", "dlp*forensic*copies", "dns*firewall*logs", "dns*logs", "email*security*alerts", "firewall*events", "gateway*dns", "gateway*http", "gateway*network", "http*requests", "magic*ids*detections", "nel*reports", "network*analytics*logs", "page*shield*events", "sinkhole*http*logs", "spectrum*events", "ssh*logs", "workers*trace*events", "zaraz*events", "zero*trust*network*sessions".
|
|
9374
9501
|
*/
|
|
9375
9502
|
dataset: string;
|
|
9376
9503
|
/**
|
|
9377
|
-
* Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.
|
|
9504
|
+
* Uniquely identifies a resource (such as an s3 bucket) where data. will be pushed. Additional configuration parameters supported by the destination may be included.
|
|
9378
9505
|
*/
|
|
9379
9506
|
destinationConf: string;
|
|
9380
9507
|
/**
|
|
@@ -9382,11 +9509,11 @@ export interface GetLogpushJobsResult {
|
|
|
9382
9509
|
*/
|
|
9383
9510
|
enabled: boolean;
|
|
9384
9511
|
/**
|
|
9385
|
-
* If not null, the job is currently failing. Failures are usually repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error*message and last*error are set to null.
|
|
9512
|
+
* If not null, the job is currently failing. Failures are usually. repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error*message and last*error are set to null.
|
|
9386
9513
|
*/
|
|
9387
9514
|
errorMessage: string;
|
|
9388
9515
|
/**
|
|
9389
|
-
* This field is deprecated. Please use `max_upload_*` parameters instead. The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.
|
|
9516
|
+
* This field is deprecated. Please use `max_upload_*` parameters instead. . The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.
|
|
9390
9517
|
* Available values: "high", "low".
|
|
9391
9518
|
*
|
|
9392
9519
|
* @deprecated This attribute is deprecated.
|
|
@@ -9406,7 +9533,7 @@ export interface GetLogpushJobsResult {
|
|
|
9406
9533
|
*/
|
|
9407
9534
|
lastComplete: string;
|
|
9408
9535
|
/**
|
|
9409
|
-
* Records the last time the job failed. If not null, the job is currently failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the errorMessage field.
|
|
9536
|
+
* Records the last time the job failed. If not null, the job is currently. failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the errorMessage field.
|
|
9410
9537
|
*/
|
|
9411
9538
|
lastError: string;
|
|
9412
9539
|
/**
|
|
@@ -9428,7 +9555,7 @@ export interface GetLogpushJobsResult {
|
|
|
9428
9555
|
*/
|
|
9429
9556
|
maxUploadRecords: number;
|
|
9430
9557
|
/**
|
|
9431
|
-
* Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job.
|
|
9558
|
+
* Optional human readable job name. Not unique. Cloudflare suggests. that you set this to a meaningful string, like the domain name, to make it easier to identify your job.
|
|
9432
9559
|
*/
|
|
9433
9560
|
name: string;
|
|
9434
9561
|
/**
|
|
@@ -10174,36 +10301,20 @@ export interface GetMagicWanStaticRouteRouteScope {
|
|
|
10174
10301
|
coloRegions: string[];
|
|
10175
10302
|
}
|
|
10176
10303
|
export interface GetManagedTransformsManagedRequestHeader {
|
|
10177
|
-
/**
|
|
10178
|
-
* The Managed Transforms that this Managed Transform conflicts with.
|
|
10179
|
-
*/
|
|
10180
|
-
conflictsWiths: string[];
|
|
10181
10304
|
/**
|
|
10182
10305
|
* Whether the Managed Transform is enabled.
|
|
10183
10306
|
*/
|
|
10184
10307
|
enabled: boolean;
|
|
10185
|
-
/**
|
|
10186
|
-
* Whether the Managed Transform conflicts with the currently-enabled Managed Transforms.
|
|
10187
|
-
*/
|
|
10188
|
-
hasConflict: boolean;
|
|
10189
10308
|
/**
|
|
10190
10309
|
* The human-readable identifier of the Managed Transform.
|
|
10191
10310
|
*/
|
|
10192
10311
|
id: string;
|
|
10193
10312
|
}
|
|
10194
10313
|
export interface GetManagedTransformsManagedResponseHeader {
|
|
10195
|
-
/**
|
|
10196
|
-
* The Managed Transforms that this Managed Transform conflicts with.
|
|
10197
|
-
*/
|
|
10198
|
-
conflictsWiths: string[];
|
|
10199
10314
|
/**
|
|
10200
10315
|
* Whether the Managed Transform is enabled.
|
|
10201
10316
|
*/
|
|
10202
10317
|
enabled: boolean;
|
|
10203
|
-
/**
|
|
10204
|
-
* Whether the Managed Transform conflicts with the currently-enabled Managed Transforms.
|
|
10205
|
-
*/
|
|
10206
|
-
hasConflict: boolean;
|
|
10207
10318
|
/**
|
|
10208
10319
|
* The human-readable identifier of the Managed Transform.
|
|
10209
10320
|
*/
|
|
@@ -13561,6 +13672,20 @@ export interface GetSchemaValidationSchemasListResult {
|
|
|
13561
13672
|
*/
|
|
13562
13673
|
validationEnabled: boolean;
|
|
13563
13674
|
}
|
|
13675
|
+
export interface GetSnippetListResult {
|
|
13676
|
+
/**
|
|
13677
|
+
* The timestamp of when the snippet was created.
|
|
13678
|
+
*/
|
|
13679
|
+
createdOn: string;
|
|
13680
|
+
/**
|
|
13681
|
+
* The timestamp of when the snippet was last modified.
|
|
13682
|
+
*/
|
|
13683
|
+
modifiedOn: string;
|
|
13684
|
+
/**
|
|
13685
|
+
* The identifying name of the snippet.
|
|
13686
|
+
*/
|
|
13687
|
+
snippetName: string;
|
|
13688
|
+
}
|
|
13564
13689
|
export interface GetSnippetRulesListResult {
|
|
13565
13690
|
/**
|
|
13566
13691
|
* An informative description of the rule.
|
|
@@ -14721,6 +14846,10 @@ export interface GetWorkersForPlatformsDispatchNamespacesResult {
|
|
|
14721
14846
|
* The current number of scripts in this Dispatch Namespace.
|
|
14722
14847
|
*/
|
|
14723
14848
|
scriptCount: number;
|
|
14849
|
+
/**
|
|
14850
|
+
* Whether the Workers in the namespace are executed in a "trusted" manner. When a Worker is trusted, it has access to the shared caches for the zone in the Cache API, and has access to the `request.cf` object on incoming Requests. When a Worker is untrusted, caches are not shared across the zone, and `request.cf` is undefined. By default, Workers in a namespace are "untrusted".
|
|
14851
|
+
*/
|
|
14852
|
+
trustedWorkers: boolean;
|
|
14724
14853
|
}
|
|
14725
14854
|
export interface GetWorkersKvNamespaceFilter {
|
|
14726
14855
|
/**
|
|
@@ -22298,18 +22427,18 @@ export interface GetZeroTrustGatewayCategoriesListResultSubcategory {
|
|
|
22298
22427
|
}
|
|
22299
22428
|
export interface GetZeroTrustGatewayCertificatesResult {
|
|
22300
22429
|
/**
|
|
22301
|
-
* The deployment status of the certificate on Cloudflare's edge. Certificates in the 'available' (previously called 'active') state may be used for Gateway TLS interception.
|
|
22430
|
+
* The read only deployment status of the certificate on Cloudflare's edge. Certificates in the 'available' (previously called 'active') state may be used for Gateway TLS interception.
|
|
22302
22431
|
* Available values: "pending*deployment", "available", "pending*deletion", "inactive".
|
|
22303
22432
|
*/
|
|
22304
22433
|
bindingStatus: string;
|
|
22305
22434
|
/**
|
|
22306
|
-
* The CA certificate
|
|
22435
|
+
* The CA certificate(read only).
|
|
22307
22436
|
*/
|
|
22308
22437
|
certificate: string;
|
|
22309
22438
|
createdAt: string;
|
|
22310
22439
|
expiresOn: string;
|
|
22311
22440
|
/**
|
|
22312
|
-
* The SHA256 fingerprint of the certificate.
|
|
22441
|
+
* The SHA256 fingerprint of the certificate(read only).
|
|
22313
22442
|
*/
|
|
22314
22443
|
fingerprint: string;
|
|
22315
22444
|
/**
|
|
@@ -22317,19 +22446,19 @@ export interface GetZeroTrustGatewayCertificatesResult {
|
|
|
22317
22446
|
*/
|
|
22318
22447
|
id: string;
|
|
22319
22448
|
/**
|
|
22320
|
-
*
|
|
22449
|
+
* Read-only field that shows whether Gateway TLS interception is using this certificate. This value cannot be set directly. To configure the certificate for interception, use the Gateway configuration setting named certificate.
|
|
22321
22450
|
*/
|
|
22322
22451
|
inUse: boolean;
|
|
22323
22452
|
/**
|
|
22324
|
-
* The organization that issued the certificate.
|
|
22453
|
+
* The organization that issued the certificate(read only).
|
|
22325
22454
|
*/
|
|
22326
22455
|
issuerOrg: string;
|
|
22327
22456
|
/**
|
|
22328
|
-
* The entire issuer field of the certificate.
|
|
22457
|
+
* The entire issuer field of the certificate(read only).
|
|
22329
22458
|
*/
|
|
22330
22459
|
issuerRaw: string;
|
|
22331
22460
|
/**
|
|
22332
|
-
* The type of certificate, either BYO-PKI (custom) or Gateway-managed.
|
|
22461
|
+
* The type of certificate, either BYO-PKI (custom) or Gateway-managed(read only).
|
|
22333
22462
|
* Available values: "custom", "gatewayManaged".
|
|
22334
22463
|
*/
|
|
22335
22464
|
type: string;
|
|
@@ -22386,9 +22515,6 @@ export interface GetZeroTrustGatewayPoliciesResult {
|
|
|
22386
22515
|
* The description of the rule.
|
|
22387
22516
|
*/
|
|
22388
22517
|
description: string;
|
|
22389
|
-
/**
|
|
22390
|
-
* The wirefilter expression used for device posture check matching.
|
|
22391
|
-
*/
|
|
22392
22518
|
devicePosture: string;
|
|
22393
22519
|
/**
|
|
22394
22520
|
* True if the rule is enabled.
|
|
@@ -22407,9 +22533,6 @@ export interface GetZeroTrustGatewayPoliciesResult {
|
|
|
22407
22533
|
* The API resource UUID.
|
|
22408
22534
|
*/
|
|
22409
22535
|
id: string;
|
|
22410
|
-
/**
|
|
22411
|
-
* The wirefilter expression used for identity matching.
|
|
22412
|
-
*/
|
|
22413
22536
|
identity: string;
|
|
22414
22537
|
/**
|
|
22415
22538
|
* The name of the rule.
|
|
@@ -22436,9 +22559,6 @@ export interface GetZeroTrustGatewayPoliciesResult {
|
|
|
22436
22559
|
* account tag of account that created the rule
|
|
22437
22560
|
*/
|
|
22438
22561
|
sourceAccount: string;
|
|
22439
|
-
/**
|
|
22440
|
-
* The wirefilter expression used for traffic matching.
|
|
22441
|
-
*/
|
|
22442
22562
|
traffic: string;
|
|
22443
22563
|
updatedAt: string;
|
|
22444
22564
|
/**
|
|
@@ -22643,9 +22763,6 @@ export interface GetZeroTrustGatewayPoliciesResultRuleSettingsBlockPage {
|
|
|
22643
22763
|
targetUri: string;
|
|
22644
22764
|
}
|
|
22645
22765
|
export interface GetZeroTrustGatewayPoliciesResultRuleSettingsCheckSession {
|
|
22646
|
-
/**
|
|
22647
|
-
* Configure how fresh the session needs to be to be considered valid.
|
|
22648
|
-
*/
|
|
22649
22766
|
duration: string;
|
|
22650
22767
|
/**
|
|
22651
22768
|
* Set to true to enable session enforcement.
|
|
@@ -23005,9 +23122,6 @@ export interface GetZeroTrustGatewayPolicyRuleSettingsBlockPage {
|
|
|
23005
23122
|
targetUri: string;
|
|
23006
23123
|
}
|
|
23007
23124
|
export interface GetZeroTrustGatewayPolicyRuleSettingsCheckSession {
|
|
23008
|
-
/**
|
|
23009
|
-
* Configure how fresh the session needs to be to be considered valid.
|
|
23010
|
-
*/
|
|
23011
23125
|
duration: string;
|
|
23012
23126
|
/**
|
|
23013
23127
|
* Set to true to enable session enforcement.
|
|
@@ -23311,7 +23425,7 @@ export interface GetZeroTrustGatewaySettingsSettingsBlockPage {
|
|
|
23311
23425
|
mailtoSubject: string;
|
|
23312
23426
|
/**
|
|
23313
23427
|
* Controls whether the user is redirected to a Cloudflare-hosted block page or to a customer-provided URI.
|
|
23314
|
-
* Available values: "customizedBlockPage", "redirectUri".
|
|
23428
|
+
* Available values: "", "customizedBlockPage", "redirectUri".
|
|
23315
23429
|
*/
|
|
23316
23430
|
mode: string;
|
|
23317
23431
|
/**
|
|
@@ -23812,7 +23926,7 @@ export interface GetZeroTrustTunnelCloudflaredRouteFilter {
|
|
|
23812
23926
|
/**
|
|
23813
23927
|
* Optional remark describing the route.
|
|
23814
23928
|
*/
|
|
23815
|
-
comment
|
|
23929
|
+
comment: string;
|
|
23816
23930
|
/**
|
|
23817
23931
|
* If provided, include only resources that were created (and not deleted) before this time. URL encoded.
|
|
23818
23932
|
*/
|
|
@@ -23938,6 +24052,11 @@ export interface GetZeroTrustTunnelCloudflaredsResult {
|
|
|
23938
24052
|
* Cloudflare account ID
|
|
23939
24053
|
*/
|
|
23940
24054
|
accountTag: string;
|
|
24055
|
+
/**
|
|
24056
|
+
* Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.
|
|
24057
|
+
* Available values: "local", "cloudflare".
|
|
24058
|
+
*/
|
|
24059
|
+
configSrc: string;
|
|
23941
24060
|
/**
|
|
23942
24061
|
* The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
|
|
23943
24062
|
*
|
|
@@ -23974,6 +24093,8 @@ export interface GetZeroTrustTunnelCloudflaredsResult {
|
|
|
23974
24093
|
name: string;
|
|
23975
24094
|
/**
|
|
23976
24095
|
* If `true`, the tunnel can be configured remotely from the Zero Trust dashboard. If `false`, the tunnel must be configured locally on the origin machine.
|
|
24096
|
+
*
|
|
24097
|
+
* @deprecated Use the configSrc field instead.
|
|
23977
24098
|
*/
|
|
23978
24099
|
remoteConfig: boolean;
|
|
23979
24100
|
/**
|
|
@@ -24087,6 +24208,11 @@ export interface GetZeroTrustTunnelWarpConnectorsResult {
|
|
|
24087
24208
|
* Cloudflare account ID
|
|
24088
24209
|
*/
|
|
24089
24210
|
accountTag: string;
|
|
24211
|
+
/**
|
|
24212
|
+
* Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.
|
|
24213
|
+
* Available values: "local", "cloudflare".
|
|
24214
|
+
*/
|
|
24215
|
+
configSrc: string;
|
|
24090
24216
|
/**
|
|
24091
24217
|
* The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
|
|
24092
24218
|
*
|
|
@@ -24123,6 +24249,8 @@ export interface GetZeroTrustTunnelWarpConnectorsResult {
|
|
|
24123
24249
|
name: string;
|
|
24124
24250
|
/**
|
|
24125
24251
|
* If `true`, the tunnel can be configured remotely from the Zero Trust dashboard. If `false`, the tunnel must be configured locally on the origin machine.
|
|
24252
|
+
*
|
|
24253
|
+
* @deprecated Use the configSrc field instead.
|
|
24126
24254
|
*/
|
|
24127
24255
|
remoteConfig: boolean;
|
|
24128
24256
|
/**
|
|
@@ -25121,7 +25249,7 @@ export interface LoadBalancerRuleOverrides {
|
|
|
25121
25249
|
*/
|
|
25122
25250
|
locationStrategy: outputs.LoadBalancerRuleOverridesLocationStrategy;
|
|
25123
25251
|
/**
|
|
25124
|
-
*
|
|
25252
|
+
* Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country*pool, then region*pool mapping if it exists else to default_pools.
|
|
25125
25253
|
*/
|
|
25126
25254
|
popPools: {
|
|
25127
25255
|
[key: string]: string[];
|
|
@@ -25137,7 +25265,8 @@ export interface LoadBalancerRuleOverrides {
|
|
|
25137
25265
|
[key: string]: string[];
|
|
25138
25266
|
};
|
|
25139
25267
|
/**
|
|
25140
|
-
* Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are:
|
|
25268
|
+
* Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ipCookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `sessionAffinityTtl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `sessionAffinityAttributes` for additional required configuration.
|
|
25269
|
+
* Available values: "none", "cookie", "ipCookie", "header".
|
|
25141
25270
|
*/
|
|
25142
25271
|
sessionAffinity: string;
|
|
25143
25272
|
/**
|
|
@@ -25145,7 +25274,7 @@ export interface LoadBalancerRuleOverrides {
|
|
|
25145
25274
|
*/
|
|
25146
25275
|
sessionAffinityAttributes: outputs.LoadBalancerRuleOverridesSessionAffinityAttributes;
|
|
25147
25276
|
/**
|
|
25148
|
-
* Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `sessionAffinity` policy are:
|
|
25277
|
+
* Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `sessionAffinity` policy are: - `"cookie"` / `"ipCookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.
|
|
25149
25278
|
*/
|
|
25150
25279
|
sessionAffinityTtl: number;
|
|
25151
25280
|
/**
|
|
@@ -25195,7 +25324,7 @@ export interface LoadBalancerRuleOverridesSessionAffinityAttributes {
|
|
|
25195
25324
|
*/
|
|
25196
25325
|
headers?: string[];
|
|
25197
25326
|
/**
|
|
25198
|
-
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
|
|
25327
|
+
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.
|
|
25199
25328
|
*/
|
|
25200
25329
|
requireAllHeaders: boolean;
|
|
25201
25330
|
/**
|
|
@@ -25209,7 +25338,8 @@ export interface LoadBalancerRuleOverridesSessionAffinityAttributes {
|
|
|
25209
25338
|
*/
|
|
25210
25339
|
secure: string;
|
|
25211
25340
|
/**
|
|
25212
|
-
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:
|
|
25341
|
+
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.
|
|
25342
|
+
* Available values: "none", "temporary", "sticky".
|
|
25213
25343
|
*/
|
|
25214
25344
|
zeroDowntimeFailover: string;
|
|
25215
25345
|
}
|
|
@@ -25223,7 +25353,7 @@ export interface LoadBalancerSessionAffinityAttributes {
|
|
|
25223
25353
|
*/
|
|
25224
25354
|
headers?: string[];
|
|
25225
25355
|
/**
|
|
25226
|
-
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
|
|
25356
|
+
* When header `sessionAffinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.
|
|
25227
25357
|
*/
|
|
25228
25358
|
requireAllHeaders: boolean;
|
|
25229
25359
|
/**
|
|
@@ -25237,7 +25367,8 @@ export interface LoadBalancerSessionAffinityAttributes {
|
|
|
25237
25367
|
*/
|
|
25238
25368
|
secure: string;
|
|
25239
25369
|
/**
|
|
25240
|
-
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:
|
|
25370
|
+
* Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.
|
|
25371
|
+
* Available values: "none", "temporary", "sticky".
|
|
25241
25372
|
*/
|
|
25242
25373
|
zeroDowntimeFailover: string;
|
|
25243
25374
|
}
|
|
@@ -25532,72 +25663,40 @@ export interface MagicWanStaticRouteScope {
|
|
|
25532
25663
|
coloRegions?: string[];
|
|
25533
25664
|
}
|
|
25534
25665
|
export interface ManagedHeadersManagedRequestHeader {
|
|
25535
|
-
/**
|
|
25536
|
-
* The Managed Transforms that this Managed Transform conflicts with.
|
|
25537
|
-
*/
|
|
25538
|
-
conflictsWiths: string[];
|
|
25539
25666
|
/**
|
|
25540
25667
|
* Whether the Managed Transform is enabled.
|
|
25541
25668
|
*/
|
|
25542
25669
|
enabled: boolean;
|
|
25543
|
-
/**
|
|
25544
|
-
* Whether the Managed Transform conflicts with the currently-enabled Managed Transforms.
|
|
25545
|
-
*/
|
|
25546
|
-
hasConflict: boolean;
|
|
25547
25670
|
/**
|
|
25548
25671
|
* The human-readable identifier of the Managed Transform.
|
|
25549
25672
|
*/
|
|
25550
25673
|
id: string;
|
|
25551
25674
|
}
|
|
25552
25675
|
export interface ManagedHeadersManagedResponseHeader {
|
|
25553
|
-
/**
|
|
25554
|
-
* The Managed Transforms that this Managed Transform conflicts with.
|
|
25555
|
-
*/
|
|
25556
|
-
conflictsWiths: string[];
|
|
25557
25676
|
/**
|
|
25558
25677
|
* Whether the Managed Transform is enabled.
|
|
25559
25678
|
*/
|
|
25560
25679
|
enabled: boolean;
|
|
25561
|
-
/**
|
|
25562
|
-
* Whether the Managed Transform conflicts with the currently-enabled Managed Transforms.
|
|
25563
|
-
*/
|
|
25564
|
-
hasConflict: boolean;
|
|
25565
25680
|
/**
|
|
25566
25681
|
* The human-readable identifier of the Managed Transform.
|
|
25567
25682
|
*/
|
|
25568
25683
|
id: string;
|
|
25569
25684
|
}
|
|
25570
25685
|
export interface ManagedTransformsManagedRequestHeader {
|
|
25571
|
-
/**
|
|
25572
|
-
* The Managed Transforms that this Managed Transform conflicts with.
|
|
25573
|
-
*/
|
|
25574
|
-
conflictsWiths: string[];
|
|
25575
25686
|
/**
|
|
25576
25687
|
* Whether the Managed Transform is enabled.
|
|
25577
25688
|
*/
|
|
25578
25689
|
enabled: boolean;
|
|
25579
|
-
/**
|
|
25580
|
-
* Whether the Managed Transform conflicts with the currently-enabled Managed Transforms.
|
|
25581
|
-
*/
|
|
25582
|
-
hasConflict: boolean;
|
|
25583
25690
|
/**
|
|
25584
25691
|
* The human-readable identifier of the Managed Transform.
|
|
25585
25692
|
*/
|
|
25586
25693
|
id: string;
|
|
25587
25694
|
}
|
|
25588
25695
|
export interface ManagedTransformsManagedResponseHeader {
|
|
25589
|
-
/**
|
|
25590
|
-
* The Managed Transforms that this Managed Transform conflicts with.
|
|
25591
|
-
*/
|
|
25592
|
-
conflictsWiths: string[];
|
|
25593
25696
|
/**
|
|
25594
25697
|
* Whether the Managed Transform is enabled.
|
|
25595
25698
|
*/
|
|
25596
25699
|
enabled: boolean;
|
|
25597
|
-
/**
|
|
25598
|
-
* Whether the Managed Transform conflicts with the currently-enabled Managed Transforms.
|
|
25599
|
-
*/
|
|
25600
|
-
hasConflict: boolean;
|
|
25601
25700
|
/**
|
|
25602
25701
|
* The human-readable identifier of the Managed Transform.
|
|
25603
25702
|
*/
|
|
@@ -27236,13 +27335,13 @@ export interface RecordData {
|
|
|
27236
27335
|
*/
|
|
27237
27336
|
digestType?: number;
|
|
27238
27337
|
/**
|
|
27239
|
-
*
|
|
27338
|
+
* Fingerprint.
|
|
27240
27339
|
*/
|
|
27241
27340
|
fingerprint?: string;
|
|
27242
27341
|
/**
|
|
27243
27342
|
* Flags for the CAA record.
|
|
27244
27343
|
*/
|
|
27245
|
-
flags?:
|
|
27344
|
+
flags?: any;
|
|
27246
27345
|
/**
|
|
27247
27346
|
* Key Tag.
|
|
27248
27347
|
*/
|
|
@@ -27306,7 +27405,7 @@ export interface RecordData {
|
|
|
27306
27405
|
*/
|
|
27307
27406
|
preference?: number;
|
|
27308
27407
|
/**
|
|
27309
|
-
*
|
|
27408
|
+
* Priority.
|
|
27310
27409
|
*/
|
|
27311
27410
|
priority?: number;
|
|
27312
27411
|
/**
|
|
@@ -27342,7 +27441,7 @@ export interface RecordData {
|
|
|
27342
27441
|
*/
|
|
27343
27442
|
tag?: string;
|
|
27344
27443
|
/**
|
|
27345
|
-
*
|
|
27444
|
+
* Target.
|
|
27346
27445
|
*/
|
|
27347
27446
|
target?: string;
|
|
27348
27447
|
/**
|
|
@@ -27386,33 +27485,29 @@ export interface RiskBehaviorBehaviors {
|
|
|
27386
27485
|
export interface RulesetRule {
|
|
27387
27486
|
/**
|
|
27388
27487
|
* The action to perform when the rule matches.
|
|
27389
|
-
* Available values: "block", "challenge", "compress*response", "execute", "js*challenge", "log", "managed*challenge", "redirect", "rewrite", "route", "score", "serve*error", "set*
|
|
27488
|
+
* Available values: "block", "challenge", "compress*response", "ddos*dynamic", "execute", "force*connection*close", "js*challenge", "log", "log*custom*field", "managed*challenge", "redirect", "rewrite", "route", "score", "serve*error", "set*cache*settings", "set*config", "skip".
|
|
27390
27489
|
*/
|
|
27391
|
-
action
|
|
27490
|
+
action: string;
|
|
27392
27491
|
/**
|
|
27393
27492
|
* The parameters configuring the rule's action.
|
|
27394
27493
|
*/
|
|
27395
|
-
actionParameters
|
|
27396
|
-
/**
|
|
27397
|
-
* The categories of the rule.
|
|
27398
|
-
*/
|
|
27399
|
-
categories?: string[];
|
|
27494
|
+
actionParameters: outputs.RulesetRuleActionParameters;
|
|
27400
27495
|
/**
|
|
27401
27496
|
* An informative description of the rule.
|
|
27402
27497
|
*/
|
|
27403
|
-
description
|
|
27498
|
+
description: string;
|
|
27404
27499
|
/**
|
|
27405
27500
|
* Whether the rule should be executed.
|
|
27406
27501
|
*/
|
|
27407
27502
|
enabled: boolean;
|
|
27408
27503
|
/**
|
|
27409
|
-
*
|
|
27504
|
+
* Configuration for exposed credential checking.
|
|
27410
27505
|
*/
|
|
27411
27506
|
exposedCredentialCheck?: outputs.RulesetRuleExposedCredentialCheck;
|
|
27412
27507
|
/**
|
|
27413
27508
|
* The expression defining which traffic will match the rule.
|
|
27414
27509
|
*/
|
|
27415
|
-
expression
|
|
27510
|
+
expression: string;
|
|
27416
27511
|
/**
|
|
27417
27512
|
* The unique ID of the rule.
|
|
27418
27513
|
*/
|
|
@@ -27420,19 +27515,19 @@ export interface RulesetRule {
|
|
|
27420
27515
|
/**
|
|
27421
27516
|
* An object configuring the rule's logging behavior.
|
|
27422
27517
|
*/
|
|
27423
|
-
logging
|
|
27518
|
+
logging: outputs.RulesetRuleLogging;
|
|
27424
27519
|
/**
|
|
27425
|
-
* An object configuring the rule's
|
|
27520
|
+
* An object configuring the rule's rate limit behavior.
|
|
27426
27521
|
*/
|
|
27427
27522
|
ratelimit?: outputs.RulesetRuleRatelimit;
|
|
27428
27523
|
/**
|
|
27429
|
-
* The reference of the rule (the rule ID by default).
|
|
27524
|
+
* The reference of the rule (the rule's ID by default).
|
|
27430
27525
|
*/
|
|
27431
27526
|
ref: string;
|
|
27432
27527
|
}
|
|
27433
27528
|
export interface RulesetRuleActionParameters {
|
|
27434
27529
|
/**
|
|
27435
|
-
*
|
|
27530
|
+
* A list of additional ports that caching should be enabled on.
|
|
27436
27531
|
*/
|
|
27437
27532
|
additionalCacheablePorts?: number[];
|
|
27438
27533
|
/**
|
|
@@ -27440,40 +27535,44 @@ export interface RulesetRuleActionParameters {
|
|
|
27440
27535
|
*/
|
|
27441
27536
|
algorithms?: outputs.RulesetRuleActionParametersAlgorithm[];
|
|
27442
27537
|
/**
|
|
27443
|
-
*
|
|
27538
|
+
* The name of a custom asset to serve as the response.
|
|
27539
|
+
*/
|
|
27540
|
+
assetName?: string;
|
|
27541
|
+
/**
|
|
27542
|
+
* Whether to enable Automatic HTTPS Rewrites.
|
|
27444
27543
|
*/
|
|
27445
27544
|
automaticHttpsRewrites?: boolean;
|
|
27446
27545
|
/**
|
|
27447
|
-
*
|
|
27546
|
+
* Which file extensions to minify automatically.
|
|
27448
27547
|
*/
|
|
27449
27548
|
autominify?: outputs.RulesetRuleActionParametersAutominify;
|
|
27450
27549
|
/**
|
|
27451
|
-
*
|
|
27550
|
+
* Whether to enable Browser Integrity Check (BIC).
|
|
27452
27551
|
*/
|
|
27453
27552
|
bic?: boolean;
|
|
27454
27553
|
/**
|
|
27455
|
-
*
|
|
27554
|
+
* How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.
|
|
27456
27555
|
*/
|
|
27457
27556
|
browserTtl?: outputs.RulesetRuleActionParametersBrowserTtl;
|
|
27458
27557
|
/**
|
|
27459
|
-
*
|
|
27558
|
+
* Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
|
|
27460
27559
|
*/
|
|
27461
27560
|
cache?: boolean;
|
|
27462
27561
|
/**
|
|
27463
|
-
*
|
|
27562
|
+
* Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
|
|
27464
27563
|
*/
|
|
27465
27564
|
cacheKey?: outputs.RulesetRuleActionParametersCacheKey;
|
|
27466
27565
|
/**
|
|
27467
|
-
*
|
|
27566
|
+
* Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
|
|
27468
27567
|
*/
|
|
27469
27568
|
cacheReserve?: outputs.RulesetRuleActionParametersCacheReserve;
|
|
27470
27569
|
/**
|
|
27471
|
-
*
|
|
27570
|
+
* The response content.
|
|
27472
27571
|
*/
|
|
27473
27572
|
content?: string;
|
|
27474
27573
|
/**
|
|
27475
|
-
*
|
|
27476
|
-
* Available values: "application/json", "text/
|
|
27574
|
+
* The content type header to set with the error response.
|
|
27575
|
+
* Available values: "application/json", "text/html", "text/plain", "text/xml".
|
|
27477
27576
|
*/
|
|
27478
27577
|
contentType?: string;
|
|
27479
27578
|
/**
|
|
@@ -27481,49 +27580,49 @@ export interface RulesetRuleActionParameters {
|
|
|
27481
27580
|
*/
|
|
27482
27581
|
cookieFields?: outputs.RulesetRuleActionParametersCookieField[];
|
|
27483
27582
|
/**
|
|
27484
|
-
*
|
|
27583
|
+
* Whether to disable Cloudflare Apps.
|
|
27485
27584
|
*/
|
|
27486
27585
|
disableApps?: boolean;
|
|
27487
27586
|
/**
|
|
27488
|
-
*
|
|
27587
|
+
* Whether to disable Real User Monitoring (RUM).
|
|
27489
27588
|
*/
|
|
27490
27589
|
disableRum?: boolean;
|
|
27491
27590
|
/**
|
|
27492
|
-
*
|
|
27591
|
+
* Whether to disable Zaraz.
|
|
27493
27592
|
*/
|
|
27494
27593
|
disableZaraz?: boolean;
|
|
27495
27594
|
/**
|
|
27496
|
-
*
|
|
27595
|
+
* How long the Cloudflare edge network should cache the response.
|
|
27497
27596
|
*/
|
|
27498
27597
|
edgeTtl?: outputs.RulesetRuleActionParametersEdgeTtl;
|
|
27499
27598
|
/**
|
|
27500
|
-
*
|
|
27599
|
+
* Whether to enable Email Obfuscation.
|
|
27501
27600
|
*/
|
|
27502
27601
|
emailObfuscation?: boolean;
|
|
27503
27602
|
/**
|
|
27504
|
-
*
|
|
27603
|
+
* Whether to enable Cloudflare Fonts.
|
|
27505
27604
|
*/
|
|
27506
27605
|
fonts?: boolean;
|
|
27507
27606
|
/**
|
|
27508
|
-
*
|
|
27607
|
+
* A redirect based on a bulk list lookup.
|
|
27509
27608
|
*/
|
|
27510
27609
|
fromList?: outputs.RulesetRuleActionParametersFromList;
|
|
27511
27610
|
/**
|
|
27512
|
-
*
|
|
27611
|
+
* A redirect based on the request properties.
|
|
27513
27612
|
*/
|
|
27514
27613
|
fromValue?: outputs.RulesetRuleActionParametersFromValue;
|
|
27515
27614
|
/**
|
|
27516
|
-
*
|
|
27615
|
+
* A map of headers to rewrite.
|
|
27517
27616
|
*/
|
|
27518
27617
|
headers?: {
|
|
27519
27618
|
[key: string]: outputs.RulesetRuleActionParametersHeaders;
|
|
27520
27619
|
};
|
|
27521
27620
|
/**
|
|
27522
|
-
*
|
|
27621
|
+
* A value to rewrite the HTTP host header to.
|
|
27523
27622
|
*/
|
|
27524
27623
|
hostHeader?: string;
|
|
27525
27624
|
/**
|
|
27526
|
-
*
|
|
27625
|
+
* Whether to enable Hotlink Protection.
|
|
27527
27626
|
*/
|
|
27528
27627
|
hotlinkProtection?: boolean;
|
|
27529
27628
|
/**
|
|
@@ -27531,7 +27630,7 @@ export interface RulesetRuleActionParameters {
|
|
|
27531
27630
|
*/
|
|
27532
27631
|
id?: string;
|
|
27533
27632
|
/**
|
|
27534
|
-
*
|
|
27633
|
+
* A delta to change the score by, which can be either positive or negative.
|
|
27535
27634
|
*/
|
|
27536
27635
|
increment?: number;
|
|
27537
27636
|
/**
|
|
@@ -27539,45 +27638,42 @@ export interface RulesetRuleActionParameters {
|
|
|
27539
27638
|
*/
|
|
27540
27639
|
matchedData?: outputs.RulesetRuleActionParametersMatchedData;
|
|
27541
27640
|
/**
|
|
27542
|
-
*
|
|
27641
|
+
* Whether to enable Mirage.
|
|
27543
27642
|
*/
|
|
27544
27643
|
mirage?: boolean;
|
|
27545
27644
|
/**
|
|
27546
|
-
*
|
|
27645
|
+
* Whether to enable Opportunistic Encryption.
|
|
27547
27646
|
*/
|
|
27548
27647
|
opportunisticEncryption?: boolean;
|
|
27549
27648
|
/**
|
|
27550
|
-
*
|
|
27649
|
+
* An origin to route to.
|
|
27551
27650
|
*/
|
|
27552
27651
|
origin?: outputs.RulesetRuleActionParametersOrigin;
|
|
27553
27652
|
/**
|
|
27554
|
-
*
|
|
27653
|
+
* Whether Cloudflare will aim to strictly adhere to RFC 7234.
|
|
27555
27654
|
*/
|
|
27556
27655
|
originCacheControl?: boolean;
|
|
27557
27656
|
/**
|
|
27558
|
-
*
|
|
27657
|
+
* Whether to generate Cloudflare error pages for issues from the origin server.
|
|
27559
27658
|
*/
|
|
27560
27659
|
originErrorPagePassthru?: boolean;
|
|
27561
27660
|
/**
|
|
27562
27661
|
* A set of overrides to apply to the target ruleset.
|
|
27563
27662
|
*/
|
|
27564
27663
|
overrides?: outputs.RulesetRuleActionParametersOverrides;
|
|
27565
|
-
/**
|
|
27566
|
-
* A phase to skip the execution of. This property is only compatible with products.
|
|
27567
|
-
* Available values: "current".
|
|
27568
|
-
*/
|
|
27569
|
-
phase?: string;
|
|
27570
27664
|
/**
|
|
27571
27665
|
* A list of phases to skip the execution of. This option is incompatible with the rulesets option.
|
|
27666
|
+
* Available values: "ddos*l4", "ddos*l7", "http*config*settings", "http*custom*errors", "http*log*custom*fields", "http*ratelimit", "http*request*cache*settings", "http*request*dynamic*redirect", "http*request*firewall*custom", "http*request*firewall*managed", "http*request*late*transform", "http*request*origin", "http*request*redirect", "http*request*sanitize", "http*request*sbfm", "http*request*transform", "http*response*compression", "http*response*firewall*managed", "http*response*headers*transform", "magic*transit", "magic*transit*ids*managed", "magic*transit*managed", "magic*transit_ratelimit".
|
|
27572
27667
|
*/
|
|
27573
27668
|
phases?: string[];
|
|
27574
27669
|
/**
|
|
27575
|
-
*
|
|
27670
|
+
* The Polish level to configure.
|
|
27576
27671
|
* Available values: "off", "lossless", "lossy", "webp".
|
|
27577
27672
|
*/
|
|
27578
27673
|
polish?: string;
|
|
27579
27674
|
/**
|
|
27580
27675
|
* A list of legacy security products to skip the execution of.
|
|
27676
|
+
* Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
|
|
27581
27677
|
*/
|
|
27582
27678
|
products?: string[];
|
|
27583
27679
|
/**
|
|
@@ -27585,7 +27681,7 @@ export interface RulesetRuleActionParameters {
|
|
|
27585
27681
|
*/
|
|
27586
27682
|
rawResponseFields?: outputs.RulesetRuleActionParametersRawResponseField[];
|
|
27587
27683
|
/**
|
|
27588
|
-
*
|
|
27684
|
+
* A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value.
|
|
27589
27685
|
*/
|
|
27590
27686
|
readTimeout?: number;
|
|
27591
27687
|
/**
|
|
@@ -27593,7 +27689,7 @@ export interface RulesetRuleActionParameters {
|
|
|
27593
27689
|
*/
|
|
27594
27690
|
requestFields?: outputs.RulesetRuleActionParametersRequestField[];
|
|
27595
27691
|
/**
|
|
27596
|
-
*
|
|
27692
|
+
* Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers.
|
|
27597
27693
|
*/
|
|
27598
27694
|
respectStrongEtags?: boolean;
|
|
27599
27695
|
/**
|
|
@@ -27605,7 +27701,7 @@ export interface RulesetRuleActionParameters {
|
|
|
27605
27701
|
*/
|
|
27606
27702
|
responseFields?: outputs.RulesetRuleActionParametersResponseField[];
|
|
27607
27703
|
/**
|
|
27608
|
-
*
|
|
27704
|
+
* Whether to enable Rocket Loader.
|
|
27609
27705
|
*/
|
|
27610
27706
|
rocketLoader?: boolean;
|
|
27611
27707
|
/**
|
|
@@ -27624,24 +27720,24 @@ export interface RulesetRuleActionParameters {
|
|
|
27624
27720
|
*/
|
|
27625
27721
|
rulesets?: string[];
|
|
27626
27722
|
/**
|
|
27627
|
-
*
|
|
27723
|
+
* The Security Level to configure.
|
|
27628
27724
|
* Available values: "off", "essentially*off", "low", "medium", "high", "under*attack".
|
|
27629
27725
|
*/
|
|
27630
27726
|
securityLevel?: string;
|
|
27631
27727
|
/**
|
|
27632
|
-
*
|
|
27728
|
+
* When to serve stale content from cache.
|
|
27633
27729
|
*/
|
|
27634
27730
|
serveStale?: outputs.RulesetRuleActionParametersServeStale;
|
|
27635
27731
|
/**
|
|
27636
|
-
*
|
|
27732
|
+
* Whether to enable Server-Side Excludes.
|
|
27637
27733
|
*/
|
|
27638
27734
|
serverSideExcludes?: boolean;
|
|
27639
27735
|
/**
|
|
27640
|
-
*
|
|
27736
|
+
* A Server Name Indication (SNI) override.
|
|
27641
27737
|
*/
|
|
27642
27738
|
sni?: outputs.RulesetRuleActionParametersSni;
|
|
27643
27739
|
/**
|
|
27644
|
-
*
|
|
27740
|
+
* The SSL level to configure.
|
|
27645
27741
|
* Available values: "off", "flexible", "full", "strict", "originPull".
|
|
27646
27742
|
*/
|
|
27647
27743
|
ssl?: string;
|
|
@@ -27650,7 +27746,7 @@ export interface RulesetRuleActionParameters {
|
|
|
27650
27746
|
*/
|
|
27651
27747
|
statusCode?: number;
|
|
27652
27748
|
/**
|
|
27653
|
-
*
|
|
27749
|
+
* Whether to enable Signed Exchanges (SXG).
|
|
27654
27750
|
*/
|
|
27655
27751
|
sxg?: boolean;
|
|
27656
27752
|
/**
|
|
@@ -27658,257 +27754,263 @@ export interface RulesetRuleActionParameters {
|
|
|
27658
27754
|
*/
|
|
27659
27755
|
transformedRequestFields?: outputs.RulesetRuleActionParametersTransformedRequestField[];
|
|
27660
27756
|
/**
|
|
27661
|
-
* URI
|
|
27757
|
+
* A URI rewrite.
|
|
27662
27758
|
*/
|
|
27663
27759
|
uri?: outputs.RulesetRuleActionParametersUri;
|
|
27664
27760
|
}
|
|
27665
27761
|
export interface RulesetRuleActionParametersAlgorithm {
|
|
27666
27762
|
/**
|
|
27667
|
-
* Name of compression algorithm to enable.
|
|
27763
|
+
* Name of the compression algorithm to enable.
|
|
27668
27764
|
* Available values: "none", "auto", "default", "gzip", "brotli", "zstd".
|
|
27669
27765
|
*/
|
|
27670
27766
|
name?: string;
|
|
27671
27767
|
}
|
|
27672
27768
|
export interface RulesetRuleActionParametersAutominify {
|
|
27673
27769
|
/**
|
|
27674
|
-
*
|
|
27770
|
+
* Whether to minify CSS files.
|
|
27675
27771
|
*/
|
|
27676
|
-
css
|
|
27772
|
+
css: boolean;
|
|
27677
27773
|
/**
|
|
27678
|
-
*
|
|
27774
|
+
* Whether to minify HTML files.
|
|
27679
27775
|
*/
|
|
27680
|
-
html
|
|
27776
|
+
html: boolean;
|
|
27681
27777
|
/**
|
|
27682
|
-
*
|
|
27778
|
+
* Whether to minify JavaScript files.
|
|
27683
27779
|
*/
|
|
27684
|
-
js
|
|
27780
|
+
js: boolean;
|
|
27685
27781
|
}
|
|
27686
27782
|
export interface RulesetRuleActionParametersBrowserTtl {
|
|
27687
27783
|
/**
|
|
27688
|
-
* The TTL (in seconds) if you choose overrideOrigin mode.
|
|
27784
|
+
* The browser TTL (in seconds) if you choose the "overrideOrigin" mode.
|
|
27689
27785
|
*/
|
|
27690
27786
|
default?: number;
|
|
27691
27787
|
/**
|
|
27692
|
-
*
|
|
27788
|
+
* The browser TTL mode.
|
|
27693
27789
|
* Available values: "respect*origin", "bypass*by*default", "override*origin", "bypass".
|
|
27694
27790
|
*/
|
|
27695
27791
|
mode: string;
|
|
27696
27792
|
}
|
|
27697
27793
|
export interface RulesetRuleActionParametersCacheKey {
|
|
27698
27794
|
/**
|
|
27699
|
-
*
|
|
27795
|
+
* Whether to separate cached content based on the visitor's device type.
|
|
27700
27796
|
*/
|
|
27701
27797
|
cacheByDeviceType?: boolean;
|
|
27702
27798
|
/**
|
|
27703
|
-
*
|
|
27799
|
+
* Whether to protect from web cache deception attacks, while allowing static assets to be cached.
|
|
27704
27800
|
*/
|
|
27705
27801
|
cacheDeceptionArmor?: boolean;
|
|
27706
27802
|
/**
|
|
27707
|
-
*
|
|
27803
|
+
* Which components of the request are included or excluded from the cache key.
|
|
27708
27804
|
*/
|
|
27709
27805
|
customKey?: outputs.RulesetRuleActionParametersCacheKeyCustomKey;
|
|
27710
27806
|
/**
|
|
27711
|
-
*
|
|
27807
|
+
* Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
|
|
27712
27808
|
*/
|
|
27713
27809
|
ignoreQueryStringsOrder?: boolean;
|
|
27714
27810
|
}
|
|
27715
27811
|
export interface RulesetRuleActionParametersCacheKeyCustomKey {
|
|
27716
27812
|
/**
|
|
27717
|
-
*
|
|
27813
|
+
* Which cookies to include in the cache key.
|
|
27718
27814
|
*/
|
|
27719
27815
|
cookie?: outputs.RulesetRuleActionParametersCacheKeyCustomKeyCookie;
|
|
27720
27816
|
/**
|
|
27721
|
-
*
|
|
27817
|
+
* Which headers to include in the cache key.
|
|
27722
27818
|
*/
|
|
27723
27819
|
header?: outputs.RulesetRuleActionParametersCacheKeyCustomKeyHeader;
|
|
27724
27820
|
/**
|
|
27725
|
-
*
|
|
27821
|
+
* How to use the host in the cache key.
|
|
27726
27822
|
*/
|
|
27727
27823
|
host?: outputs.RulesetRuleActionParametersCacheKeyCustomKeyHost;
|
|
27728
27824
|
/**
|
|
27729
|
-
*
|
|
27825
|
+
* Which query string parameters to include in or exclude from the cache key.
|
|
27730
27826
|
*/
|
|
27731
27827
|
queryString?: outputs.RulesetRuleActionParametersCacheKeyCustomKeyQueryString;
|
|
27732
27828
|
/**
|
|
27733
|
-
*
|
|
27829
|
+
* How to use characteristics of the request user agent in the cache key.
|
|
27734
27830
|
*/
|
|
27735
27831
|
user?: outputs.RulesetRuleActionParametersCacheKeyCustomKeyUser;
|
|
27736
27832
|
}
|
|
27737
27833
|
export interface RulesetRuleActionParametersCacheKeyCustomKeyCookie {
|
|
27738
27834
|
/**
|
|
27739
|
-
*
|
|
27835
|
+
* A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
|
|
27740
27836
|
*/
|
|
27741
27837
|
checkPresences?: string[];
|
|
27742
27838
|
/**
|
|
27743
|
-
*
|
|
27839
|
+
* A list of cookies to include in the cache key.
|
|
27744
27840
|
*/
|
|
27745
27841
|
includes?: string[];
|
|
27746
27842
|
}
|
|
27747
27843
|
export interface RulesetRuleActionParametersCacheKeyCustomKeyHeader {
|
|
27748
27844
|
/**
|
|
27749
|
-
*
|
|
27845
|
+
* A list of headers to check for the presence of. The presence of these headers is included in the cache key.
|
|
27750
27846
|
*/
|
|
27751
27847
|
checkPresences?: string[];
|
|
27752
27848
|
/**
|
|
27753
|
-
*
|
|
27849
|
+
* A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
|
|
27754
27850
|
*/
|
|
27755
27851
|
contains?: {
|
|
27756
27852
|
[key: string]: string[];
|
|
27757
27853
|
};
|
|
27758
27854
|
/**
|
|
27759
|
-
* Whether
|
|
27855
|
+
* Whether to exclude the origin header in the cache key.
|
|
27760
27856
|
*/
|
|
27761
27857
|
excludeOrigin?: boolean;
|
|
27762
27858
|
/**
|
|
27763
|
-
*
|
|
27859
|
+
* A list of headers to include in the cache key.
|
|
27764
27860
|
*/
|
|
27765
27861
|
includes?: string[];
|
|
27766
27862
|
}
|
|
27767
27863
|
export interface RulesetRuleActionParametersCacheKeyCustomKeyHost {
|
|
27768
27864
|
/**
|
|
27769
|
-
*
|
|
27865
|
+
* Whether to use the resolved host in the cache key.
|
|
27770
27866
|
*/
|
|
27771
27867
|
resolved?: boolean;
|
|
27772
27868
|
}
|
|
27773
27869
|
export interface RulesetRuleActionParametersCacheKeyCustomKeyQueryString {
|
|
27774
27870
|
/**
|
|
27775
|
-
*
|
|
27871
|
+
* Which query string parameters to exclude from the cache key.
|
|
27776
27872
|
*/
|
|
27777
27873
|
exclude?: outputs.RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude;
|
|
27778
27874
|
/**
|
|
27779
|
-
*
|
|
27875
|
+
* Which query string parameters to include in the cache key.
|
|
27780
27876
|
*/
|
|
27781
27877
|
include?: outputs.RulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude;
|
|
27782
27878
|
}
|
|
27783
27879
|
export interface RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude {
|
|
27784
27880
|
/**
|
|
27785
|
-
*
|
|
27881
|
+
* Whether to exclude all query string parameters from the cache key.
|
|
27786
27882
|
*/
|
|
27787
27883
|
all?: boolean;
|
|
27884
|
+
/**
|
|
27885
|
+
* A list of query string parameters to exclude from the cache key.
|
|
27886
|
+
*/
|
|
27788
27887
|
lists?: string[];
|
|
27789
27888
|
}
|
|
27790
27889
|
export interface RulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude {
|
|
27791
27890
|
/**
|
|
27792
|
-
*
|
|
27891
|
+
* Whether to include all query string parameters in the cache key.
|
|
27793
27892
|
*/
|
|
27794
27893
|
all?: boolean;
|
|
27894
|
+
/**
|
|
27895
|
+
* A list of query string parameters to include in the cache key.
|
|
27896
|
+
*/
|
|
27795
27897
|
lists?: string[];
|
|
27796
27898
|
}
|
|
27797
27899
|
export interface RulesetRuleActionParametersCacheKeyCustomKeyUser {
|
|
27798
27900
|
/**
|
|
27799
|
-
*
|
|
27901
|
+
* Whether to use the user agent's device type in the cache key.
|
|
27800
27902
|
*/
|
|
27801
27903
|
deviceType?: boolean;
|
|
27802
27904
|
/**
|
|
27803
|
-
*
|
|
27905
|
+
* Whether to use the user agents's country in the cache key.
|
|
27804
27906
|
*/
|
|
27805
27907
|
geo?: boolean;
|
|
27806
27908
|
/**
|
|
27807
|
-
*
|
|
27909
|
+
* Whether to use the user agent's language in the cache key.
|
|
27808
27910
|
*/
|
|
27809
27911
|
lang?: boolean;
|
|
27810
27912
|
}
|
|
27811
27913
|
export interface RulesetRuleActionParametersCacheReserve {
|
|
27812
27914
|
/**
|
|
27813
|
-
*
|
|
27915
|
+
* Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.
|
|
27814
27916
|
*/
|
|
27815
27917
|
eligible: boolean;
|
|
27816
27918
|
/**
|
|
27817
|
-
* The minimum file size eligible for
|
|
27919
|
+
* The minimum file size eligible for storage in Cache Reserve.
|
|
27818
27920
|
*/
|
|
27819
|
-
minimumFileSize
|
|
27921
|
+
minimumFileSize?: number;
|
|
27820
27922
|
}
|
|
27821
27923
|
export interface RulesetRuleActionParametersCookieField {
|
|
27822
27924
|
/**
|
|
27823
|
-
* The name of the
|
|
27925
|
+
* The name of the cookie.
|
|
27824
27926
|
*/
|
|
27825
27927
|
name: string;
|
|
27826
27928
|
}
|
|
27827
27929
|
export interface RulesetRuleActionParametersEdgeTtl {
|
|
27828
27930
|
/**
|
|
27829
|
-
* The TTL (in seconds) if you choose overrideOrigin mode.
|
|
27931
|
+
* The edge TTL (in seconds) if you choose the "overrideOrigin" mode.
|
|
27830
27932
|
*/
|
|
27831
27933
|
default?: number;
|
|
27832
27934
|
/**
|
|
27833
|
-
*
|
|
27935
|
+
* The edge TTL mode.
|
|
27834
27936
|
* Available values: "respect*origin", "bypass*by*default", "override*origin".
|
|
27835
27937
|
*/
|
|
27836
27938
|
mode: string;
|
|
27837
27939
|
/**
|
|
27838
|
-
*
|
|
27940
|
+
* A list of TTLs to apply to specific status codes or status code ranges.
|
|
27839
27941
|
*/
|
|
27840
27942
|
statusCodeTtls?: outputs.RulesetRuleActionParametersEdgeTtlStatusCodeTtl[];
|
|
27841
27943
|
}
|
|
27842
27944
|
export interface RulesetRuleActionParametersEdgeTtlStatusCodeTtl {
|
|
27843
27945
|
/**
|
|
27844
|
-
*
|
|
27946
|
+
* A single status code to apply the TTL to.
|
|
27845
27947
|
*/
|
|
27846
27948
|
statusCode?: number;
|
|
27847
27949
|
/**
|
|
27848
|
-
*
|
|
27950
|
+
* A range of status codes to apply the TTL to.
|
|
27849
27951
|
*/
|
|
27850
27952
|
statusCodeRange?: outputs.RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange;
|
|
27851
27953
|
/**
|
|
27852
|
-
*
|
|
27954
|
+
* The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value "no-cache". A value of -1 is equivalent to setting the cache control header with the value of "no-store".
|
|
27853
27955
|
*/
|
|
27854
27956
|
value: number;
|
|
27855
27957
|
}
|
|
27856
27958
|
export interface RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange {
|
|
27857
27959
|
/**
|
|
27858
|
-
*
|
|
27960
|
+
* The lower bound of the range.
|
|
27859
27961
|
*/
|
|
27860
27962
|
from?: number;
|
|
27861
27963
|
/**
|
|
27862
|
-
*
|
|
27964
|
+
* The upper bound of the range.
|
|
27863
27965
|
*/
|
|
27864
27966
|
to?: number;
|
|
27865
27967
|
}
|
|
27866
27968
|
export interface RulesetRuleActionParametersFromList {
|
|
27867
27969
|
/**
|
|
27868
|
-
*
|
|
27970
|
+
* An expression that evaluates to the list lookup key.
|
|
27869
27971
|
*/
|
|
27870
|
-
key
|
|
27972
|
+
key: string;
|
|
27871
27973
|
/**
|
|
27872
27974
|
* The name of the list to match against.
|
|
27873
27975
|
*/
|
|
27874
|
-
name
|
|
27976
|
+
name: string;
|
|
27875
27977
|
}
|
|
27876
27978
|
export interface RulesetRuleActionParametersFromValue {
|
|
27877
27979
|
/**
|
|
27878
|
-
*
|
|
27980
|
+
* Whether to keep the query string of the original request.
|
|
27879
27981
|
*/
|
|
27880
|
-
preserveQueryString
|
|
27982
|
+
preserveQueryString: boolean;
|
|
27881
27983
|
/**
|
|
27882
|
-
* The status code to
|
|
27883
|
-
* Available values: 301, 302, 303, 307, 308.
|
|
27984
|
+
* The status code to use for the redirect.
|
|
27884
27985
|
*/
|
|
27885
27986
|
statusCode?: number;
|
|
27886
27987
|
/**
|
|
27887
|
-
*
|
|
27988
|
+
* A URL to redirect the request to.
|
|
27888
27989
|
*/
|
|
27889
|
-
targetUrl
|
|
27990
|
+
targetUrl: outputs.RulesetRuleActionParametersFromValueTargetUrl;
|
|
27890
27991
|
}
|
|
27891
27992
|
export interface RulesetRuleActionParametersFromValueTargetUrl {
|
|
27892
27993
|
/**
|
|
27893
|
-
* An expression
|
|
27994
|
+
* An expression that evaluates to a URL to redirect the request to.
|
|
27894
27995
|
*/
|
|
27895
27996
|
expression?: string;
|
|
27896
27997
|
/**
|
|
27897
|
-
*
|
|
27998
|
+
* A URL to redirect the request to.
|
|
27898
27999
|
*/
|
|
27899
28000
|
value?: string;
|
|
27900
28001
|
}
|
|
27901
28002
|
export interface RulesetRuleActionParametersHeaders {
|
|
27902
28003
|
/**
|
|
27903
|
-
*
|
|
28004
|
+
* An expression that evaluates to a value for the header.
|
|
27904
28005
|
*/
|
|
27905
28006
|
expression?: string;
|
|
27906
28007
|
/**
|
|
27907
|
-
*
|
|
28008
|
+
* The operation to perform on the header.
|
|
28009
|
+
* Available values: "add", "set", "remove".
|
|
27908
28010
|
*/
|
|
27909
28011
|
operation: string;
|
|
27910
28012
|
/**
|
|
27911
|
-
*
|
|
28013
|
+
* A static value for the header.
|
|
27912
28014
|
*/
|
|
27913
28015
|
value?: string;
|
|
27914
28016
|
}
|
|
@@ -27920,11 +28022,11 @@ export interface RulesetRuleActionParametersMatchedData {
|
|
|
27920
28022
|
}
|
|
27921
28023
|
export interface RulesetRuleActionParametersOrigin {
|
|
27922
28024
|
/**
|
|
27923
|
-
*
|
|
28025
|
+
* A resolved host to route to.
|
|
27924
28026
|
*/
|
|
27925
28027
|
host?: string;
|
|
27926
28028
|
/**
|
|
27927
|
-
*
|
|
28029
|
+
* A destination port to route to.
|
|
27928
28030
|
*/
|
|
27929
28031
|
port?: number;
|
|
27930
28032
|
}
|
|
@@ -27965,7 +28067,7 @@ export interface RulesetRuleActionParametersOverridesCategory {
|
|
|
27965
28067
|
*/
|
|
27966
28068
|
enabled?: boolean;
|
|
27967
28069
|
/**
|
|
27968
|
-
* The sensitivity level to use for rules in the category.
|
|
28070
|
+
* The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases.
|
|
27969
28071
|
* Available values: "default", "medium", "low", "eoff".
|
|
27970
28072
|
*/
|
|
27971
28073
|
sensitivityLevel?: string;
|
|
@@ -27988,24 +28090,24 @@ export interface RulesetRuleActionParametersOverridesRule {
|
|
|
27988
28090
|
*/
|
|
27989
28091
|
scoreThreshold?: number;
|
|
27990
28092
|
/**
|
|
27991
|
-
* The sensitivity level to use for the rule.
|
|
28093
|
+
* The sensitivity level to use for the rule. This option is only applicable for DDoS phases.
|
|
27992
28094
|
* Available values: "default", "medium", "low", "eoff".
|
|
27993
28095
|
*/
|
|
27994
28096
|
sensitivityLevel?: string;
|
|
27995
28097
|
}
|
|
27996
28098
|
export interface RulesetRuleActionParametersRawResponseField {
|
|
27997
28099
|
/**
|
|
27998
|
-
* The name of the
|
|
28100
|
+
* The name of the response header.
|
|
27999
28101
|
*/
|
|
28000
28102
|
name: string;
|
|
28001
28103
|
/**
|
|
28002
28104
|
* Whether to log duplicate values of the same header.
|
|
28003
28105
|
*/
|
|
28004
|
-
preserveDuplicates
|
|
28106
|
+
preserveDuplicates: boolean;
|
|
28005
28107
|
}
|
|
28006
28108
|
export interface RulesetRuleActionParametersRequestField {
|
|
28007
28109
|
/**
|
|
28008
|
-
* The name of the
|
|
28110
|
+
* The name of the header.
|
|
28009
28111
|
*/
|
|
28010
28112
|
name: string;
|
|
28011
28113
|
}
|
|
@@ -28025,69 +28127,69 @@ export interface RulesetRuleActionParametersResponse {
|
|
|
28025
28127
|
}
|
|
28026
28128
|
export interface RulesetRuleActionParametersResponseField {
|
|
28027
28129
|
/**
|
|
28028
|
-
* The name of the
|
|
28130
|
+
* The name of the response header.
|
|
28029
28131
|
*/
|
|
28030
28132
|
name: string;
|
|
28031
28133
|
/**
|
|
28032
28134
|
* Whether to log duplicate values of the same header.
|
|
28033
28135
|
*/
|
|
28034
|
-
preserveDuplicates
|
|
28136
|
+
preserveDuplicates: boolean;
|
|
28035
28137
|
}
|
|
28036
28138
|
export interface RulesetRuleActionParametersServeStale {
|
|
28037
28139
|
/**
|
|
28038
|
-
*
|
|
28140
|
+
* Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
|
|
28039
28141
|
*/
|
|
28040
|
-
disableStaleWhileUpdating
|
|
28142
|
+
disableStaleWhileUpdating?: boolean;
|
|
28041
28143
|
}
|
|
28042
28144
|
export interface RulesetRuleActionParametersSni {
|
|
28043
28145
|
/**
|
|
28044
|
-
*
|
|
28146
|
+
* A value to override the SNI to.
|
|
28045
28147
|
*/
|
|
28046
28148
|
value: string;
|
|
28047
28149
|
}
|
|
28048
28150
|
export interface RulesetRuleActionParametersTransformedRequestField {
|
|
28049
28151
|
/**
|
|
28050
|
-
* The name of the
|
|
28152
|
+
* The name of the header.
|
|
28051
28153
|
*/
|
|
28052
28154
|
name: string;
|
|
28053
28155
|
}
|
|
28054
28156
|
export interface RulesetRuleActionParametersUri {
|
|
28055
28157
|
/**
|
|
28056
|
-
*
|
|
28158
|
+
* A URI path rewrite.
|
|
28057
28159
|
*/
|
|
28058
28160
|
path?: outputs.RulesetRuleActionParametersUriPath;
|
|
28059
28161
|
/**
|
|
28060
|
-
*
|
|
28162
|
+
* A URI query rewrite.
|
|
28061
28163
|
*/
|
|
28062
28164
|
query?: outputs.RulesetRuleActionParametersUriQuery;
|
|
28063
28165
|
}
|
|
28064
28166
|
export interface RulesetRuleActionParametersUriPath {
|
|
28065
28167
|
/**
|
|
28066
|
-
*
|
|
28168
|
+
* An expression that evaluates to a value to rewrite the URI path to.
|
|
28067
28169
|
*/
|
|
28068
28170
|
expression?: string;
|
|
28069
28171
|
/**
|
|
28070
|
-
*
|
|
28172
|
+
* A value to rewrite the URI path to.
|
|
28071
28173
|
*/
|
|
28072
28174
|
value?: string;
|
|
28073
28175
|
}
|
|
28074
28176
|
export interface RulesetRuleActionParametersUriQuery {
|
|
28075
28177
|
/**
|
|
28076
|
-
*
|
|
28178
|
+
* An expression that evaluates to a value to rewrite the URI query to.
|
|
28077
28179
|
*/
|
|
28078
28180
|
expression?: string;
|
|
28079
28181
|
/**
|
|
28080
|
-
*
|
|
28182
|
+
* A value to rewrite the URI query to.
|
|
28081
28183
|
*/
|
|
28082
28184
|
value?: string;
|
|
28083
28185
|
}
|
|
28084
28186
|
export interface RulesetRuleExposedCredentialCheck {
|
|
28085
28187
|
/**
|
|
28086
|
-
*
|
|
28188
|
+
* An expression that selects the password used in the credentials check.
|
|
28087
28189
|
*/
|
|
28088
28190
|
passwordExpression: string;
|
|
28089
28191
|
/**
|
|
28090
|
-
*
|
|
28192
|
+
* An expression that selects the user ID used in the credentials check.
|
|
28091
28193
|
*/
|
|
28092
28194
|
usernameExpression: string;
|
|
28093
28195
|
}
|
|
@@ -28099,17 +28201,17 @@ export interface RulesetRuleLogging {
|
|
|
28099
28201
|
}
|
|
28100
28202
|
export interface RulesetRuleRatelimit {
|
|
28101
28203
|
/**
|
|
28102
|
-
* Characteristics of the request on which the
|
|
28204
|
+
* Characteristics of the request on which the rate limit counter will be incremented.
|
|
28103
28205
|
*/
|
|
28104
28206
|
characteristics: string[];
|
|
28105
28207
|
/**
|
|
28106
|
-
*
|
|
28208
|
+
* An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.
|
|
28107
28209
|
*/
|
|
28108
28210
|
countingExpression?: string;
|
|
28109
28211
|
/**
|
|
28110
28212
|
* Period of time in seconds after which the action will be disabled following its first execution.
|
|
28111
28213
|
*/
|
|
28112
|
-
mitigationTimeout
|
|
28214
|
+
mitigationTimeout: number;
|
|
28113
28215
|
/**
|
|
28114
28216
|
* Period in seconds over which the counter is being incremented.
|
|
28115
28217
|
*/
|
|
@@ -28119,18 +28221,28 @@ export interface RulesetRuleRatelimit {
|
|
|
28119
28221
|
*/
|
|
28120
28222
|
requestsPerPeriod?: number;
|
|
28121
28223
|
/**
|
|
28122
|
-
*
|
|
28224
|
+
* Whether counting is only performed when an origin is reached.
|
|
28123
28225
|
*/
|
|
28124
|
-
requestsToOrigin
|
|
28226
|
+
requestsToOrigin: boolean;
|
|
28125
28227
|
/**
|
|
28126
28228
|
* The score threshold per period for which the action will be executed the first time.
|
|
28127
28229
|
*/
|
|
28128
28230
|
scorePerPeriod?: number;
|
|
28129
28231
|
/**
|
|
28130
|
-
*
|
|
28232
|
+
* A response header name provided by the origin, which contains the score to increment rate limit counter with.
|
|
28131
28233
|
*/
|
|
28132
28234
|
scoreResponseHeaderName?: string;
|
|
28133
28235
|
}
|
|
28236
|
+
export interface SnippetFile {
|
|
28237
|
+
content: string;
|
|
28238
|
+
name: string;
|
|
28239
|
+
}
|
|
28240
|
+
export interface SnippetMetadata {
|
|
28241
|
+
/**
|
|
28242
|
+
* Name of the file that contains the main module of the snippet.
|
|
28243
|
+
*/
|
|
28244
|
+
mainModule: string;
|
|
28245
|
+
}
|
|
28134
28246
|
export interface SnippetRulesRule {
|
|
28135
28247
|
/**
|
|
28136
28248
|
* An informative description of the rule.
|
|
@@ -28520,7 +28632,7 @@ export interface TeamsAccountSettingsBlockPage {
|
|
|
28520
28632
|
mailtoSubject?: string;
|
|
28521
28633
|
/**
|
|
28522
28634
|
* Controls whether the user is redirected to a Cloudflare-hosted block page or to a customer-provided URI.
|
|
28523
|
-
* Available values: "customizedBlockPage", "redirectUri".
|
|
28635
|
+
* Available values: "", "customizedBlockPage", "redirectUri".
|
|
28524
28636
|
*/
|
|
28525
28637
|
mode?: string;
|
|
28526
28638
|
/**
|
|
@@ -28921,9 +29033,6 @@ export interface TeamsRuleRuleSettingsBlockPage {
|
|
|
28921
29033
|
targetUri: string;
|
|
28922
29034
|
}
|
|
28923
29035
|
export interface TeamsRuleRuleSettingsCheckSession {
|
|
28924
|
-
/**
|
|
28925
|
-
* Configure how fresh the session needs to be to be considered valid.
|
|
28926
|
-
*/
|
|
28927
29036
|
duration?: string;
|
|
28928
29037
|
/**
|
|
28929
29038
|
* Set to true to enable session enforcement.
|
|
@@ -33308,9 +33417,6 @@ export interface ZeroTrustGatewayPolicyRuleSettingsBlockPage {
|
|
|
33308
33417
|
targetUri: string;
|
|
33309
33418
|
}
|
|
33310
33419
|
export interface ZeroTrustGatewayPolicyRuleSettingsCheckSession {
|
|
33311
|
-
/**
|
|
33312
|
-
* Configure how fresh the session needs to be to be considered valid.
|
|
33313
|
-
*/
|
|
33314
33420
|
duration?: string;
|
|
33315
33421
|
/**
|
|
33316
33422
|
* Set to true to enable session enforcement.
|
|
@@ -33614,7 +33720,7 @@ export interface ZeroTrustGatewaySettingsSettingsBlockPage {
|
|
|
33614
33720
|
mailtoSubject?: string;
|
|
33615
33721
|
/**
|
|
33616
33722
|
* Controls whether the user is redirected to a Cloudflare-hosted block page or to a customer-provided URI.
|
|
33617
|
-
* Available values: "customizedBlockPage", "redirectUri".
|
|
33723
|
+
* Available values: "", "customizedBlockPage", "redirectUri".
|
|
33618
33724
|
*/
|
|
33619
33725
|
mode?: string;
|
|
33620
33726
|
/**
|