published on Monday, Mar 30, 2026 by g-core
published on Monday, Mar 30, 2026 by g-core
CDN resource rules set custom caching, delivery, and security options for specific URL patterns or file types.
Example Usage
Basic CDN rule
Create a CDN resource rule that matches a URL pattern and overrides the origin protocol.
import * as pulumi from "@pulumi/pulumi";
import * as gcore from "@pulumi/gcore";
// Create a CDN resource rule
const example = new gcore.CdnResourceRule("example", {
resourceId: 12345,
name: "my-cdn-rule",
rule: "/assets/*.png",
ruleType: 0,
active: true,
overrideOriginProtocol: "HTTPS",
});
import pulumi
import pulumi_gcore as gcore
# Create a CDN resource rule
example = gcore.CdnResourceRule("example",
resource_id=12345,
name="my-cdn-rule",
rule="/assets/*.png",
rule_type=0,
active=True,
override_origin_protocol="HTTPS")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Create a CDN resource rule
_, err := gcore.NewCdnResourceRule(ctx, "example", &gcore.CdnResourceRuleArgs{
ResourceId: pulumi.Float64(12345),
Name: pulumi.String("my-cdn-rule"),
Rule: pulumi.String("/assets/*.png"),
RuleType: pulumi.Float64(0),
Active: pulumi.Bool(true),
OverrideOriginProtocol: pulumi.String("HTTPS"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcore = Pulumi.Gcore;
return await Deployment.RunAsync(() =>
{
// Create a CDN resource rule
var example = new Gcore.CdnResourceRule("example", new()
{
ResourceId = 12345,
Name = "my-cdn-rule",
Rule = "/assets/*.png",
RuleType = 0,
Active = true,
OverrideOriginProtocol = "HTTPS",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.CdnResourceRule;
import com.pulumi.gcore.CdnResourceRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Create a CDN resource rule
var example = new CdnResourceRule("example", CdnResourceRuleArgs.builder()
.resourceId(12345.0)
.name("my-cdn-rule")
.rule("/assets/*.png")
.ruleType(0.0)
.active(true)
.overrideOriginProtocol("HTTPS")
.build());
}
}
resources:
# Create a CDN resource rule
example:
type: gcore:CdnResourceRule
properties:
resourceId: 12345
name: my-cdn-rule
rule: /assets/*.png
ruleType: 0
active: true
overrideOriginProtocol: HTTPS
Create CdnResourceRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CdnResourceRule(name: string, args: CdnResourceRuleArgs, opts?: CustomResourceOptions);@overload
def CdnResourceRule(resource_name: str,
args: CdnResourceRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CdnResourceRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_id: Optional[float] = None,
rule: Optional[str] = None,
rule_type: Optional[float] = None,
active: Optional[bool] = None,
name: Optional[str] = None,
options: Optional[CdnResourceRuleOptionsArgs] = None,
origin_group: Optional[float] = None,
override_origin_protocol: Optional[str] = None,
weight: Optional[float] = None)func NewCdnResourceRule(ctx *Context, name string, args CdnResourceRuleArgs, opts ...ResourceOption) (*CdnResourceRule, error)public CdnResourceRule(string name, CdnResourceRuleArgs args, CustomResourceOptions? opts = null)
public CdnResourceRule(String name, CdnResourceRuleArgs args)
public CdnResourceRule(String name, CdnResourceRuleArgs args, CustomResourceOptions options)
type: gcore:CdnResourceRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CdnResourceRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CdnResourceRuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CdnResourceRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CdnResourceRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CdnResourceRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var cdnResourceRuleResource = new Gcore.Index.CdnResourceRule("cdnResourceRuleResource", new()
{
ResourceId = 0,
Rule = "string",
RuleType = 0,
Active = false,
Name = "string",
Options = new Gcore.Inputs.CdnResourceRuleOptionsArgs
{
AllowedHttpMethods = new Gcore.Inputs.CdnResourceRuleOptionsAllowedHttpMethodsArgs
{
Enabled = false,
Values = new[]
{
"string",
},
},
BotProtection = new Gcore.Inputs.CdnResourceRuleOptionsBotProtectionArgs
{
BotChallenge = new Gcore.Inputs.CdnResourceRuleOptionsBotProtectionBotChallengeArgs
{
Enabled = false,
},
Enabled = false,
},
BrotliCompression = new Gcore.Inputs.CdnResourceRuleOptionsBrotliCompressionArgs
{
Enabled = false,
Values = new[]
{
"string",
},
},
BrowserCacheSettings = new Gcore.Inputs.CdnResourceRuleOptionsBrowserCacheSettingsArgs
{
Enabled = false,
Value = "string",
},
Cors = new Gcore.Inputs.CdnResourceRuleOptionsCorsArgs
{
Enabled = false,
Values = new[]
{
"string",
},
Always = false,
},
CountryAcl = new Gcore.Inputs.CdnResourceRuleOptionsCountryAclArgs
{
Enabled = false,
ExceptedValues = new[]
{
"string",
},
PolicyType = "string",
},
DisableProxyForceRanges = new Gcore.Inputs.CdnResourceRuleOptionsDisableProxyForceRangesArgs
{
Enabled = false,
Value = false,
},
EdgeCacheSettings = new Gcore.Inputs.CdnResourceRuleOptionsEdgeCacheSettingsArgs
{
Enabled = false,
CustomValues =
{
{ "string", "string" },
},
Default = "string",
Value = "string",
},
Fastedge = new Gcore.Inputs.CdnResourceRuleOptionsFastedgeArgs
{
Enabled = false,
OnRequestBody = new Gcore.Inputs.CdnResourceRuleOptionsFastedgeOnRequestBodyArgs
{
AppId = "string",
Enabled = false,
ExecuteOnEdge = false,
ExecuteOnShield = false,
InterruptOnError = false,
},
OnRequestHeaders = new Gcore.Inputs.CdnResourceRuleOptionsFastedgeOnRequestHeadersArgs
{
AppId = "string",
Enabled = false,
ExecuteOnEdge = false,
ExecuteOnShield = false,
InterruptOnError = false,
},
OnResponseBody = new Gcore.Inputs.CdnResourceRuleOptionsFastedgeOnResponseBodyArgs
{
AppId = "string",
Enabled = false,
ExecuteOnEdge = false,
ExecuteOnShield = false,
InterruptOnError = false,
},
OnResponseHeaders = new Gcore.Inputs.CdnResourceRuleOptionsFastedgeOnResponseHeadersArgs
{
AppId = "string",
Enabled = false,
ExecuteOnEdge = false,
ExecuteOnShield = false,
InterruptOnError = false,
},
},
FetchCompressed = new Gcore.Inputs.CdnResourceRuleOptionsFetchCompressedArgs
{
Enabled = false,
Value = false,
},
FollowOriginRedirect = new Gcore.Inputs.CdnResourceRuleOptionsFollowOriginRedirectArgs
{
Codes = new[]
{
0,
},
Enabled = false,
},
ForceReturn = new Gcore.Inputs.CdnResourceRuleOptionsForceReturnArgs
{
Body = "string",
Code = 0,
Enabled = false,
TimeInterval = new Gcore.Inputs.CdnResourceRuleOptionsForceReturnTimeIntervalArgs
{
EndTime = "string",
StartTime = "string",
TimeZone = "string",
},
},
ForwardHostHeader = new Gcore.Inputs.CdnResourceRuleOptionsForwardHostHeaderArgs
{
Enabled = false,
Value = false,
},
GzipOn = new Gcore.Inputs.CdnResourceRuleOptionsGzipOnArgs
{
Enabled = false,
Value = false,
},
HostHeader = new Gcore.Inputs.CdnResourceRuleOptionsHostHeaderArgs
{
Enabled = false,
Value = "string",
},
IgnoreCookie = new Gcore.Inputs.CdnResourceRuleOptionsIgnoreCookieArgs
{
Enabled = false,
Value = false,
},
IgnoreQueryString = new Gcore.Inputs.CdnResourceRuleOptionsIgnoreQueryStringArgs
{
Enabled = false,
Value = false,
},
ImageStack = new Gcore.Inputs.CdnResourceRuleOptionsImageStackArgs
{
Enabled = false,
AvifEnabled = false,
PngLossless = false,
Quality = 0,
WebpEnabled = false,
},
IpAddressAcl = new Gcore.Inputs.CdnResourceRuleOptionsIpAddressAclArgs
{
Enabled = false,
ExceptedValues = new[]
{
"string",
},
PolicyType = "string",
},
LimitBandwidth = new Gcore.Inputs.CdnResourceRuleOptionsLimitBandwidthArgs
{
Enabled = false,
LimitType = "string",
Buffer = 0,
Speed = 0,
},
ProxyCacheKey = new Gcore.Inputs.CdnResourceRuleOptionsProxyCacheKeyArgs
{
Enabled = false,
Value = "string",
},
ProxyCacheMethodsSet = new Gcore.Inputs.CdnResourceRuleOptionsProxyCacheMethodsSetArgs
{
Enabled = false,
Value = false,
},
ProxyConnectTimeout = new Gcore.Inputs.CdnResourceRuleOptionsProxyConnectTimeoutArgs
{
Enabled = false,
Value = "string",
},
ProxyReadTimeout = new Gcore.Inputs.CdnResourceRuleOptionsProxyReadTimeoutArgs
{
Enabled = false,
Value = "string",
},
QueryParamsBlacklist = new Gcore.Inputs.CdnResourceRuleOptionsQueryParamsBlacklistArgs
{
Enabled = false,
Values = new[]
{
"string",
},
},
QueryParamsWhitelist = new Gcore.Inputs.CdnResourceRuleOptionsQueryParamsWhitelistArgs
{
Enabled = false,
Values = new[]
{
"string",
},
},
QueryStringForwarding = new Gcore.Inputs.CdnResourceRuleOptionsQueryStringForwardingArgs
{
Enabled = false,
ForwardFromFileTypes = new[]
{
"string",
},
ForwardToFileTypes = new[]
{
"string",
},
ForwardExceptKeys = new[]
{
"string",
},
ForwardOnlyKeys = new[]
{
"string",
},
},
RedirectHttpToHttps = new Gcore.Inputs.CdnResourceRuleOptionsRedirectHttpToHttpsArgs
{
Enabled = false,
Value = false,
},
RedirectHttpsToHttp = new Gcore.Inputs.CdnResourceRuleOptionsRedirectHttpsToHttpArgs
{
Enabled = false,
Value = false,
},
ReferrerAcl = new Gcore.Inputs.CdnResourceRuleOptionsReferrerAclArgs
{
Enabled = false,
ExceptedValues = new[]
{
"string",
},
PolicyType = "string",
},
RequestLimiter = new Gcore.Inputs.CdnResourceRuleOptionsRequestLimiterArgs
{
Enabled = false,
Rate = 0,
Burst = 0,
Delay = 0,
RateUnit = "string",
},
ResponseHeadersHidingPolicy = new Gcore.Inputs.CdnResourceRuleOptionsResponseHeadersHidingPolicyArgs
{
Enabled = false,
Mode = "string",
Excepteds = new[]
{
"string",
},
},
Rewrite = new Gcore.Inputs.CdnResourceRuleOptionsRewriteArgs
{
Body = "string",
Enabled = false,
Flag = "string",
},
SecureKey = new Gcore.Inputs.CdnResourceRuleOptionsSecureKeyArgs
{
Enabled = false,
Key = "string",
Type = 0,
},
Slice = new Gcore.Inputs.CdnResourceRuleOptionsSliceArgs
{
Enabled = false,
Value = false,
},
Sni = new Gcore.Inputs.CdnResourceRuleOptionsSniArgs
{
CustomHostname = "string",
Enabled = false,
SniType = "string",
},
Stale = new Gcore.Inputs.CdnResourceRuleOptionsStaleArgs
{
Enabled = false,
Values = new[]
{
"string",
},
},
StaticRequestHeaders = new Gcore.Inputs.CdnResourceRuleOptionsStaticRequestHeadersArgs
{
Enabled = false,
Value =
{
{ "string", "string" },
},
},
StaticResponseHeaders = new Gcore.Inputs.CdnResourceRuleOptionsStaticResponseHeadersArgs
{
Enabled = false,
Values = new[]
{
new Gcore.Inputs.CdnResourceRuleOptionsStaticResponseHeadersValueArgs
{
Name = "string",
Values = new[]
{
"string",
},
Always = false,
},
},
},
UserAgentAcl = new Gcore.Inputs.CdnResourceRuleOptionsUserAgentAclArgs
{
Enabled = false,
ExceptedValues = new[]
{
"string",
},
PolicyType = "string",
},
Waap = new Gcore.Inputs.CdnResourceRuleOptionsWaapArgs
{
Enabled = false,
Value = false,
},
Websockets = new Gcore.Inputs.CdnResourceRuleOptionsWebsocketsArgs
{
Enabled = false,
Value = false,
},
},
OriginGroup = 0,
OverrideOriginProtocol = "string",
Weight = 0,
});
example, err := gcore.NewCdnResourceRule(ctx, "cdnResourceRuleResource", &gcore.CdnResourceRuleArgs{
ResourceId: pulumi.Float64(0),
Rule: pulumi.String("string"),
RuleType: pulumi.Float64(0),
Active: pulumi.Bool(false),
Name: pulumi.String("string"),
Options: &gcore.CdnResourceRuleOptionsArgs{
AllowedHttpMethods: &gcore.CdnResourceRuleOptionsAllowedHttpMethodsArgs{
Enabled: pulumi.Bool(false),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
BotProtection: &gcore.CdnResourceRuleOptionsBotProtectionArgs{
BotChallenge: &gcore.CdnResourceRuleOptionsBotProtectionBotChallengeArgs{
Enabled: pulumi.Bool(false),
},
Enabled: pulumi.Bool(false),
},
BrotliCompression: &gcore.CdnResourceRuleOptionsBrotliCompressionArgs{
Enabled: pulumi.Bool(false),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
BrowserCacheSettings: &gcore.CdnResourceRuleOptionsBrowserCacheSettingsArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.String("string"),
},
Cors: &gcore.CdnResourceRuleOptionsCorsArgs{
Enabled: pulumi.Bool(false),
Values: pulumi.StringArray{
pulumi.String("string"),
},
Always: pulumi.Bool(false),
},
CountryAcl: &gcore.CdnResourceRuleOptionsCountryAclArgs{
Enabled: pulumi.Bool(false),
ExceptedValues: pulumi.StringArray{
pulumi.String("string"),
},
PolicyType: pulumi.String("string"),
},
DisableProxyForceRanges: &gcore.CdnResourceRuleOptionsDisableProxyForceRangesArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
EdgeCacheSettings: &gcore.CdnResourceRuleOptionsEdgeCacheSettingsArgs{
Enabled: pulumi.Bool(false),
CustomValues: pulumi.StringMap{
"string": pulumi.String("string"),
},
Default: pulumi.String("string"),
Value: pulumi.String("string"),
},
Fastedge: &gcore.CdnResourceRuleOptionsFastedgeArgs{
Enabled: pulumi.Bool(false),
OnRequestBody: &gcore.CdnResourceRuleOptionsFastedgeOnRequestBodyArgs{
AppId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ExecuteOnEdge: pulumi.Bool(false),
ExecuteOnShield: pulumi.Bool(false),
InterruptOnError: pulumi.Bool(false),
},
OnRequestHeaders: &gcore.CdnResourceRuleOptionsFastedgeOnRequestHeadersArgs{
AppId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ExecuteOnEdge: pulumi.Bool(false),
ExecuteOnShield: pulumi.Bool(false),
InterruptOnError: pulumi.Bool(false),
},
OnResponseBody: &gcore.CdnResourceRuleOptionsFastedgeOnResponseBodyArgs{
AppId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ExecuteOnEdge: pulumi.Bool(false),
ExecuteOnShield: pulumi.Bool(false),
InterruptOnError: pulumi.Bool(false),
},
OnResponseHeaders: &gcore.CdnResourceRuleOptionsFastedgeOnResponseHeadersArgs{
AppId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ExecuteOnEdge: pulumi.Bool(false),
ExecuteOnShield: pulumi.Bool(false),
InterruptOnError: pulumi.Bool(false),
},
},
FetchCompressed: &gcore.CdnResourceRuleOptionsFetchCompressedArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
FollowOriginRedirect: &gcore.CdnResourceRuleOptionsFollowOriginRedirectArgs{
Codes: pulumi.Float64Array{
pulumi.Float64(0),
},
Enabled: pulumi.Bool(false),
},
ForceReturn: &gcore.CdnResourceRuleOptionsForceReturnArgs{
Body: pulumi.String("string"),
Code: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
TimeInterval: &gcore.CdnResourceRuleOptionsForceReturnTimeIntervalArgs{
EndTime: pulumi.String("string"),
StartTime: pulumi.String("string"),
TimeZone: pulumi.String("string"),
},
},
ForwardHostHeader: &gcore.CdnResourceRuleOptionsForwardHostHeaderArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
GzipOn: &gcore.CdnResourceRuleOptionsGzipOnArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
HostHeader: &gcore.CdnResourceRuleOptionsHostHeaderArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.String("string"),
},
IgnoreCookie: &gcore.CdnResourceRuleOptionsIgnoreCookieArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
IgnoreQueryString: &gcore.CdnResourceRuleOptionsIgnoreQueryStringArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
ImageStack: &gcore.CdnResourceRuleOptionsImageStackArgs{
Enabled: pulumi.Bool(false),
AvifEnabled: pulumi.Bool(false),
PngLossless: pulumi.Bool(false),
Quality: pulumi.Float64(0),
WebpEnabled: pulumi.Bool(false),
},
IpAddressAcl: &gcore.CdnResourceRuleOptionsIpAddressAclArgs{
Enabled: pulumi.Bool(false),
ExceptedValues: pulumi.StringArray{
pulumi.String("string"),
},
PolicyType: pulumi.String("string"),
},
LimitBandwidth: &gcore.CdnResourceRuleOptionsLimitBandwidthArgs{
Enabled: pulumi.Bool(false),
LimitType: pulumi.String("string"),
Buffer: pulumi.Float64(0),
Speed: pulumi.Float64(0),
},
ProxyCacheKey: &gcore.CdnResourceRuleOptionsProxyCacheKeyArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.String("string"),
},
ProxyCacheMethodsSet: &gcore.CdnResourceRuleOptionsProxyCacheMethodsSetArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
ProxyConnectTimeout: &gcore.CdnResourceRuleOptionsProxyConnectTimeoutArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.String("string"),
},
ProxyReadTimeout: &gcore.CdnResourceRuleOptionsProxyReadTimeoutArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.String("string"),
},
QueryParamsBlacklist: &gcore.CdnResourceRuleOptionsQueryParamsBlacklistArgs{
Enabled: pulumi.Bool(false),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
QueryParamsWhitelist: &gcore.CdnResourceRuleOptionsQueryParamsWhitelistArgs{
Enabled: pulumi.Bool(false),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
QueryStringForwarding: &gcore.CdnResourceRuleOptionsQueryStringForwardingArgs{
Enabled: pulumi.Bool(false),
ForwardFromFileTypes: pulumi.StringArray{
pulumi.String("string"),
},
ForwardToFileTypes: pulumi.StringArray{
pulumi.String("string"),
},
ForwardExceptKeys: pulumi.StringArray{
pulumi.String("string"),
},
ForwardOnlyKeys: pulumi.StringArray{
pulumi.String("string"),
},
},
RedirectHttpToHttps: &gcore.CdnResourceRuleOptionsRedirectHttpToHttpsArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
RedirectHttpsToHttp: &gcore.CdnResourceRuleOptionsRedirectHttpsToHttpArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
ReferrerAcl: &gcore.CdnResourceRuleOptionsReferrerAclArgs{
Enabled: pulumi.Bool(false),
ExceptedValues: pulumi.StringArray{
pulumi.String("string"),
},
PolicyType: pulumi.String("string"),
},
RequestLimiter: &gcore.CdnResourceRuleOptionsRequestLimiterArgs{
Enabled: pulumi.Bool(false),
Rate: pulumi.Float64(0),
Burst: pulumi.Float64(0),
Delay: pulumi.Float64(0),
RateUnit: pulumi.String("string"),
},
ResponseHeadersHidingPolicy: &gcore.CdnResourceRuleOptionsResponseHeadersHidingPolicyArgs{
Enabled: pulumi.Bool(false),
Mode: pulumi.String("string"),
Excepteds: pulumi.StringArray{
pulumi.String("string"),
},
},
Rewrite: &gcore.CdnResourceRuleOptionsRewriteArgs{
Body: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Flag: pulumi.String("string"),
},
SecureKey: &gcore.CdnResourceRuleOptionsSecureKeyArgs{
Enabled: pulumi.Bool(false),
Key: pulumi.String("string"),
Type: pulumi.Float64(0),
},
Slice: &gcore.CdnResourceRuleOptionsSliceArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
Sni: &gcore.CdnResourceRuleOptionsSniArgs{
CustomHostname: pulumi.String("string"),
Enabled: pulumi.Bool(false),
SniType: pulumi.String("string"),
},
Stale: &gcore.CdnResourceRuleOptionsStaleArgs{
Enabled: pulumi.Bool(false),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
StaticRequestHeaders: &gcore.CdnResourceRuleOptionsStaticRequestHeadersArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
StaticResponseHeaders: &gcore.CdnResourceRuleOptionsStaticResponseHeadersArgs{
Enabled: pulumi.Bool(false),
Values: gcore.CdnResourceRuleOptionsStaticResponseHeadersValueArray{
&gcore.CdnResourceRuleOptionsStaticResponseHeadersValueArgs{
Name: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
Always: pulumi.Bool(false),
},
},
},
UserAgentAcl: &gcore.CdnResourceRuleOptionsUserAgentAclArgs{
Enabled: pulumi.Bool(false),
ExceptedValues: pulumi.StringArray{
pulumi.String("string"),
},
PolicyType: pulumi.String("string"),
},
Waap: &gcore.CdnResourceRuleOptionsWaapArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
Websockets: &gcore.CdnResourceRuleOptionsWebsocketsArgs{
Enabled: pulumi.Bool(false),
Value: pulumi.Bool(false),
},
},
OriginGroup: pulumi.Float64(0),
OverrideOriginProtocol: pulumi.String("string"),
Weight: pulumi.Float64(0),
})
var cdnResourceRuleResource = new CdnResourceRule("cdnResourceRuleResource", CdnResourceRuleArgs.builder()
.resourceId(0.0)
.rule("string")
.ruleType(0.0)
.active(false)
.name("string")
.options(CdnResourceRuleOptionsArgs.builder()
.allowedHttpMethods(CdnResourceRuleOptionsAllowedHttpMethodsArgs.builder()
.enabled(false)
.values("string")
.build())
.botProtection(CdnResourceRuleOptionsBotProtectionArgs.builder()
.botChallenge(CdnResourceRuleOptionsBotProtectionBotChallengeArgs.builder()
.enabled(false)
.build())
.enabled(false)
.build())
.brotliCompression(CdnResourceRuleOptionsBrotliCompressionArgs.builder()
.enabled(false)
.values("string")
.build())
.browserCacheSettings(CdnResourceRuleOptionsBrowserCacheSettingsArgs.builder()
.enabled(false)
.value("string")
.build())
.cors(CdnResourceRuleOptionsCorsArgs.builder()
.enabled(false)
.values("string")
.always(false)
.build())
.countryAcl(CdnResourceRuleOptionsCountryAclArgs.builder()
.enabled(false)
.exceptedValues("string")
.policyType("string")
.build())
.disableProxyForceRanges(CdnResourceRuleOptionsDisableProxyForceRangesArgs.builder()
.enabled(false)
.value(false)
.build())
.edgeCacheSettings(CdnResourceRuleOptionsEdgeCacheSettingsArgs.builder()
.enabled(false)
.customValues(Map.of("string", "string"))
.default_("string")
.value("string")
.build())
.fastedge(CdnResourceRuleOptionsFastedgeArgs.builder()
.enabled(false)
.onRequestBody(CdnResourceRuleOptionsFastedgeOnRequestBodyArgs.builder()
.appId("string")
.enabled(false)
.executeOnEdge(false)
.executeOnShield(false)
.interruptOnError(false)
.build())
.onRequestHeaders(CdnResourceRuleOptionsFastedgeOnRequestHeadersArgs.builder()
.appId("string")
.enabled(false)
.executeOnEdge(false)
.executeOnShield(false)
.interruptOnError(false)
.build())
.onResponseBody(CdnResourceRuleOptionsFastedgeOnResponseBodyArgs.builder()
.appId("string")
.enabled(false)
.executeOnEdge(false)
.executeOnShield(false)
.interruptOnError(false)
.build())
.onResponseHeaders(CdnResourceRuleOptionsFastedgeOnResponseHeadersArgs.builder()
.appId("string")
.enabled(false)
.executeOnEdge(false)
.executeOnShield(false)
.interruptOnError(false)
.build())
.build())
.fetchCompressed(CdnResourceRuleOptionsFetchCompressedArgs.builder()
.enabled(false)
.value(false)
.build())
.followOriginRedirect(CdnResourceRuleOptionsFollowOriginRedirectArgs.builder()
.codes(0.0)
.enabled(false)
.build())
.forceReturn(CdnResourceRuleOptionsForceReturnArgs.builder()
.body("string")
.code(0.0)
.enabled(false)
.timeInterval(CdnResourceRuleOptionsForceReturnTimeIntervalArgs.builder()
.endTime("string")
.startTime("string")
.timeZone("string")
.build())
.build())
.forwardHostHeader(CdnResourceRuleOptionsForwardHostHeaderArgs.builder()
.enabled(false)
.value(false)
.build())
.gzipOn(CdnResourceRuleOptionsGzipOnArgs.builder()
.enabled(false)
.value(false)
.build())
.hostHeader(CdnResourceRuleOptionsHostHeaderArgs.builder()
.enabled(false)
.value("string")
.build())
.ignoreCookie(CdnResourceRuleOptionsIgnoreCookieArgs.builder()
.enabled(false)
.value(false)
.build())
.ignoreQueryString(CdnResourceRuleOptionsIgnoreQueryStringArgs.builder()
.enabled(false)
.value(false)
.build())
.imageStack(CdnResourceRuleOptionsImageStackArgs.builder()
.enabled(false)
.avifEnabled(false)
.pngLossless(false)
.quality(0.0)
.webpEnabled(false)
.build())
.ipAddressAcl(CdnResourceRuleOptionsIpAddressAclArgs.builder()
.enabled(false)
.exceptedValues("string")
.policyType("string")
.build())
.limitBandwidth(CdnResourceRuleOptionsLimitBandwidthArgs.builder()
.enabled(false)
.limitType("string")
.buffer(0.0)
.speed(0.0)
.build())
.proxyCacheKey(CdnResourceRuleOptionsProxyCacheKeyArgs.builder()
.enabled(false)
.value("string")
.build())
.proxyCacheMethodsSet(CdnResourceRuleOptionsProxyCacheMethodsSetArgs.builder()
.enabled(false)
.value(false)
.build())
.proxyConnectTimeout(CdnResourceRuleOptionsProxyConnectTimeoutArgs.builder()
.enabled(false)
.value("string")
.build())
.proxyReadTimeout(CdnResourceRuleOptionsProxyReadTimeoutArgs.builder()
.enabled(false)
.value("string")
.build())
.queryParamsBlacklist(CdnResourceRuleOptionsQueryParamsBlacklistArgs.builder()
.enabled(false)
.values("string")
.build())
.queryParamsWhitelist(CdnResourceRuleOptionsQueryParamsWhitelistArgs.builder()
.enabled(false)
.values("string")
.build())
.queryStringForwarding(CdnResourceRuleOptionsQueryStringForwardingArgs.builder()
.enabled(false)
.forwardFromFileTypes("string")
.forwardToFileTypes("string")
.forwardExceptKeys("string")
.forwardOnlyKeys("string")
.build())
.redirectHttpToHttps(CdnResourceRuleOptionsRedirectHttpToHttpsArgs.builder()
.enabled(false)
.value(false)
.build())
.redirectHttpsToHttp(CdnResourceRuleOptionsRedirectHttpsToHttpArgs.builder()
.enabled(false)
.value(false)
.build())
.referrerAcl(CdnResourceRuleOptionsReferrerAclArgs.builder()
.enabled(false)
.exceptedValues("string")
.policyType("string")
.build())
.requestLimiter(CdnResourceRuleOptionsRequestLimiterArgs.builder()
.enabled(false)
.rate(0.0)
.burst(0.0)
.delay(0.0)
.rateUnit("string")
.build())
.responseHeadersHidingPolicy(CdnResourceRuleOptionsResponseHeadersHidingPolicyArgs.builder()
.enabled(false)
.mode("string")
.excepteds("string")
.build())
.rewrite(CdnResourceRuleOptionsRewriteArgs.builder()
.body("string")
.enabled(false)
.flag("string")
.build())
.secureKey(CdnResourceRuleOptionsSecureKeyArgs.builder()
.enabled(false)
.key("string")
.type(0.0)
.build())
.slice(CdnResourceRuleOptionsSliceArgs.builder()
.enabled(false)
.value(false)
.build())
.sni(CdnResourceRuleOptionsSniArgs.builder()
.customHostname("string")
.enabled(false)
.sniType("string")
.build())
.stale(CdnResourceRuleOptionsStaleArgs.builder()
.enabled(false)
.values("string")
.build())
.staticRequestHeaders(CdnResourceRuleOptionsStaticRequestHeadersArgs.builder()
.enabled(false)
.value(Map.of("string", "string"))
.build())
.staticResponseHeaders(CdnResourceRuleOptionsStaticResponseHeadersArgs.builder()
.enabled(false)
.values(CdnResourceRuleOptionsStaticResponseHeadersValueArgs.builder()
.name("string")
.values("string")
.always(false)
.build())
.build())
.userAgentAcl(CdnResourceRuleOptionsUserAgentAclArgs.builder()
.enabled(false)
.exceptedValues("string")
.policyType("string")
.build())
.waap(CdnResourceRuleOptionsWaapArgs.builder()
.enabled(false)
.value(false)
.build())
.websockets(CdnResourceRuleOptionsWebsocketsArgs.builder()
.enabled(false)
.value(false)
.build())
.build())
.originGroup(0.0)
.overrideOriginProtocol("string")
.weight(0.0)
.build());
cdn_resource_rule_resource = gcore.CdnResourceRule("cdnResourceRuleResource",
resource_id=0,
rule="string",
rule_type=0,
active=False,
name="string",
options={
"allowed_http_methods": {
"enabled": False,
"values": ["string"],
},
"bot_protection": {
"bot_challenge": {
"enabled": False,
},
"enabled": False,
},
"brotli_compression": {
"enabled": False,
"values": ["string"],
},
"browser_cache_settings": {
"enabled": False,
"value": "string",
},
"cors": {
"enabled": False,
"values": ["string"],
"always": False,
},
"country_acl": {
"enabled": False,
"excepted_values": ["string"],
"policy_type": "string",
},
"disable_proxy_force_ranges": {
"enabled": False,
"value": False,
},
"edge_cache_settings": {
"enabled": False,
"custom_values": {
"string": "string",
},
"default": "string",
"value": "string",
},
"fastedge": {
"enabled": False,
"on_request_body": {
"app_id": "string",
"enabled": False,
"execute_on_edge": False,
"execute_on_shield": False,
"interrupt_on_error": False,
},
"on_request_headers": {
"app_id": "string",
"enabled": False,
"execute_on_edge": False,
"execute_on_shield": False,
"interrupt_on_error": False,
},
"on_response_body": {
"app_id": "string",
"enabled": False,
"execute_on_edge": False,
"execute_on_shield": False,
"interrupt_on_error": False,
},
"on_response_headers": {
"app_id": "string",
"enabled": False,
"execute_on_edge": False,
"execute_on_shield": False,
"interrupt_on_error": False,
},
},
"fetch_compressed": {
"enabled": False,
"value": False,
},
"follow_origin_redirect": {
"codes": [0],
"enabled": False,
},
"force_return": {
"body": "string",
"code": 0,
"enabled": False,
"time_interval": {
"end_time": "string",
"start_time": "string",
"time_zone": "string",
},
},
"forward_host_header": {
"enabled": False,
"value": False,
},
"gzip_on": {
"enabled": False,
"value": False,
},
"host_header": {
"enabled": False,
"value": "string",
},
"ignore_cookie": {
"enabled": False,
"value": False,
},
"ignore_query_string": {
"enabled": False,
"value": False,
},
"image_stack": {
"enabled": False,
"avif_enabled": False,
"png_lossless": False,
"quality": 0,
"webp_enabled": False,
},
"ip_address_acl": {
"enabled": False,
"excepted_values": ["string"],
"policy_type": "string",
},
"limit_bandwidth": {
"enabled": False,
"limit_type": "string",
"buffer": 0,
"speed": 0,
},
"proxy_cache_key": {
"enabled": False,
"value": "string",
},
"proxy_cache_methods_set": {
"enabled": False,
"value": False,
},
"proxy_connect_timeout": {
"enabled": False,
"value": "string",
},
"proxy_read_timeout": {
"enabled": False,
"value": "string",
},
"query_params_blacklist": {
"enabled": False,
"values": ["string"],
},
"query_params_whitelist": {
"enabled": False,
"values": ["string"],
},
"query_string_forwarding": {
"enabled": False,
"forward_from_file_types": ["string"],
"forward_to_file_types": ["string"],
"forward_except_keys": ["string"],
"forward_only_keys": ["string"],
},
"redirect_http_to_https": {
"enabled": False,
"value": False,
},
"redirect_https_to_http": {
"enabled": False,
"value": False,
},
"referrer_acl": {
"enabled": False,
"excepted_values": ["string"],
"policy_type": "string",
},
"request_limiter": {
"enabled": False,
"rate": 0,
"burst": 0,
"delay": 0,
"rate_unit": "string",
},
"response_headers_hiding_policy": {
"enabled": False,
"mode": "string",
"excepteds": ["string"],
},
"rewrite": {
"body": "string",
"enabled": False,
"flag": "string",
},
"secure_key": {
"enabled": False,
"key": "string",
"type": 0,
},
"slice": {
"enabled": False,
"value": False,
},
"sni": {
"custom_hostname": "string",
"enabled": False,
"sni_type": "string",
},
"stale": {
"enabled": False,
"values": ["string"],
},
"static_request_headers": {
"enabled": False,
"value": {
"string": "string",
},
},
"static_response_headers": {
"enabled": False,
"values": [{
"name": "string",
"values": ["string"],
"always": False,
}],
},
"user_agent_acl": {
"enabled": False,
"excepted_values": ["string"],
"policy_type": "string",
},
"waap": {
"enabled": False,
"value": False,
},
"websockets": {
"enabled": False,
"value": False,
},
},
origin_group=0,
override_origin_protocol="string",
weight=0)
const cdnResourceRuleResource = new gcore.CdnResourceRule("cdnResourceRuleResource", {
resourceId: 0,
rule: "string",
ruleType: 0,
active: false,
name: "string",
options: {
allowedHttpMethods: {
enabled: false,
values: ["string"],
},
botProtection: {
botChallenge: {
enabled: false,
},
enabled: false,
},
brotliCompression: {
enabled: false,
values: ["string"],
},
browserCacheSettings: {
enabled: false,
value: "string",
},
cors: {
enabled: false,
values: ["string"],
always: false,
},
countryAcl: {
enabled: false,
exceptedValues: ["string"],
policyType: "string",
},
disableProxyForceRanges: {
enabled: false,
value: false,
},
edgeCacheSettings: {
enabled: false,
customValues: {
string: "string",
},
"default": "string",
value: "string",
},
fastedge: {
enabled: false,
onRequestBody: {
appId: "string",
enabled: false,
executeOnEdge: false,
executeOnShield: false,
interruptOnError: false,
},
onRequestHeaders: {
appId: "string",
enabled: false,
executeOnEdge: false,
executeOnShield: false,
interruptOnError: false,
},
onResponseBody: {
appId: "string",
enabled: false,
executeOnEdge: false,
executeOnShield: false,
interruptOnError: false,
},
onResponseHeaders: {
appId: "string",
enabled: false,
executeOnEdge: false,
executeOnShield: false,
interruptOnError: false,
},
},
fetchCompressed: {
enabled: false,
value: false,
},
followOriginRedirect: {
codes: [0],
enabled: false,
},
forceReturn: {
body: "string",
code: 0,
enabled: false,
timeInterval: {
endTime: "string",
startTime: "string",
timeZone: "string",
},
},
forwardHostHeader: {
enabled: false,
value: false,
},
gzipOn: {
enabled: false,
value: false,
},
hostHeader: {
enabled: false,
value: "string",
},
ignoreCookie: {
enabled: false,
value: false,
},
ignoreQueryString: {
enabled: false,
value: false,
},
imageStack: {
enabled: false,
avifEnabled: false,
pngLossless: false,
quality: 0,
webpEnabled: false,
},
ipAddressAcl: {
enabled: false,
exceptedValues: ["string"],
policyType: "string",
},
limitBandwidth: {
enabled: false,
limitType: "string",
buffer: 0,
speed: 0,
},
proxyCacheKey: {
enabled: false,
value: "string",
},
proxyCacheMethodsSet: {
enabled: false,
value: false,
},
proxyConnectTimeout: {
enabled: false,
value: "string",
},
proxyReadTimeout: {
enabled: false,
value: "string",
},
queryParamsBlacklist: {
enabled: false,
values: ["string"],
},
queryParamsWhitelist: {
enabled: false,
values: ["string"],
},
queryStringForwarding: {
enabled: false,
forwardFromFileTypes: ["string"],
forwardToFileTypes: ["string"],
forwardExceptKeys: ["string"],
forwardOnlyKeys: ["string"],
},
redirectHttpToHttps: {
enabled: false,
value: false,
},
redirectHttpsToHttp: {
enabled: false,
value: false,
},
referrerAcl: {
enabled: false,
exceptedValues: ["string"],
policyType: "string",
},
requestLimiter: {
enabled: false,
rate: 0,
burst: 0,
delay: 0,
rateUnit: "string",
},
responseHeadersHidingPolicy: {
enabled: false,
mode: "string",
excepteds: ["string"],
},
rewrite: {
body: "string",
enabled: false,
flag: "string",
},
secureKey: {
enabled: false,
key: "string",
type: 0,
},
slice: {
enabled: false,
value: false,
},
sni: {
customHostname: "string",
enabled: false,
sniType: "string",
},
stale: {
enabled: false,
values: ["string"],
},
staticRequestHeaders: {
enabled: false,
value: {
string: "string",
},
},
staticResponseHeaders: {
enabled: false,
values: [{
name: "string",
values: ["string"],
always: false,
}],
},
userAgentAcl: {
enabled: false,
exceptedValues: ["string"],
policyType: "string",
},
waap: {
enabled: false,
value: false,
},
websockets: {
enabled: false,
value: false,
},
},
originGroup: 0,
overrideOriginProtocol: "string",
weight: 0,
});
type: gcore:CdnResourceRule
properties:
active: false
name: string
options:
allowedHttpMethods:
enabled: false
values:
- string
botProtection:
botChallenge:
enabled: false
enabled: false
brotliCompression:
enabled: false
values:
- string
browserCacheSettings:
enabled: false
value: string
cors:
always: false
enabled: false
values:
- string
countryAcl:
enabled: false
exceptedValues:
- string
policyType: string
disableProxyForceRanges:
enabled: false
value: false
edgeCacheSettings:
customValues:
string: string
default: string
enabled: false
value: string
fastedge:
enabled: false
onRequestBody:
appId: string
enabled: false
executeOnEdge: false
executeOnShield: false
interruptOnError: false
onRequestHeaders:
appId: string
enabled: false
executeOnEdge: false
executeOnShield: false
interruptOnError: false
onResponseBody:
appId: string
enabled: false
executeOnEdge: false
executeOnShield: false
interruptOnError: false
onResponseHeaders:
appId: string
enabled: false
executeOnEdge: false
executeOnShield: false
interruptOnError: false
fetchCompressed:
enabled: false
value: false
followOriginRedirect:
codes:
- 0
enabled: false
forceReturn:
body: string
code: 0
enabled: false
timeInterval:
endTime: string
startTime: string
timeZone: string
forwardHostHeader:
enabled: false
value: false
gzipOn:
enabled: false
value: false
hostHeader:
enabled: false
value: string
ignoreCookie:
enabled: false
value: false
ignoreQueryString:
enabled: false
value: false
imageStack:
avifEnabled: false
enabled: false
pngLossless: false
quality: 0
webpEnabled: false
ipAddressAcl:
enabled: false
exceptedValues:
- string
policyType: string
limitBandwidth:
buffer: 0
enabled: false
limitType: string
speed: 0
proxyCacheKey:
enabled: false
value: string
proxyCacheMethodsSet:
enabled: false
value: false
proxyConnectTimeout:
enabled: false
value: string
proxyReadTimeout:
enabled: false
value: string
queryParamsBlacklist:
enabled: false
values:
- string
queryParamsWhitelist:
enabled: false
values:
- string
queryStringForwarding:
enabled: false
forwardExceptKeys:
- string
forwardFromFileTypes:
- string
forwardOnlyKeys:
- string
forwardToFileTypes:
- string
redirectHttpToHttps:
enabled: false
value: false
redirectHttpsToHttp:
enabled: false
value: false
referrerAcl:
enabled: false
exceptedValues:
- string
policyType: string
requestLimiter:
burst: 0
delay: 0
enabled: false
rate: 0
rateUnit: string
responseHeadersHidingPolicy:
enabled: false
excepteds:
- string
mode: string
rewrite:
body: string
enabled: false
flag: string
secureKey:
enabled: false
key: string
type: 0
slice:
enabled: false
value: false
sni:
customHostname: string
enabled: false
sniType: string
stale:
enabled: false
values:
- string
staticRequestHeaders:
enabled: false
value:
string: string
staticResponseHeaders:
enabled: false
values:
- always: false
name: string
values:
- string
userAgentAcl:
enabled: false
exceptedValues:
- string
policyType: string
waap:
enabled: false
value: false
websockets:
enabled: false
value: false
originGroup: 0
overrideOriginProtocol: string
resourceId: 0
rule: string
ruleType: 0
weight: 0
CdnResourceRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CdnResourceRule resource accepts the following input properties:
- Resource
Id double - Rule string
- Path to the file or folder for which the rule will be applied.
- Rule
Type double Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- Active bool
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- Name string
- Rule name.
- Options
Cdn
Resource Rule Options List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- Origin
Group double ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- Override
Origin stringProtocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- Weight double
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
- Resource
Id float64 - Rule string
- Path to the file or folder for which the rule will be applied.
- Rule
Type float64 Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- Active bool
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- Name string
- Rule name.
- Options
Cdn
Resource Rule Options Args List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- Origin
Group float64 ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- Override
Origin stringProtocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- Weight float64
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
- resource
Id Double - rule String
- Path to the file or folder for which the rule will be applied.
- rule
Type Double Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- active Boolean
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- name String
- Rule name.
- options
Cdn
Resource Rule Options List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- origin
Group Double ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- override
Origin StringProtocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- weight Double
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
- resource
Id number - rule string
- Path to the file or folder for which the rule will be applied.
- rule
Type number Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- active boolean
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- name string
- Rule name.
- options
Cdn
Resource Rule Options List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- origin
Group number ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- override
Origin stringProtocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- weight number
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
- resource_
id float - rule str
- Path to the file or folder for which the rule will be applied.
- rule_
type float Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- active bool
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- name str
- Rule name.
- options
Cdn
Resource Rule Options Args List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- origin_
group float ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- override_
origin_ strprotocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- weight float
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
- resource
Id Number - rule String
- Path to the file or folder for which the rule will be applied.
- rule
Type Number Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- active Boolean
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- name String
- Rule name.
- options Property Map
List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- origin
Group Number ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- override
Origin StringProtocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- weight Number
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
Outputs
All input properties are implicitly available as output properties. Additionally, the CdnResourceRule resource produces the following output properties:
- Cdn
Resource doubleRule Id - Rule ID.
- Deleted bool
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- Id string
- The provider-assigned unique ID for this managed resource.
- Origin
Protocol string Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- Preset
Applied bool Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- Primary
Rule double - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- Cdn
Resource float64Rule Id - Rule ID.
- Deleted bool
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- Id string
- The provider-assigned unique ID for this managed resource.
- Origin
Protocol string Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- Preset
Applied bool Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- Primary
Rule float64 - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- cdn
Resource DoubleRule Id - Rule ID.
- deleted Boolean
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- id String
- The provider-assigned unique ID for this managed resource.
- origin
Protocol String Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- preset
Applied Boolean Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- primary
Rule Double - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- cdn
Resource numberRule Id - Rule ID.
- deleted boolean
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- id string
- The provider-assigned unique ID for this managed resource.
- origin
Protocol string Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- preset
Applied boolean Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- primary
Rule number - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- cdn_
resource_ floatrule_ id - Rule ID.
- deleted bool
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- id str
- The provider-assigned unique ID for this managed resource.
- origin_
protocol str Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- preset_
applied bool Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- primary_
rule float - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- cdn
Resource NumberRule Id - Rule ID.
- deleted Boolean
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- id String
- The provider-assigned unique ID for this managed resource.
- origin
Protocol String Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- preset
Applied Boolean Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- primary
Rule Number - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
Look up Existing CdnResourceRule Resource
Get an existing CdnResourceRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CdnResourceRuleState, opts?: CustomResourceOptions): CdnResourceRule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
active: Optional[bool] = None,
cdn_resource_rule_id: Optional[float] = None,
deleted: Optional[bool] = None,
name: Optional[str] = None,
options: Optional[CdnResourceRuleOptionsArgs] = None,
origin_group: Optional[float] = None,
origin_protocol: Optional[str] = None,
override_origin_protocol: Optional[str] = None,
preset_applied: Optional[bool] = None,
primary_rule: Optional[float] = None,
resource_id: Optional[float] = None,
rule: Optional[str] = None,
rule_type: Optional[float] = None,
weight: Optional[float] = None) -> CdnResourceRulefunc GetCdnResourceRule(ctx *Context, name string, id IDInput, state *CdnResourceRuleState, opts ...ResourceOption) (*CdnResourceRule, error)public static CdnResourceRule Get(string name, Input<string> id, CdnResourceRuleState? state, CustomResourceOptions? opts = null)public static CdnResourceRule get(String name, Output<String> id, CdnResourceRuleState state, CustomResourceOptions options)resources: _: type: gcore:CdnResourceRule get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Active bool
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- Cdn
Resource doubleRule Id - Rule ID.
- Deleted bool
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- Name string
- Rule name.
- Options
Cdn
Resource Rule Options List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- Origin
Group double ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- Origin
Protocol string Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- Override
Origin stringProtocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- Preset
Applied bool Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- Primary
Rule double - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- Resource
Id double - Rule string
- Path to the file or folder for which the rule will be applied.
- Rule
Type double Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- Weight double
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
- Active bool
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- Cdn
Resource float64Rule Id - Rule ID.
- Deleted bool
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- Name string
- Rule name.
- Options
Cdn
Resource Rule Options Args List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- Origin
Group float64 ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- Origin
Protocol string Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- Override
Origin stringProtocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- Preset
Applied bool Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- Primary
Rule float64 - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- Resource
Id float64 - Rule string
- Path to the file or folder for which the rule will be applied.
- Rule
Type float64 Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- Weight float64
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
- active Boolean
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- cdn
Resource DoubleRule Id - Rule ID.
- deleted Boolean
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- name String
- Rule name.
- options
Cdn
Resource Rule Options List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- origin
Group Double ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- origin
Protocol String Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- override
Origin StringProtocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- preset
Applied Boolean Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- primary
Rule Double - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- resource
Id Double - rule String
- Path to the file or folder for which the rule will be applied.
- rule
Type Double Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- weight Double
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
- active boolean
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- cdn
Resource numberRule Id - Rule ID.
- deleted boolean
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- name string
- Rule name.
- options
Cdn
Resource Rule Options List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- origin
Group number ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- origin
Protocol string Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- override
Origin stringProtocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- preset
Applied boolean Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- primary
Rule number - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- resource
Id number - rule string
- Path to the file or folder for which the rule will be applied.
- rule
Type number Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- weight number
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
- active bool
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- cdn_
resource_ floatrule_ id - Rule ID.
- deleted bool
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- name str
- Rule name.
- options
Cdn
Resource Rule Options Args List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- origin_
group float ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- origin_
protocol str Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- override_
origin_ strprotocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- preset_
applied bool Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- primary_
rule float - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- resource_
id float - rule str
- Path to the file or folder for which the rule will be applied.
- rule_
type float Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- weight float
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
- active Boolean
Enables or disables a rule.
Possible values:
- true - Rule is active, rule settings are applied.
- false - Rule is inactive, rule settings are not applied.
- cdn
Resource NumberRule Id - Rule ID.
- deleted Boolean
Defines whether the rule has been deleted.
Possible values:
- true - Rule has been deleted.
- false - Rule has not been deleted.
- name String
- Rule name.
- options Property Map
List of options that can be configured for the rule.
In case of
nullvalue the option is not added to the rule. Option inherits its value from the CDN resource settings.- origin
Group Number ID of the origin group to which the rule is applied.
If the origin group is not specified, the rule is applied to the origin group that the CDN resource is associated with.
- origin
Protocol String Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols. Available values: "HTTPS", "HTTP", "MATCH".
- override
Origin StringProtocol Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings. Available values: "HTTPS", "HTTP", "MATCH".
- preset
Applied Boolean Defines whether the rule has an applied preset.
Possible values:
- true - Rule has a preset applied.
- false - Rule does not have a preset applied.
If a preset is applied to the rule, the options included in the preset cannot be edited for the rule.
- primary
Rule Number - ID of the rule with which the current rule is synchronized within the CDN resource shared cache zone feature.
- resource
Id Number - rule String
- Path to the file or folder for which the rule will be applied.
- rule
Type Number Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
- weight Number
Rule execution order: from lowest (1) to highest.
If requested URI matches multiple rules, the one higher in the order of the rules will be applied.
Supporting Types
CdnResourceRuleOptions, CdnResourceRuleOptionsArgs
- Allowed
Http CdnMethods Resource Rule Options Allowed Http Methods - HTTP methods allowed for content requests from the CDN.
- Bot
Protection CdnResource Rule Options Bot Protection - Allows to prevent online services from overloading and ensure your business workflow running smoothly.
- Brotli
Compression CdnResource Rule Options Brotli Compression - Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
- Browser
Cache CdnSettings Resource Rule Options Browser Cache Settings Cache expiration time for users browsers in seconds.
Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
Responses with other codes will not be cached.
- Cache
Http CdnHeaders Resource Rule Options Cache Http Headers Legacy option. Use the
response_headers_hiding_policyoption instead.HTTP Headers that must be included in the response.
- Cors
Cdn
Resource Rule Options Cors Enables or disables CORS (Cross-Origin Resource Sharing) header support.
CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.
- Country
Acl CdnResource Rule Options Country Acl - Enables control access to content for specified countries.
- Disable
Cache CdnResource Rule Options Disable Cache Legacy option. Use the
edge_cache_settingsoption instead.Allows the complete disabling of content caching.
- Disable
Proxy CdnForce Ranges Resource Rule Options Disable Proxy Force Ranges - Allows 206 responses regardless of the settings of an origin source.
- Edge
Cache CdnSettings Resource Rule Options Edge Cache Settings Cache expiration time for CDN servers.
valueanddefaultfields cannot be used simultaneously.- Fastedge
Cdn
Resource Rule Options Fastedge Allows to configure FastEdge app to be called on different request/response phases.
Note: At least one of
on_request_headers,on_request_body,on_response_headers, oron_response_bodymust be specified.- Fetch
Compressed CdnResource Rule Options Fetch Compressed Makes the CDN request compressed content from the origin.
The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.
Notes:
fetch_compressedis not supported withgzipONorbrotli_compressionorsliceoptions enabled.fetch_compressedoverridesgzipONandbrotli_compressionin rule. If you enable it in CDN resource and want to usegzipONandbrotli_compressionin a rule, you have to specify"fetch_compressed": falsein the rule.
- Follow
Origin CdnRedirect Resource Rule Options Follow Origin Redirect - Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
- Force
Return CdnResource Rule Options Force Return Applies custom HTTP response codes for CDN content.
The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.
- Forward
Host CdnHeader Resource Rule Options Forward Host Header Forwards the Host header from a end-user request to an origin server.
hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.- Gzip
On CdnResource Rule Options Gzip On Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.
Notes:
- Compression with gzip is not supported with
fetch_compressedorsliceoptions enabled. fetch_compressedoption in CDN resource settings overridesgzipONin rules. If you enablefetch_compressedin CDN resource and want to enablegzipONin rules, you need to specify"fetch_compressed":falsefor rules.
- Compression with gzip is not supported with
- Host
Header CdnResource Rule Options Host Header Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.
If the option is
null, the Host Header value is equal to first CNAME.hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.-
Cdn
Resource Rule Options Ignore Cookie - Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
- Ignore
Query CdnString Resource Rule Options Ignore Query String How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- Image
Stack CdnResource Rule Options Image Stack - Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
- Ip
Address CdnAcl Resource Rule Options Ip Address Acl Controls access to the CDN resource content for specific IP addresses.
If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.
We recommend you use a script for automatically update IP ACL. Read more.
- Limit
Bandwidth CdnResource Rule Options Limit Bandwidth - Allows to control the download speed per connection.
- Proxy
Cache CdnKey Resource Rule Options Proxy Cache Key Allows you to modify your cache key. If omitted, the default value is
$request_uri.Combine the specified variables to create a key for caching.
- $
request_uri - $scheme
- $uri
Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.
- $
- Proxy
Cache CdnMethods Set Resource Rule Options Proxy Cache Methods Set - Caching for POST requests along with default GET and HEAD.
- Proxy
Connect CdnTimeout Resource Rule Options Proxy Connect Timeout - The time limit for establishing a connection with the origin.
- Proxy
Read CdnTimeout Resource Rule Options Proxy Read Timeout The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.
Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).
- Query
Params CdnBlacklist Resource Rule Options Query Params Blacklist Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- Query
Params CdnWhitelist Resource Rule Options Query Params Whitelist Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- Query
String CdnForwarding Resource Rule Options Query String Forwarding - The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
- Redirect
Http CdnTo Https Resource Rule Options Redirect Http To Https Enables redirect from HTTP to HTTPS.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- Redirect
Https CdnTo Http Resource Rule Options Redirect Https To Http Enables redirect from HTTPS to HTTP.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- Referrer
Acl CdnResource Rule Options Referrer Acl - Controls access to the CDN resource content for specified domain names.
- Request
Limiter CdnResource Rule Options Request Limiter - Option allows to limit the amount of HTTP requests.
- Response
Headers CdnHiding Policy Resource Rule Options Response Headers Hiding Policy - Hides HTTP headers from an origin server in the CDN response.
- Rewrite
Cdn
Resource Rule Options Rewrite - Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
- Secure
Key CdnResource Rule Options Secure Key - Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
- Slice
Cdn
Resource Rule Options Slice Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.
The option is based on the Slice module.
Notes:
- Origin must support HTTP Range requests.
- Not supported with
gzipON,brotli_compressionorfetch_compressedoptions enabled.
- Sni
Cdn
Resource Rule Options Sni The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.
SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.
The option works only if
originProtocolparameter isHTTPSorMATCH.- Stale
Cdn
Resource Rule Options Stale - Serves stale cached content in case of origin unavailability.
- Static
Headers CdnResource Rule Options Static Headers Legacy option. Use the
static_response_headersoption instead.Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.
- Static
Request CdnHeaders Resource Rule Options Static Request Headers - Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
- Static
Response CdnHeaders Resource Rule Options Static Response Headers - Custom HTTP Headers that a CDN server adds to a response.
- User
Agent CdnAcl Resource Rule Options User Agent Acl - Controls access to the content for specified User-Agents.
- Waap
Cdn
Resource Rule Options Waap - Allows to enable WAAP (Web Application and API Protection).
- Websockets
Cdn
Resource Rule Options Websockets - Enables or disables WebSockets connections to an origin server.
- Allowed
Http CdnMethods Resource Rule Options Allowed Http Methods - HTTP methods allowed for content requests from the CDN.
- Bot
Protection CdnResource Rule Options Bot Protection - Allows to prevent online services from overloading and ensure your business workflow running smoothly.
- Brotli
Compression CdnResource Rule Options Brotli Compression - Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
- Browser
Cache CdnSettings Resource Rule Options Browser Cache Settings Cache expiration time for users browsers in seconds.
Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
Responses with other codes will not be cached.
- Cache
Http CdnHeaders Resource Rule Options Cache Http Headers Legacy option. Use the
response_headers_hiding_policyoption instead.HTTP Headers that must be included in the response.
- Cors
Cdn
Resource Rule Options Cors Enables or disables CORS (Cross-Origin Resource Sharing) header support.
CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.
- Country
Acl CdnResource Rule Options Country Acl - Enables control access to content for specified countries.
- Disable
Cache CdnResource Rule Options Disable Cache Legacy option. Use the
edge_cache_settingsoption instead.Allows the complete disabling of content caching.
- Disable
Proxy CdnForce Ranges Resource Rule Options Disable Proxy Force Ranges - Allows 206 responses regardless of the settings of an origin source.
- Edge
Cache CdnSettings Resource Rule Options Edge Cache Settings Cache expiration time for CDN servers.
valueanddefaultfields cannot be used simultaneously.- Fastedge
Cdn
Resource Rule Options Fastedge Allows to configure FastEdge app to be called on different request/response phases.
Note: At least one of
on_request_headers,on_request_body,on_response_headers, oron_response_bodymust be specified.- Fetch
Compressed CdnResource Rule Options Fetch Compressed Makes the CDN request compressed content from the origin.
The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.
Notes:
fetch_compressedis not supported withgzipONorbrotli_compressionorsliceoptions enabled.fetch_compressedoverridesgzipONandbrotli_compressionin rule. If you enable it in CDN resource and want to usegzipONandbrotli_compressionin a rule, you have to specify"fetch_compressed": falsein the rule.
- Follow
Origin CdnRedirect Resource Rule Options Follow Origin Redirect - Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
- Force
Return CdnResource Rule Options Force Return Applies custom HTTP response codes for CDN content.
The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.
- Forward
Host CdnHeader Resource Rule Options Forward Host Header Forwards the Host header from a end-user request to an origin server.
hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.- Gzip
On CdnResource Rule Options Gzip On Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.
Notes:
- Compression with gzip is not supported with
fetch_compressedorsliceoptions enabled. fetch_compressedoption in CDN resource settings overridesgzipONin rules. If you enablefetch_compressedin CDN resource and want to enablegzipONin rules, you need to specify"fetch_compressed":falsefor rules.
- Compression with gzip is not supported with
- Host
Header CdnResource Rule Options Host Header Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.
If the option is
null, the Host Header value is equal to first CNAME.hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.-
Cdn
Resource Rule Options Ignore Cookie - Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
- Ignore
Query CdnString Resource Rule Options Ignore Query String How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- Image
Stack CdnResource Rule Options Image Stack - Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
- Ip
Address CdnAcl Resource Rule Options Ip Address Acl Controls access to the CDN resource content for specific IP addresses.
If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.
We recommend you use a script for automatically update IP ACL. Read more.
- Limit
Bandwidth CdnResource Rule Options Limit Bandwidth - Allows to control the download speed per connection.
- Proxy
Cache CdnKey Resource Rule Options Proxy Cache Key Allows you to modify your cache key. If omitted, the default value is
$request_uri.Combine the specified variables to create a key for caching.
- $
request_uri - $scheme
- $uri
Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.
- $
- Proxy
Cache CdnMethods Set Resource Rule Options Proxy Cache Methods Set - Caching for POST requests along with default GET and HEAD.
- Proxy
Connect CdnTimeout Resource Rule Options Proxy Connect Timeout - The time limit for establishing a connection with the origin.
- Proxy
Read CdnTimeout Resource Rule Options Proxy Read Timeout The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.
Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).
- Query
Params CdnBlacklist Resource Rule Options Query Params Blacklist Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- Query
Params CdnWhitelist Resource Rule Options Query Params Whitelist Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- Query
String CdnForwarding Resource Rule Options Query String Forwarding - The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
- Redirect
Http CdnTo Https Resource Rule Options Redirect Http To Https Enables redirect from HTTP to HTTPS.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- Redirect
Https CdnTo Http Resource Rule Options Redirect Https To Http Enables redirect from HTTPS to HTTP.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- Referrer
Acl CdnResource Rule Options Referrer Acl - Controls access to the CDN resource content for specified domain names.
- Request
Limiter CdnResource Rule Options Request Limiter - Option allows to limit the amount of HTTP requests.
- Response
Headers CdnHiding Policy Resource Rule Options Response Headers Hiding Policy - Hides HTTP headers from an origin server in the CDN response.
- Rewrite
Cdn
Resource Rule Options Rewrite - Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
- Secure
Key CdnResource Rule Options Secure Key - Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
- Slice
Cdn
Resource Rule Options Slice Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.
The option is based on the Slice module.
Notes:
- Origin must support HTTP Range requests.
- Not supported with
gzipON,brotli_compressionorfetch_compressedoptions enabled.
- Sni
Cdn
Resource Rule Options Sni The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.
SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.
The option works only if
originProtocolparameter isHTTPSorMATCH.- Stale
Cdn
Resource Rule Options Stale - Serves stale cached content in case of origin unavailability.
- Static
Headers CdnResource Rule Options Static Headers Legacy option. Use the
static_response_headersoption instead.Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.
- Static
Request CdnHeaders Resource Rule Options Static Request Headers - Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
- Static
Response CdnHeaders Resource Rule Options Static Response Headers - Custom HTTP Headers that a CDN server adds to a response.
- User
Agent CdnAcl Resource Rule Options User Agent Acl - Controls access to the content for specified User-Agents.
- Waap
Cdn
Resource Rule Options Waap - Allows to enable WAAP (Web Application and API Protection).
- Websockets
Cdn
Resource Rule Options Websockets - Enables or disables WebSockets connections to an origin server.
- allowed
Http CdnMethods Resource Rule Options Allowed Http Methods - HTTP methods allowed for content requests from the CDN.
- bot
Protection CdnResource Rule Options Bot Protection - Allows to prevent online services from overloading and ensure your business workflow running smoothly.
- brotli
Compression CdnResource Rule Options Brotli Compression - Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
- browser
Cache CdnSettings Resource Rule Options Browser Cache Settings Cache expiration time for users browsers in seconds.
Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
Responses with other codes will not be cached.
- cache
Http CdnHeaders Resource Rule Options Cache Http Headers Legacy option. Use the
response_headers_hiding_policyoption instead.HTTP Headers that must be included in the response.
- cors
Cdn
Resource Rule Options Cors Enables or disables CORS (Cross-Origin Resource Sharing) header support.
CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.
- country
Acl CdnResource Rule Options Country Acl - Enables control access to content for specified countries.
- disable
Cache CdnResource Rule Options Disable Cache Legacy option. Use the
edge_cache_settingsoption instead.Allows the complete disabling of content caching.
- disable
Proxy CdnForce Ranges Resource Rule Options Disable Proxy Force Ranges - Allows 206 responses regardless of the settings of an origin source.
- edge
Cache CdnSettings Resource Rule Options Edge Cache Settings Cache expiration time for CDN servers.
valueanddefaultfields cannot be used simultaneously.- fastedge
Cdn
Resource Rule Options Fastedge Allows to configure FastEdge app to be called on different request/response phases.
Note: At least one of
on_request_headers,on_request_body,on_response_headers, oron_response_bodymust be specified.- fetch
Compressed CdnResource Rule Options Fetch Compressed Makes the CDN request compressed content from the origin.
The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.
Notes:
fetch_compressedis not supported withgzipONorbrotli_compressionorsliceoptions enabled.fetch_compressedoverridesgzipONandbrotli_compressionin rule. If you enable it in CDN resource and want to usegzipONandbrotli_compressionin a rule, you have to specify"fetch_compressed": falsein the rule.
- follow
Origin CdnRedirect Resource Rule Options Follow Origin Redirect - Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
- force
Return CdnResource Rule Options Force Return Applies custom HTTP response codes for CDN content.
The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.
- forward
Host CdnHeader Resource Rule Options Forward Host Header Forwards the Host header from a end-user request to an origin server.
hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.- gzip
On CdnResource Rule Options Gzip On Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.
Notes:
- Compression with gzip is not supported with
fetch_compressedorsliceoptions enabled. fetch_compressedoption in CDN resource settings overridesgzipONin rules. If you enablefetch_compressedin CDN resource and want to enablegzipONin rules, you need to specify"fetch_compressed":falsefor rules.
- Compression with gzip is not supported with
- host
Header CdnResource Rule Options Host Header Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.
If the option is
null, the Host Header value is equal to first CNAME.hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.-
Cdn
Resource Rule Options Ignore Cookie - Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
- ignore
Query CdnString Resource Rule Options Ignore Query String How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- image
Stack CdnResource Rule Options Image Stack - Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
- ip
Address CdnAcl Resource Rule Options Ip Address Acl Controls access to the CDN resource content for specific IP addresses.
If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.
We recommend you use a script for automatically update IP ACL. Read more.
- limit
Bandwidth CdnResource Rule Options Limit Bandwidth - Allows to control the download speed per connection.
- proxy
Cache CdnKey Resource Rule Options Proxy Cache Key Allows you to modify your cache key. If omitted, the default value is
$request_uri.Combine the specified variables to create a key for caching.
- $
request_uri - $scheme
- $uri
Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.
- $
- proxy
Cache CdnMethods Set Resource Rule Options Proxy Cache Methods Set - Caching for POST requests along with default GET and HEAD.
- proxy
Connect CdnTimeout Resource Rule Options Proxy Connect Timeout - The time limit for establishing a connection with the origin.
- proxy
Read CdnTimeout Resource Rule Options Proxy Read Timeout The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.
Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).
- query
Params CdnBlacklist Resource Rule Options Query Params Blacklist Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- query
Params CdnWhitelist Resource Rule Options Query Params Whitelist Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- query
String CdnForwarding Resource Rule Options Query String Forwarding - The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
- redirect
Http CdnTo Https Resource Rule Options Redirect Http To Https Enables redirect from HTTP to HTTPS.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- redirect
Https CdnTo Http Resource Rule Options Redirect Https To Http Enables redirect from HTTPS to HTTP.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- referrer
Acl CdnResource Rule Options Referrer Acl - Controls access to the CDN resource content for specified domain names.
- request
Limiter CdnResource Rule Options Request Limiter - Option allows to limit the amount of HTTP requests.
- response
Headers CdnHiding Policy Resource Rule Options Response Headers Hiding Policy - Hides HTTP headers from an origin server in the CDN response.
- rewrite
Cdn
Resource Rule Options Rewrite - Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
- secure
Key CdnResource Rule Options Secure Key - Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
- slice
Cdn
Resource Rule Options Slice Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.
The option is based on the Slice module.
Notes:
- Origin must support HTTP Range requests.
- Not supported with
gzipON,brotli_compressionorfetch_compressedoptions enabled.
- sni
Cdn
Resource Rule Options Sni The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.
SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.
The option works only if
originProtocolparameter isHTTPSorMATCH.- stale
Cdn
Resource Rule Options Stale - Serves stale cached content in case of origin unavailability.
- static
Headers CdnResource Rule Options Static Headers Legacy option. Use the
static_response_headersoption instead.Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.
- static
Request CdnHeaders Resource Rule Options Static Request Headers - Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
- static
Response CdnHeaders Resource Rule Options Static Response Headers - Custom HTTP Headers that a CDN server adds to a response.
- user
Agent CdnAcl Resource Rule Options User Agent Acl - Controls access to the content for specified User-Agents.
- waap
Cdn
Resource Rule Options Waap - Allows to enable WAAP (Web Application and API Protection).
- websockets
Cdn
Resource Rule Options Websockets - Enables or disables WebSockets connections to an origin server.
- allowed
Http CdnMethods Resource Rule Options Allowed Http Methods - HTTP methods allowed for content requests from the CDN.
- bot
Protection CdnResource Rule Options Bot Protection - Allows to prevent online services from overloading and ensure your business workflow running smoothly.
- brotli
Compression CdnResource Rule Options Brotli Compression - Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
- browser
Cache CdnSettings Resource Rule Options Browser Cache Settings Cache expiration time for users browsers in seconds.
Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
Responses with other codes will not be cached.
- cache
Http CdnHeaders Resource Rule Options Cache Http Headers Legacy option. Use the
response_headers_hiding_policyoption instead.HTTP Headers that must be included in the response.
- cors
Cdn
Resource Rule Options Cors Enables or disables CORS (Cross-Origin Resource Sharing) header support.
CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.
- country
Acl CdnResource Rule Options Country Acl - Enables control access to content for specified countries.
- disable
Cache CdnResource Rule Options Disable Cache Legacy option. Use the
edge_cache_settingsoption instead.Allows the complete disabling of content caching.
- disable
Proxy CdnForce Ranges Resource Rule Options Disable Proxy Force Ranges - Allows 206 responses regardless of the settings of an origin source.
- edge
Cache CdnSettings Resource Rule Options Edge Cache Settings Cache expiration time for CDN servers.
valueanddefaultfields cannot be used simultaneously.- fastedge
Cdn
Resource Rule Options Fastedge Allows to configure FastEdge app to be called on different request/response phases.
Note: At least one of
on_request_headers,on_request_body,on_response_headers, oron_response_bodymust be specified.- fetch
Compressed CdnResource Rule Options Fetch Compressed Makes the CDN request compressed content from the origin.
The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.
Notes:
fetch_compressedis not supported withgzipONorbrotli_compressionorsliceoptions enabled.fetch_compressedoverridesgzipONandbrotli_compressionin rule. If you enable it in CDN resource and want to usegzipONandbrotli_compressionin a rule, you have to specify"fetch_compressed": falsein the rule.
- follow
Origin CdnRedirect Resource Rule Options Follow Origin Redirect - Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
- force
Return CdnResource Rule Options Force Return Applies custom HTTP response codes for CDN content.
The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.
- forward
Host CdnHeader Resource Rule Options Forward Host Header Forwards the Host header from a end-user request to an origin server.
hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.- gzip
On CdnResource Rule Options Gzip On Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.
Notes:
- Compression with gzip is not supported with
fetch_compressedorsliceoptions enabled. fetch_compressedoption in CDN resource settings overridesgzipONin rules. If you enablefetch_compressedin CDN resource and want to enablegzipONin rules, you need to specify"fetch_compressed":falsefor rules.
- Compression with gzip is not supported with
- host
Header CdnResource Rule Options Host Header Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.
If the option is
null, the Host Header value is equal to first CNAME.hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.-
Cdn
Resource Rule Options Ignore Cookie - Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
- ignore
Query CdnString Resource Rule Options Ignore Query String How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- image
Stack CdnResource Rule Options Image Stack - Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
- ip
Address CdnAcl Resource Rule Options Ip Address Acl Controls access to the CDN resource content for specific IP addresses.
If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.
We recommend you use a script for automatically update IP ACL. Read more.
- limit
Bandwidth CdnResource Rule Options Limit Bandwidth - Allows to control the download speed per connection.
- proxy
Cache CdnKey Resource Rule Options Proxy Cache Key Allows you to modify your cache key. If omitted, the default value is
$request_uri.Combine the specified variables to create a key for caching.
- $
request_uri - $scheme
- $uri
Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.
- $
- proxy
Cache CdnMethods Set Resource Rule Options Proxy Cache Methods Set - Caching for POST requests along with default GET and HEAD.
- proxy
Connect CdnTimeout Resource Rule Options Proxy Connect Timeout - The time limit for establishing a connection with the origin.
- proxy
Read CdnTimeout Resource Rule Options Proxy Read Timeout The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.
Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).
- query
Params CdnBlacklist Resource Rule Options Query Params Blacklist Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- query
Params CdnWhitelist Resource Rule Options Query Params Whitelist Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- query
String CdnForwarding Resource Rule Options Query String Forwarding - The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
- redirect
Http CdnTo Https Resource Rule Options Redirect Http To Https Enables redirect from HTTP to HTTPS.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- redirect
Https CdnTo Http Resource Rule Options Redirect Https To Http Enables redirect from HTTPS to HTTP.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- referrer
Acl CdnResource Rule Options Referrer Acl - Controls access to the CDN resource content for specified domain names.
- request
Limiter CdnResource Rule Options Request Limiter - Option allows to limit the amount of HTTP requests.
- response
Headers CdnHiding Policy Resource Rule Options Response Headers Hiding Policy - Hides HTTP headers from an origin server in the CDN response.
- rewrite
Cdn
Resource Rule Options Rewrite - Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
- secure
Key CdnResource Rule Options Secure Key - Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
- slice
Cdn
Resource Rule Options Slice Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.
The option is based on the Slice module.
Notes:
- Origin must support HTTP Range requests.
- Not supported with
gzipON,brotli_compressionorfetch_compressedoptions enabled.
- sni
Cdn
Resource Rule Options Sni The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.
SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.
The option works only if
originProtocolparameter isHTTPSorMATCH.- stale
Cdn
Resource Rule Options Stale - Serves stale cached content in case of origin unavailability.
- static
Headers CdnResource Rule Options Static Headers Legacy option. Use the
static_response_headersoption instead.Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.
- static
Request CdnHeaders Resource Rule Options Static Request Headers - Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
- static
Response CdnHeaders Resource Rule Options Static Response Headers - Custom HTTP Headers that a CDN server adds to a response.
- user
Agent CdnAcl Resource Rule Options User Agent Acl - Controls access to the content for specified User-Agents.
- waap
Cdn
Resource Rule Options Waap - Allows to enable WAAP (Web Application and API Protection).
- websockets
Cdn
Resource Rule Options Websockets - Enables or disables WebSockets connections to an origin server.
- allowed_
http_ Cdnmethods Resource Rule Options Allowed Http Methods - HTTP methods allowed for content requests from the CDN.
- bot_
protection CdnResource Rule Options Bot Protection - Allows to prevent online services from overloading and ensure your business workflow running smoothly.
- brotli_
compression CdnResource Rule Options Brotli Compression - Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
- browser_
cache_ Cdnsettings Resource Rule Options Browser Cache Settings Cache expiration time for users browsers in seconds.
Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
Responses with other codes will not be cached.
- cache_
http_ Cdnheaders Resource Rule Options Cache Http Headers Legacy option. Use the
response_headers_hiding_policyoption instead.HTTP Headers that must be included in the response.
- cors
Cdn
Resource Rule Options Cors Enables or disables CORS (Cross-Origin Resource Sharing) header support.
CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.
- country_
acl CdnResource Rule Options Country Acl - Enables control access to content for specified countries.
- disable_
cache CdnResource Rule Options Disable Cache Legacy option. Use the
edge_cache_settingsoption instead.Allows the complete disabling of content caching.
- disable_
proxy_ Cdnforce_ ranges Resource Rule Options Disable Proxy Force Ranges - Allows 206 responses regardless of the settings of an origin source.
- edge_
cache_ Cdnsettings Resource Rule Options Edge Cache Settings Cache expiration time for CDN servers.
valueanddefaultfields cannot be used simultaneously.- fastedge
Cdn
Resource Rule Options Fastedge Allows to configure FastEdge app to be called on different request/response phases.
Note: At least one of
on_request_headers,on_request_body,on_response_headers, oron_response_bodymust be specified.- fetch_
compressed CdnResource Rule Options Fetch Compressed Makes the CDN request compressed content from the origin.
The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.
Notes:
fetch_compressedis not supported withgzipONorbrotli_compressionorsliceoptions enabled.fetch_compressedoverridesgzipONandbrotli_compressionin rule. If you enable it in CDN resource and want to usegzipONandbrotli_compressionin a rule, you have to specify"fetch_compressed": falsein the rule.
- follow_
origin_ Cdnredirect Resource Rule Options Follow Origin Redirect - Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
- force_
return CdnResource Rule Options Force Return Applies custom HTTP response codes for CDN content.
The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.
- forward_
host_ Cdnheader Resource Rule Options Forward Host Header Forwards the Host header from a end-user request to an origin server.
hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.- gzip_
on CdnResource Rule Options Gzip On Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.
Notes:
- Compression with gzip is not supported with
fetch_compressedorsliceoptions enabled. fetch_compressedoption in CDN resource settings overridesgzipONin rules. If you enablefetch_compressedin CDN resource and want to enablegzipONin rules, you need to specify"fetch_compressed":falsefor rules.
- Compression with gzip is not supported with
- host_
header CdnResource Rule Options Host Header Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.
If the option is
null, the Host Header value is equal to first CNAME.hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.-
Cdn
Resource Rule Options Ignore Cookie - Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
- ignore_
query_ Cdnstring Resource Rule Options Ignore Query String How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- image_
stack CdnResource Rule Options Image Stack - Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
- ip_
address_ Cdnacl Resource Rule Options Ip Address Acl Controls access to the CDN resource content for specific IP addresses.
If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.
We recommend you use a script for automatically update IP ACL. Read more.
- limit_
bandwidth CdnResource Rule Options Limit Bandwidth - Allows to control the download speed per connection.
- proxy_
cache_ Cdnkey Resource Rule Options Proxy Cache Key Allows you to modify your cache key. If omitted, the default value is
$request_uri.Combine the specified variables to create a key for caching.
- $
request_uri - $scheme
- $uri
Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.
- $
- proxy_
cache_ Cdnmethods_ set Resource Rule Options Proxy Cache Methods Set - Caching for POST requests along with default GET and HEAD.
- proxy_
connect_ Cdntimeout Resource Rule Options Proxy Connect Timeout - The time limit for establishing a connection with the origin.
- proxy_
read_ Cdntimeout Resource Rule Options Proxy Read Timeout The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.
Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).
- query_
params_ Cdnblacklist Resource Rule Options Query Params Blacklist Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- query_
params_ Cdnwhitelist Resource Rule Options Query Params Whitelist Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- query_
string_ Cdnforwarding Resource Rule Options Query String Forwarding - The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
- redirect_
http_ Cdnto_ https Resource Rule Options Redirect Http To Https Enables redirect from HTTP to HTTPS.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- redirect_
https_ Cdnto_ http Resource Rule Options Redirect Https To Http Enables redirect from HTTPS to HTTP.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- referrer_
acl CdnResource Rule Options Referrer Acl - Controls access to the CDN resource content for specified domain names.
- request_
limiter CdnResource Rule Options Request Limiter - Option allows to limit the amount of HTTP requests.
- response_
headers_ Cdnhiding_ policy Resource Rule Options Response Headers Hiding Policy - Hides HTTP headers from an origin server in the CDN response.
- rewrite
Cdn
Resource Rule Options Rewrite - Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
- secure_
key CdnResource Rule Options Secure Key - Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
- slice
Cdn
Resource Rule Options Slice Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.
The option is based on the Slice module.
Notes:
- Origin must support HTTP Range requests.
- Not supported with
gzipON,brotli_compressionorfetch_compressedoptions enabled.
- sni
Cdn
Resource Rule Options Sni The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.
SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.
The option works only if
originProtocolparameter isHTTPSorMATCH.- stale
Cdn
Resource Rule Options Stale - Serves stale cached content in case of origin unavailability.
- static_
headers CdnResource Rule Options Static Headers Legacy option. Use the
static_response_headersoption instead.Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.
- static_
request_ Cdnheaders Resource Rule Options Static Request Headers - Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
- static_
response_ Cdnheaders Resource Rule Options Static Response Headers - Custom HTTP Headers that a CDN server adds to a response.
- user_
agent_ Cdnacl Resource Rule Options User Agent Acl - Controls access to the content for specified User-Agents.
- waap
Cdn
Resource Rule Options Waap - Allows to enable WAAP (Web Application and API Protection).
- websockets
Cdn
Resource Rule Options Websockets - Enables or disables WebSockets connections to an origin server.
- allowed
Http Property MapMethods - HTTP methods allowed for content requests from the CDN.
- bot
Protection Property Map - Allows to prevent online services from overloading and ensure your business workflow running smoothly.
- brotli
Compression Property Map - Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
- browser
Cache Property MapSettings Cache expiration time for users browsers in seconds.
Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
Responses with other codes will not be cached.
- cache
Http Property MapHeaders Legacy option. Use the
response_headers_hiding_policyoption instead.HTTP Headers that must be included in the response.
- cors Property Map
Enables or disables CORS (Cross-Origin Resource Sharing) header support.
CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.
- country
Acl Property Map - Enables control access to content for specified countries.
- disable
Cache Property Map Legacy option. Use the
edge_cache_settingsoption instead.Allows the complete disabling of content caching.
- disable
Proxy Property MapForce Ranges - Allows 206 responses regardless of the settings of an origin source.
- edge
Cache Property MapSettings Cache expiration time for CDN servers.
valueanddefaultfields cannot be used simultaneously.- fastedge Property Map
Allows to configure FastEdge app to be called on different request/response phases.
Note: At least one of
on_request_headers,on_request_body,on_response_headers, oron_response_bodymust be specified.- fetch
Compressed Property Map Makes the CDN request compressed content from the origin.
The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.
Notes:
fetch_compressedis not supported withgzipONorbrotli_compressionorsliceoptions enabled.fetch_compressedoverridesgzipONandbrotli_compressionin rule. If you enable it in CDN resource and want to usegzipONandbrotli_compressionin a rule, you have to specify"fetch_compressed": falsein the rule.
- follow
Origin Property MapRedirect - Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
- force
Return Property Map Applies custom HTTP response codes for CDN content.
The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.
- forward
Host Property MapHeader Forwards the Host header from a end-user request to an origin server.
hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.- gzip
On Property Map Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.
Notes:
- Compression with gzip is not supported with
fetch_compressedorsliceoptions enabled. fetch_compressedoption in CDN resource settings overridesgzipONin rules. If you enablefetch_compressedin CDN resource and want to enablegzipONin rules, you need to specify"fetch_compressed":falsefor rules.
- Compression with gzip is not supported with
- host
Header Property Map Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.
If the option is
null, the Host Header value is equal to first CNAME.hostHeaderandforward_host_headeroptions cannot be enabled simultaneously.- Property Map
- Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
- ignore
Query Property MapString How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- image
Stack Property Map - Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
- ip
Address Property MapAcl Controls access to the CDN resource content for specific IP addresses.
If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.
We recommend you use a script for automatically update IP ACL. Read more.
- limit
Bandwidth Property Map - Allows to control the download speed per connection.
- proxy
Cache Property MapKey Allows you to modify your cache key. If omitted, the default value is
$request_uri.Combine the specified variables to create a key for caching.
- $
request_uri - $scheme
- $uri
Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.
- $
- proxy
Cache Property MapMethods Set - Caching for POST requests along with default GET and HEAD.
- proxy
Connect Property MapTimeout - The time limit for establishing a connection with the origin.
- proxy
Read Property MapTimeout The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.
Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).
- query
Params Property MapBlacklist Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- query
Params Property MapWhitelist Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.
ignoreQueryString,query_params_whitelistandquery_params_blacklistoptions cannot be enabled simultaneously.- query
String Property MapForwarding - The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
- redirect
Http Property MapTo Https Enables redirect from HTTP to HTTPS.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- redirect
Https Property MapTo Http Enables redirect from HTTPS to HTTP.
redirect_http_to_httpsandredirect_https_to_httpoptions cannot be enabled simultaneously.- referrer
Acl Property Map - Controls access to the CDN resource content for specified domain names.
- request
Limiter Property Map - Option allows to limit the amount of HTTP requests.
- response
Headers Property MapHiding Policy - Hides HTTP headers from an origin server in the CDN response.
- rewrite Property Map
- Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
- secure
Key Property Map - Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
- slice Property Map
Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.
The option is based on the Slice module.
Notes:
- Origin must support HTTP Range requests.
- Not supported with
gzipON,brotli_compressionorfetch_compressedoptions enabled.
- sni Property Map
The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.
SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.
The option works only if
originProtocolparameter isHTTPSorMATCH.- stale Property Map
- Serves stale cached content in case of origin unavailability.
- static
Headers Property Map Legacy option. Use the
static_response_headersoption instead.Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.
- static
Request Property MapHeaders - Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
- static
Response Property MapHeaders - Custom HTTP Headers that a CDN server adds to a response.
- user
Agent Property MapAcl - Controls access to the content for specified User-Agents.
- waap Property Map
- Allows to enable WAAP (Web Application and API Protection).
- websockets Property Map
- Enables or disables WebSockets connections to an origin server.
CdnResourceRuleOptionsAllowedHttpMethods, CdnResourceRuleOptionsAllowedHttpMethodsArgs
CdnResourceRuleOptionsBotProtection, CdnResourceRuleOptionsBotProtectionArgs
- Bot
Challenge CdnResource Rule Options Bot Protection Bot Challenge - Controls the bot challenge module state.
- Enabled bool
- Controls the option state.
- Bot
Challenge CdnResource Rule Options Bot Protection Bot Challenge - Controls the bot challenge module state.
- Enabled bool
- Controls the option state.
- bot
Challenge CdnResource Rule Options Bot Protection Bot Challenge - Controls the bot challenge module state.
- enabled Boolean
- Controls the option state.
- bot
Challenge CdnResource Rule Options Bot Protection Bot Challenge - Controls the bot challenge module state.
- enabled boolean
- Controls the option state.
- bot_
challenge CdnResource Rule Options Bot Protection Bot Challenge - Controls the bot challenge module state.
- enabled bool
- Controls the option state.
- bot
Challenge Property Map - Controls the bot challenge module state.
- enabled Boolean
- Controls the option state.
CdnResourceRuleOptionsBotProtectionBotChallenge, CdnResourceRuleOptionsBotProtectionBotChallengeArgs
- Enabled bool
- Possible values:
- Enabled bool
- Possible values:
- enabled Boolean
- Possible values:
- enabled boolean
- Possible values:
- enabled bool
- Possible values:
- enabled Boolean
- Possible values:
CdnResourceRuleOptionsBrotliCompression, CdnResourceRuleOptionsBrotliCompressionArgs
CdnResourceRuleOptionsBrowserCacheSettings, CdnResourceRuleOptionsBrowserCacheSettingsArgs
CdnResourceRuleOptionsCacheHttpHeaders, CdnResourceRuleOptionsCacheHttpHeadersArgs
CdnResourceRuleOptionsCors, CdnResourceRuleOptionsCorsArgs
- Enabled bool
- Controls the option state.
- Values List<string>
Value of the Access-Control-Allow-Origin header.
Possible values:
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
"value": ["*"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field.
"value": ["domain.com", "second.dom.com"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response.
"value": ["$http_origin"]
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
- Always bool
Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response regardless of response code.
- false - Header will only be added to responses with codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
- Enabled bool
- Controls the option state.
- Values []string
Value of the Access-Control-Allow-Origin header.
Possible values:
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
"value": ["*"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field.
"value": ["domain.com", "second.dom.com"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response.
"value": ["$http_origin"]
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
- Always bool
Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response regardless of response code.
- false - Header will only be added to responses with codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
- enabled Boolean
- Controls the option state.
- values List<String>
Value of the Access-Control-Allow-Origin header.
Possible values:
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
"value": ["*"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field.
"value": ["domain.com", "second.dom.com"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response.
"value": ["$http_origin"]
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
- always Boolean
Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response regardless of response code.
- false - Header will only be added to responses with codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
- enabled boolean
- Controls the option state.
- values string[]
Value of the Access-Control-Allow-Origin header.
Possible values:
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
"value": ["*"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field.
"value": ["domain.com", "second.dom.com"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response.
"value": ["$http_origin"]
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
- always boolean
Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response regardless of response code.
- false - Header will only be added to responses with codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
- enabled bool
- Controls the option state.
- values Sequence[str]
Value of the Access-Control-Allow-Origin header.
Possible values:
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
"value": ["*"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field.
"value": ["domain.com", "second.dom.com"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response.
"value": ["$http_origin"]
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
- always bool
Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response regardless of response code.
- false - Header will only be added to responses with codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
- enabled Boolean
- Controls the option state.
- values List<String>
Value of the Access-Control-Allow-Origin header.
Possible values:
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
"value": ["*"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field.
"value": ["domain.com", "second.dom.com"] - Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response.
"value": ["$http_origin"]
- Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain.
- always Boolean
Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response regardless of response code.
- false - Header will only be added to responses with codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
CdnResourceRuleOptionsCountryAcl, CdnResourceRuleOptionsCountryAclArgs
- Enabled bool
- Controls the option state.
- Excepted
Values List<string> List of countries according to ISO-3166-1.
The meaning of the parameter depends on
policy_typevalue:- allow - List of countries for which access is prohibited.
- deny - List of countries for which access is allowed.
- Policy
Type string Defines the type of CDN resource access policy.
Possible values:
- allow - Access is allowed for all the countries except for those specified in
excepted_valuesfield. - deny - Access is denied for all the countries except for those specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Access is allowed for all the countries except for those specified in
- Enabled bool
- Controls the option state.
- Excepted
Values []string List of countries according to ISO-3166-1.
The meaning of the parameter depends on
policy_typevalue:- allow - List of countries for which access is prohibited.
- deny - List of countries for which access is allowed.
- Policy
Type string Defines the type of CDN resource access policy.
Possible values:
- allow - Access is allowed for all the countries except for those specified in
excepted_valuesfield. - deny - Access is denied for all the countries except for those specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Access is allowed for all the countries except for those specified in
- enabled Boolean
- Controls the option state.
- excepted
Values List<String> List of countries according to ISO-3166-1.
The meaning of the parameter depends on
policy_typevalue:- allow - List of countries for which access is prohibited.
- deny - List of countries for which access is allowed.
- policy
Type String Defines the type of CDN resource access policy.
Possible values:
- allow - Access is allowed for all the countries except for those specified in
excepted_valuesfield. - deny - Access is denied for all the countries except for those specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Access is allowed for all the countries except for those specified in
- enabled boolean
- Controls the option state.
- excepted
Values string[] List of countries according to ISO-3166-1.
The meaning of the parameter depends on
policy_typevalue:- allow - List of countries for which access is prohibited.
- deny - List of countries for which access is allowed.
- policy
Type string Defines the type of CDN resource access policy.
Possible values:
- allow - Access is allowed for all the countries except for those specified in
excepted_valuesfield. - deny - Access is denied for all the countries except for those specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Access is allowed for all the countries except for those specified in
- enabled bool
- Controls the option state.
- excepted_
values Sequence[str] List of countries according to ISO-3166-1.
The meaning of the parameter depends on
policy_typevalue:- allow - List of countries for which access is prohibited.
- deny - List of countries for which access is allowed.
- policy_
type str Defines the type of CDN resource access policy.
Possible values:
- allow - Access is allowed for all the countries except for those specified in
excepted_valuesfield. - deny - Access is denied for all the countries except for those specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Access is allowed for all the countries except for those specified in
- enabled Boolean
- Controls the option state.
- excepted
Values List<String> List of countries according to ISO-3166-1.
The meaning of the parameter depends on
policy_typevalue:- allow - List of countries for which access is prohibited.
- deny - List of countries for which access is allowed.
- policy
Type String Defines the type of CDN resource access policy.
Possible values:
- allow - Access is allowed for all the countries except for those specified in
excepted_valuesfield. - deny - Access is denied for all the countries except for those specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Access is allowed for all the countries except for those specified in
CdnResourceRuleOptionsDisableCache, CdnResourceRuleOptionsDisableCacheArgs
CdnResourceRuleOptionsDisableProxyForceRanges, CdnResourceRuleOptionsDisableProxyForceRangesArgs
CdnResourceRuleOptionsEdgeCacheSettings, CdnResourceRuleOptionsEdgeCacheSettingsArgs
- Enabled bool
- Controls the option state.
- Custom
Values Dictionary<string, string> A MAP object representing the caching time in seconds for a response with a specific response code.
These settings have a higher priority than the
valuefield.- Use
anykey to specify caching time for all response codes. - Use
0svalue to disable caching for a specific response code.
- Use
- Default string
Enables content caching according to the origin cache settings.
The value is applied to the following response codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308, if an origin server does not have caching HTTP headers.
Responses with other codes will not be cached.
The maximum duration is any equivalent to
1y.- Value string
Caching time.
The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.
Use
0sto disable caching.The maximum duration is any equivalent to
1y.
- Enabled bool
- Controls the option state.
- Custom
Values map[string]string A MAP object representing the caching time in seconds for a response with a specific response code.
These settings have a higher priority than the
valuefield.- Use
anykey to specify caching time for all response codes. - Use
0svalue to disable caching for a specific response code.
- Use
- Default string
Enables content caching according to the origin cache settings.
The value is applied to the following response codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308, if an origin server does not have caching HTTP headers.
Responses with other codes will not be cached.
The maximum duration is any equivalent to
1y.- Value string
Caching time.
The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.
Use
0sto disable caching.The maximum duration is any equivalent to
1y.
- enabled Boolean
- Controls the option state.
- custom
Values Map<String,String> A MAP object representing the caching time in seconds for a response with a specific response code.
These settings have a higher priority than the
valuefield.- Use
anykey to specify caching time for all response codes. - Use
0svalue to disable caching for a specific response code.
- Use
- default_ String
Enables content caching according to the origin cache settings.
The value is applied to the following response codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308, if an origin server does not have caching HTTP headers.
Responses with other codes will not be cached.
The maximum duration is any equivalent to
1y.- value String
Caching time.
The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.
Use
0sto disable caching.The maximum duration is any equivalent to
1y.
- enabled boolean
- Controls the option state.
- custom
Values {[key: string]: string} A MAP object representing the caching time in seconds for a response with a specific response code.
These settings have a higher priority than the
valuefield.- Use
anykey to specify caching time for all response codes. - Use
0svalue to disable caching for a specific response code.
- Use
- default string
Enables content caching according to the origin cache settings.
The value is applied to the following response codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308, if an origin server does not have caching HTTP headers.
Responses with other codes will not be cached.
The maximum duration is any equivalent to
1y.- value string
Caching time.
The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.
Use
0sto disable caching.The maximum duration is any equivalent to
1y.
- enabled bool
- Controls the option state.
- custom_
values Mapping[str, str] A MAP object representing the caching time in seconds for a response with a specific response code.
These settings have a higher priority than the
valuefield.- Use
anykey to specify caching time for all response codes. - Use
0svalue to disable caching for a specific response code.
- Use
- default str
Enables content caching according to the origin cache settings.
The value is applied to the following response codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308, if an origin server does not have caching HTTP headers.
Responses with other codes will not be cached.
The maximum duration is any equivalent to
1y.- value str
Caching time.
The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.
Use
0sto disable caching.The maximum duration is any equivalent to
1y.
- enabled Boolean
- Controls the option state.
- custom
Values Map<String> A MAP object representing the caching time in seconds for a response with a specific response code.
These settings have a higher priority than the
valuefield.- Use
anykey to specify caching time for all response codes. - Use
0svalue to disable caching for a specific response code.
- Use
- default String
Enables content caching according to the origin cache settings.
The value is applied to the following response codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308, if an origin server does not have caching HTTP headers.
Responses with other codes will not be cached.
The maximum duration is any equivalent to
1y.- value String
Caching time.
The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.
Use
0sto disable caching.The maximum duration is any equivalent to
1y.
CdnResourceRuleOptionsFastedge, CdnResourceRuleOptionsFastedgeArgs
- Enabled bool
- Controls the option state.
- On
Request CdnBody Resource Rule Options Fastedge On Request Body - Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
- On
Request CdnHeaders Resource Rule Options Fastedge On Request Headers - Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
- On
Response CdnBody Resource Rule Options Fastedge On Response Body - Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
- On
Response CdnHeaders Resource Rule Options Fastedge On Response Headers - Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
- Enabled bool
- Controls the option state.
- On
Request CdnBody Resource Rule Options Fastedge On Request Body - Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
- On
Request CdnHeaders Resource Rule Options Fastedge On Request Headers - Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
- On
Response CdnBody Resource Rule Options Fastedge On Response Body - Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
- On
Response CdnHeaders Resource Rule Options Fastedge On Response Headers - Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
- enabled Boolean
- Controls the option state.
- on
Request CdnBody Resource Rule Options Fastedge On Request Body - Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
- on
Request CdnHeaders Resource Rule Options Fastedge On Request Headers - Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
- on
Response CdnBody Resource Rule Options Fastedge On Response Body - Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
- on
Response CdnHeaders Resource Rule Options Fastedge On Response Headers - Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
- enabled boolean
- Controls the option state.
- on
Request CdnBody Resource Rule Options Fastedge On Request Body - Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
- on
Request CdnHeaders Resource Rule Options Fastedge On Request Headers - Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
- on
Response CdnBody Resource Rule Options Fastedge On Response Body - Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
- on
Response CdnHeaders Resource Rule Options Fastedge On Response Headers - Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
- enabled bool
- Controls the option state.
- on_
request_ Cdnbody Resource Rule Options Fastedge On Request Body - Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
- on_
request_ Cdnheaders Resource Rule Options Fastedge On Request Headers - Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
- on_
response_ Cdnbody Resource Rule Options Fastedge On Response Body - Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
- on_
response_ Cdnheaders Resource Rule Options Fastedge On Response Headers - Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
- enabled Boolean
- Controls the option state.
- on
Request Property MapBody - Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
- on
Request Property MapHeaders - Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
- on
Response Property MapBody - Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
- on
Response Property MapHeaders - Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
CdnResourceRuleOptionsFastedgeOnRequestBody, CdnResourceRuleOptionsFastedgeOnRequestBodyArgs
- App
Id string - The ID of the application in FastEdge.
- Enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- Execute
On boolEdge - Determines if the request should be executed at the edge nodes.
- Execute
On boolShield - Determines if the request should be executed at the shield nodes.
- Interrupt
On boolError - Determines if the request execution should be interrupted when an error occurs.
- App
Id string - The ID of the application in FastEdge.
- Enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- Execute
On boolEdge - Determines if the request should be executed at the edge nodes.
- Execute
On boolShield - Determines if the request should be executed at the shield nodes.
- Interrupt
On boolError - Determines if the request execution should be interrupted when an error occurs.
- app
Id String - The ID of the application in FastEdge.
- enabled Boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On BooleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On BooleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On BooleanError - Determines if the request execution should be interrupted when an error occurs.
- app
Id string - The ID of the application in FastEdge.
- enabled boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On booleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On booleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On booleanError - Determines if the request execution should be interrupted when an error occurs.
- app_
id str - The ID of the application in FastEdge.
- enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute_
on_ booledge - Determines if the request should be executed at the edge nodes.
- execute_
on_ boolshield - Determines if the request should be executed at the shield nodes.
- interrupt_
on_ boolerror - Determines if the request execution should be interrupted when an error occurs.
- app
Id String - The ID of the application in FastEdge.
- enabled Boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On BooleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On BooleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On BooleanError - Determines if the request execution should be interrupted when an error occurs.
CdnResourceRuleOptionsFastedgeOnRequestHeaders, CdnResourceRuleOptionsFastedgeOnRequestHeadersArgs
- App
Id string - The ID of the application in FastEdge.
- Enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- Execute
On boolEdge - Determines if the request should be executed at the edge nodes.
- Execute
On boolShield - Determines if the request should be executed at the shield nodes.
- Interrupt
On boolError - Determines if the request execution should be interrupted when an error occurs.
- App
Id string - The ID of the application in FastEdge.
- Enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- Execute
On boolEdge - Determines if the request should be executed at the edge nodes.
- Execute
On boolShield - Determines if the request should be executed at the shield nodes.
- Interrupt
On boolError - Determines if the request execution should be interrupted when an error occurs.
- app
Id String - The ID of the application in FastEdge.
- enabled Boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On BooleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On BooleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On BooleanError - Determines if the request execution should be interrupted when an error occurs.
- app
Id string - The ID of the application in FastEdge.
- enabled boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On booleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On booleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On booleanError - Determines if the request execution should be interrupted when an error occurs.
- app_
id str - The ID of the application in FastEdge.
- enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute_
on_ booledge - Determines if the request should be executed at the edge nodes.
- execute_
on_ boolshield - Determines if the request should be executed at the shield nodes.
- interrupt_
on_ boolerror - Determines if the request execution should be interrupted when an error occurs.
- app
Id String - The ID of the application in FastEdge.
- enabled Boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On BooleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On BooleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On BooleanError - Determines if the request execution should be interrupted when an error occurs.
CdnResourceRuleOptionsFastedgeOnResponseBody, CdnResourceRuleOptionsFastedgeOnResponseBodyArgs
- App
Id string - The ID of the application in FastEdge.
- Enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- Execute
On boolEdge - Determines if the request should be executed at the edge nodes.
- Execute
On boolShield - Determines if the request should be executed at the shield nodes.
- Interrupt
On boolError - Determines if the request execution should be interrupted when an error occurs.
- App
Id string - The ID of the application in FastEdge.
- Enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- Execute
On boolEdge - Determines if the request should be executed at the edge nodes.
- Execute
On boolShield - Determines if the request should be executed at the shield nodes.
- Interrupt
On boolError - Determines if the request execution should be interrupted when an error occurs.
- app
Id String - The ID of the application in FastEdge.
- enabled Boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On BooleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On BooleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On BooleanError - Determines if the request execution should be interrupted when an error occurs.
- app
Id string - The ID of the application in FastEdge.
- enabled boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On booleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On booleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On booleanError - Determines if the request execution should be interrupted when an error occurs.
- app_
id str - The ID of the application in FastEdge.
- enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute_
on_ booledge - Determines if the request should be executed at the edge nodes.
- execute_
on_ boolshield - Determines if the request should be executed at the shield nodes.
- interrupt_
on_ boolerror - Determines if the request execution should be interrupted when an error occurs.
- app
Id String - The ID of the application in FastEdge.
- enabled Boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On BooleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On BooleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On BooleanError - Determines if the request execution should be interrupted when an error occurs.
CdnResourceRuleOptionsFastedgeOnResponseHeaders, CdnResourceRuleOptionsFastedgeOnResponseHeadersArgs
- App
Id string - The ID of the application in FastEdge.
- Enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- Execute
On boolEdge - Determines if the request should be executed at the edge nodes.
- Execute
On boolShield - Determines if the request should be executed at the shield nodes.
- Interrupt
On boolError - Determines if the request execution should be interrupted when an error occurs.
- App
Id string - The ID of the application in FastEdge.
- Enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- Execute
On boolEdge - Determines if the request should be executed at the edge nodes.
- Execute
On boolShield - Determines if the request should be executed at the shield nodes.
- Interrupt
On boolError - Determines if the request execution should be interrupted when an error occurs.
- app
Id String - The ID of the application in FastEdge.
- enabled Boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On BooleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On BooleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On BooleanError - Determines if the request execution should be interrupted when an error occurs.
- app
Id string - The ID of the application in FastEdge.
- enabled boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On booleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On booleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On booleanError - Determines if the request execution should be interrupted when an error occurs.
- app_
id str - The ID of the application in FastEdge.
- enabled bool
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute_
on_ booledge - Determines if the request should be executed at the edge nodes.
- execute_
on_ boolshield - Determines if the request should be executed at the shield nodes.
- interrupt_
on_ boolerror - Determines if the request execution should be interrupted when an error occurs.
- app
Id String - The ID of the application in FastEdge.
- enabled Boolean
- Determines if the FastEdge application should be called whenever HTTP request headers are received.
- execute
On BooleanEdge - Determines if the request should be executed at the edge nodes.
- execute
On BooleanShield - Determines if the request should be executed at the shield nodes.
- interrupt
On BooleanError - Determines if the request execution should be interrupted when an error occurs.
CdnResourceRuleOptionsFetchCompressed, CdnResourceRuleOptionsFetchCompressedArgs
CdnResourceRuleOptionsFollowOriginRedirect, CdnResourceRuleOptionsFollowOriginRedirectArgs
CdnResourceRuleOptionsForceReturn, CdnResourceRuleOptionsForceReturnArgs
- Body string
- URL for redirection or text.
- Code double
- Status code value.
- Enabled bool
- Controls the option state.
- Time
Interval CdnResource Rule Options Force Return Time Interval - Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
- Body string
- URL for redirection or text.
- Code float64
- Status code value.
- Enabled bool
- Controls the option state.
- Time
Interval CdnResource Rule Options Force Return Time Interval - Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
- body String
- URL for redirection or text.
- code Double
- Status code value.
- enabled Boolean
- Controls the option state.
- time
Interval CdnResource Rule Options Force Return Time Interval - Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
- body string
- URL for redirection or text.
- code number
- Status code value.
- enabled boolean
- Controls the option state.
- time
Interval CdnResource Rule Options Force Return Time Interval - Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
- body str
- URL for redirection or text.
- code float
- Status code value.
- enabled bool
- Controls the option state.
- time_
interval CdnResource Rule Options Force Return Time Interval - Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
- body String
- URL for redirection or text.
- code Number
- Status code value.
- enabled Boolean
- Controls the option state.
- time
Interval Property Map - Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
CdnResourceRuleOptionsForceReturnTimeInterval, CdnResourceRuleOptionsForceReturnTimeIntervalArgs
- end_
time str - Time until which a custom HTTP response code should be applied. Indicated in 24-hour format.
- start_
time str - Time from which a custom HTTP response code should be applied. Indicated in 24-hour format.
- time_
zone str - Time zone used to calculate time.
CdnResourceRuleOptionsForwardHostHeader, CdnResourceRuleOptionsForwardHostHeaderArgs
CdnResourceRuleOptionsGzipOn, CdnResourceRuleOptionsGzipOnArgs
CdnResourceRuleOptionsHostHeader, CdnResourceRuleOptionsHostHeaderArgs
CdnResourceRuleOptionsIgnoreCookie, CdnResourceRuleOptionsIgnoreCookieArgs
CdnResourceRuleOptionsIgnoreQueryString, CdnResourceRuleOptionsIgnoreQueryStringArgs
CdnResourceRuleOptionsImageStack, CdnResourceRuleOptionsImageStackArgs
- Enabled bool
- Controls the option state.
- Avif
Enabled bool - Enables or disables automatic conversion of JPEG and PNG images to AVI format.
- Png
Lossless bool - Enables or disables compression without quality loss for PNG format.
- Quality double
- Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
- Webp
Enabled bool - Enables or disables automatic conversion of JPEG and PNG images to WebP format.
- Enabled bool
- Controls the option state.
- Avif
Enabled bool - Enables or disables automatic conversion of JPEG and PNG images to AVI format.
- Png
Lossless bool - Enables or disables compression without quality loss for PNG format.
- Quality float64
- Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
- Webp
Enabled bool - Enables or disables automatic conversion of JPEG and PNG images to WebP format.
- enabled Boolean
- Controls the option state.
- avif
Enabled Boolean - Enables or disables automatic conversion of JPEG and PNG images to AVI format.
- png
Lossless Boolean - Enables or disables compression without quality loss for PNG format.
- quality Double
- Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
- webp
Enabled Boolean - Enables or disables automatic conversion of JPEG and PNG images to WebP format.
- enabled boolean
- Controls the option state.
- avif
Enabled boolean - Enables or disables automatic conversion of JPEG and PNG images to AVI format.
- png
Lossless boolean - Enables or disables compression without quality loss for PNG format.
- quality number
- Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
- webp
Enabled boolean - Enables or disables automatic conversion of JPEG and PNG images to WebP format.
- enabled bool
- Controls the option state.
- avif_
enabled bool - Enables or disables automatic conversion of JPEG and PNG images to AVI format.
- png_
lossless bool - Enables or disables compression without quality loss for PNG format.
- quality float
- Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
- webp_
enabled bool - Enables or disables automatic conversion of JPEG and PNG images to WebP format.
- enabled Boolean
- Controls the option state.
- avif
Enabled Boolean - Enables or disables automatic conversion of JPEG and PNG images to AVI format.
- png
Lossless Boolean - Enables or disables compression without quality loss for PNG format.
- quality Number
- Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
- webp
Enabled Boolean - Enables or disables automatic conversion of JPEG and PNG images to WebP format.
CdnResourceRuleOptionsIpAddressAcl, CdnResourceRuleOptionsIpAddressAclArgs
- Enabled bool
- Controls the option state.
- Excepted
Values List<string> List of IP addresses with a subnet mask.
The meaning of the parameter depends on
policy_typevalue:- allow - List of IP addresses for which access is prohibited.
- deny - List of IP addresses for which access is allowed.
Examples:
192.168.3.2/322a03:d000:2980:7::8/128
- Policy
Type string IP access policy type.
Possible values:
- allow - Allow access to all IPs except IPs specified in "excepted_values" field.
- deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
- Enabled bool
- Controls the option state.
- Excepted
Values []string List of IP addresses with a subnet mask.
The meaning of the parameter depends on
policy_typevalue:- allow - List of IP addresses for which access is prohibited.
- deny - List of IP addresses for which access is allowed.
Examples:
192.168.3.2/322a03:d000:2980:7::8/128
- Policy
Type string IP access policy type.
Possible values:
- allow - Allow access to all IPs except IPs specified in "excepted_values" field.
- deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
- enabled Boolean
- Controls the option state.
- excepted
Values List<String> List of IP addresses with a subnet mask.
The meaning of the parameter depends on
policy_typevalue:- allow - List of IP addresses for which access is prohibited.
- deny - List of IP addresses for which access is allowed.
Examples:
192.168.3.2/322a03:d000:2980:7::8/128
- policy
Type String IP access policy type.
Possible values:
- allow - Allow access to all IPs except IPs specified in "excepted_values" field.
- deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
- enabled boolean
- Controls the option state.
- excepted
Values string[] List of IP addresses with a subnet mask.
The meaning of the parameter depends on
policy_typevalue:- allow - List of IP addresses for which access is prohibited.
- deny - List of IP addresses for which access is allowed.
Examples:
192.168.3.2/322a03:d000:2980:7::8/128
- policy
Type string IP access policy type.
Possible values:
- allow - Allow access to all IPs except IPs specified in "excepted_values" field.
- deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
- enabled bool
- Controls the option state.
- excepted_
values Sequence[str] List of IP addresses with a subnet mask.
The meaning of the parameter depends on
policy_typevalue:- allow - List of IP addresses for which access is prohibited.
- deny - List of IP addresses for which access is allowed.
Examples:
192.168.3.2/322a03:d000:2980:7::8/128
- policy_
type str IP access policy type.
Possible values:
- allow - Allow access to all IPs except IPs specified in "excepted_values" field.
- deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
- enabled Boolean
- Controls the option state.
- excepted
Values List<String> List of IP addresses with a subnet mask.
The meaning of the parameter depends on
policy_typevalue:- allow - List of IP addresses for which access is prohibited.
- deny - List of IP addresses for which access is allowed.
Examples:
192.168.3.2/322a03:d000:2980:7::8/128
- policy
Type String IP access policy type.
Possible values:
- allow - Allow access to all IPs except IPs specified in "excepted_values" field.
- deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
CdnResourceRuleOptionsLimitBandwidth, CdnResourceRuleOptionsLimitBandwidthArgs
- Enabled bool
- Controls the option state.
- Limit
Type string Method of controlling the download speed per connection.
Possible values:
- static - Use speed and buffer fields to set the download speed limit.
- dynamic - Use query strings speed and buffer to set the download speed limit.
For example, when requesting content at the link
http://cdn.example.com/video.mp4?speed=50k&buffer=500kthe download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".
- Buffer double
- Amount of downloaded data after which the user will be rate limited.
- Speed double
- Maximum download speed per connection.
- Enabled bool
- Controls the option state.
- Limit
Type string Method of controlling the download speed per connection.
Possible values:
- static - Use speed and buffer fields to set the download speed limit.
- dynamic - Use query strings speed and buffer to set the download speed limit.
For example, when requesting content at the link
http://cdn.example.com/video.mp4?speed=50k&buffer=500kthe download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".
- Buffer float64
- Amount of downloaded data after which the user will be rate limited.
- Speed float64
- Maximum download speed per connection.
- enabled Boolean
- Controls the option state.
- limit
Type String Method of controlling the download speed per connection.
Possible values:
- static - Use speed and buffer fields to set the download speed limit.
- dynamic - Use query strings speed and buffer to set the download speed limit.
For example, when requesting content at the link
http://cdn.example.com/video.mp4?speed=50k&buffer=500kthe download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".
- buffer Double
- Amount of downloaded data after which the user will be rate limited.
- speed Double
- Maximum download speed per connection.
- enabled boolean
- Controls the option state.
- limit
Type string Method of controlling the download speed per connection.
Possible values:
- static - Use speed and buffer fields to set the download speed limit.
- dynamic - Use query strings speed and buffer to set the download speed limit.
For example, when requesting content at the link
http://cdn.example.com/video.mp4?speed=50k&buffer=500kthe download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".
- buffer number
- Amount of downloaded data after which the user will be rate limited.
- speed number
- Maximum download speed per connection.
- enabled bool
- Controls the option state.
- limit_
type str Method of controlling the download speed per connection.
Possible values:
- static - Use speed and buffer fields to set the download speed limit.
- dynamic - Use query strings speed and buffer to set the download speed limit.
For example, when requesting content at the link
http://cdn.example.com/video.mp4?speed=50k&buffer=500kthe download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".
- buffer float
- Amount of downloaded data after which the user will be rate limited.
- speed float
- Maximum download speed per connection.
- enabled Boolean
- Controls the option state.
- limit
Type String Method of controlling the download speed per connection.
Possible values:
- static - Use speed and buffer fields to set the download speed limit.
- dynamic - Use query strings speed and buffer to set the download speed limit.
For example, when requesting content at the link
http://cdn.example.com/video.mp4?speed=50k&buffer=500kthe download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".
- buffer Number
- Amount of downloaded data after which the user will be rate limited.
- speed Number
- Maximum download speed per connection.
CdnResourceRuleOptionsProxyCacheKey, CdnResourceRuleOptionsProxyCacheKeyArgs
CdnResourceRuleOptionsProxyCacheMethodsSet, CdnResourceRuleOptionsProxyCacheMethodsSetArgs
CdnResourceRuleOptionsProxyConnectTimeout, CdnResourceRuleOptionsProxyConnectTimeoutArgs
CdnResourceRuleOptionsProxyReadTimeout, CdnResourceRuleOptionsProxyReadTimeoutArgs
CdnResourceRuleOptionsQueryParamsBlacklist, CdnResourceRuleOptionsQueryParamsBlacklistArgs
CdnResourceRuleOptionsQueryParamsWhitelist, CdnResourceRuleOptionsQueryParamsWhitelistArgs
CdnResourceRuleOptionsQueryStringForwarding, CdnResourceRuleOptionsQueryStringForwardingArgs
- Enabled bool
- Controls the option state.
- Forward
From List<string>File Types - The
forward_from_files_typesfield specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference. - Forward
To List<string>File Types - The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
- Forward
Except List<string>Keys - The
forward_except_keysfield provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance. - Forward
Only List<string>Keys - The
forward_only_keysfield allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
- Enabled bool
- Controls the option state.
- Forward
From []stringFile Types - The
forward_from_files_typesfield specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference. - Forward
To []stringFile Types - The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
- Forward
Except []stringKeys - The
forward_except_keysfield provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance. - Forward
Only []stringKeys - The
forward_only_keysfield allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
- enabled Boolean
- Controls the option state.
- forward
From List<String>File Types - The
forward_from_files_typesfield specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference. - forward
To List<String>File Types - The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
- forward
Except List<String>Keys - The
forward_except_keysfield provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance. - forward
Only List<String>Keys - The
forward_only_keysfield allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
- enabled boolean
- Controls the option state.
- forward
From string[]File Types - The
forward_from_files_typesfield specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference. - forward
To string[]File Types - The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
- forward
Except string[]Keys - The
forward_except_keysfield provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance. - forward
Only string[]Keys - The
forward_only_keysfield allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
- enabled bool
- Controls the option state.
- forward_
from_ Sequence[str]file_ types - The
forward_from_files_typesfield specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference. - forward_
to_ Sequence[str]file_ types - The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
- forward_
except_ Sequence[str]keys - The
forward_except_keysfield provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance. - forward_
only_ Sequence[str]keys - The
forward_only_keysfield allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
- enabled Boolean
- Controls the option state.
- forward
From List<String>File Types - The
forward_from_files_typesfield specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference. - forward
To List<String>File Types - The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
- forward
Except List<String>Keys - The
forward_except_keysfield provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance. - forward
Only List<String>Keys - The
forward_only_keysfield allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
CdnResourceRuleOptionsRedirectHttpToHttps, CdnResourceRuleOptionsRedirectHttpToHttpsArgs
CdnResourceRuleOptionsRedirectHttpsToHttp, CdnResourceRuleOptionsRedirectHttpsToHttpArgs
CdnResourceRuleOptionsReferrerAcl, CdnResourceRuleOptionsReferrerAclArgs
- Enabled bool
- Controls the option state.
- Excepted
Values List<string> List of domain names or wildcard domains (without protocol:
http://orhttps://.)The meaning of the parameter depends on
policy_typevalue:- allow - List of domain names for which access is prohibited.
- deny - List of IP domain names for which access is allowed.
Examples:
example.com*.example.com
- Policy
Type string Policy type.
Possible values:
- allow - Allow access to all domain names except the domain names specified in
excepted_valuesfield. - deny - Deny access to all domain names except the domain names specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access to all domain names except the domain names specified in
- Enabled bool
- Controls the option state.
- Excepted
Values []string List of domain names or wildcard domains (without protocol:
http://orhttps://.)The meaning of the parameter depends on
policy_typevalue:- allow - List of domain names for which access is prohibited.
- deny - List of IP domain names for which access is allowed.
Examples:
example.com*.example.com
- Policy
Type string Policy type.
Possible values:
- allow - Allow access to all domain names except the domain names specified in
excepted_valuesfield. - deny - Deny access to all domain names except the domain names specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access to all domain names except the domain names specified in
- enabled Boolean
- Controls the option state.
- excepted
Values List<String> List of domain names or wildcard domains (without protocol:
http://orhttps://.)The meaning of the parameter depends on
policy_typevalue:- allow - List of domain names for which access is prohibited.
- deny - List of IP domain names for which access is allowed.
Examples:
example.com*.example.com
- policy
Type String Policy type.
Possible values:
- allow - Allow access to all domain names except the domain names specified in
excepted_valuesfield. - deny - Deny access to all domain names except the domain names specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access to all domain names except the domain names specified in
- enabled boolean
- Controls the option state.
- excepted
Values string[] List of domain names or wildcard domains (without protocol:
http://orhttps://.)The meaning of the parameter depends on
policy_typevalue:- allow - List of domain names for which access is prohibited.
- deny - List of IP domain names for which access is allowed.
Examples:
example.com*.example.com
- policy
Type string Policy type.
Possible values:
- allow - Allow access to all domain names except the domain names specified in
excepted_valuesfield. - deny - Deny access to all domain names except the domain names specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access to all domain names except the domain names specified in
- enabled bool
- Controls the option state.
- excepted_
values Sequence[str] List of domain names or wildcard domains (without protocol:
http://orhttps://.)The meaning of the parameter depends on
policy_typevalue:- allow - List of domain names for which access is prohibited.
- deny - List of IP domain names for which access is allowed.
Examples:
example.com*.example.com
- policy_
type str Policy type.
Possible values:
- allow - Allow access to all domain names except the domain names specified in
excepted_valuesfield. - deny - Deny access to all domain names except the domain names specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access to all domain names except the domain names specified in
- enabled Boolean
- Controls the option state.
- excepted
Values List<String> List of domain names or wildcard domains (without protocol:
http://orhttps://.)The meaning of the parameter depends on
policy_typevalue:- allow - List of domain names for which access is prohibited.
- deny - List of IP domain names for which access is allowed.
Examples:
example.com*.example.com
- policy
Type String Policy type.
Possible values:
- allow - Allow access to all domain names except the domain names specified in
excepted_valuesfield. - deny - Deny access to all domain names except the domain names specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access to all domain names except the domain names specified in
CdnResourceRuleOptionsRequestLimiter, CdnResourceRuleOptionsRequestLimiterArgs
- Enabled bool
- Controls the option state.
- Rate double
- Maximum request rate.
- Burst double
- Delay double
- Rate
Unit string Units of measurement for the
ratefield.Possible values:
- r/s - Requests per second.
- r/m - Requests per minute.
If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".
- Enabled bool
- Controls the option state.
- Rate float64
- Maximum request rate.
- Burst float64
- Delay float64
- Rate
Unit string Units of measurement for the
ratefield.Possible values:
- r/s - Requests per second.
- r/m - Requests per minute.
If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".
- enabled Boolean
- Controls the option state.
- rate Double
- Maximum request rate.
- burst Double
- delay Double
- rate
Unit String Units of measurement for the
ratefield.Possible values:
- r/s - Requests per second.
- r/m - Requests per minute.
If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".
- enabled boolean
- Controls the option state.
- rate number
- Maximum request rate.
- burst number
- delay number
- rate
Unit string Units of measurement for the
ratefield.Possible values:
- r/s - Requests per second.
- r/m - Requests per minute.
If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".
- enabled bool
- Controls the option state.
- rate float
- Maximum request rate.
- burst float
- delay float
- rate_
unit str Units of measurement for the
ratefield.Possible values:
- r/s - Requests per second.
- r/m - Requests per minute.
If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".
- enabled Boolean
- Controls the option state.
- rate Number
- Maximum request rate.
- burst Number
- delay Number
- rate
Unit String Units of measurement for the
ratefield.Possible values:
- r/s - Requests per second.
- r/m - Requests per minute.
If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".
CdnResourceRuleOptionsResponseHeadersHidingPolicy, CdnResourceRuleOptionsResponseHeadersHidingPolicyArgs
- Enabled bool
- Controls the option state.
- Mode string
How HTTP headers are hidden from the response.
Possible values:
- show - Hide only HTTP headers listed in the
exceptedfield. - hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
- show - Hide only HTTP headers listed in the
- Excepteds List<string>
List of HTTP headers.
Parameter meaning depends on the value of the
modefield:- show - List of HTTP headers to hide from response.
- hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.
The following headers are required and cannot be hidden from response:
ConnectionContent-LengthContent-TypeDateServer
- Enabled bool
- Controls the option state.
- Mode string
How HTTP headers are hidden from the response.
Possible values:
- show - Hide only HTTP headers listed in the
exceptedfield. - hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
- show - Hide only HTTP headers listed in the
- Excepteds []string
List of HTTP headers.
Parameter meaning depends on the value of the
modefield:- show - List of HTTP headers to hide from response.
- hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.
The following headers are required and cannot be hidden from response:
ConnectionContent-LengthContent-TypeDateServer
- enabled Boolean
- Controls the option state.
- mode String
How HTTP headers are hidden from the response.
Possible values:
- show - Hide only HTTP headers listed in the
exceptedfield. - hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
- show - Hide only HTTP headers listed in the
- excepteds List<String>
List of HTTP headers.
Parameter meaning depends on the value of the
modefield:- show - List of HTTP headers to hide from response.
- hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.
The following headers are required and cannot be hidden from response:
ConnectionContent-LengthContent-TypeDateServer
- enabled boolean
- Controls the option state.
- mode string
How HTTP headers are hidden from the response.
Possible values:
- show - Hide only HTTP headers listed in the
exceptedfield. - hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
- show - Hide only HTTP headers listed in the
- excepteds string[]
List of HTTP headers.
Parameter meaning depends on the value of the
modefield:- show - List of HTTP headers to hide from response.
- hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.
The following headers are required and cannot be hidden from response:
ConnectionContent-LengthContent-TypeDateServer
- enabled bool
- Controls the option state.
- mode str
How HTTP headers are hidden from the response.
Possible values:
- show - Hide only HTTP headers listed in the
exceptedfield. - hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
- show - Hide only HTTP headers listed in the
- excepteds Sequence[str]
List of HTTP headers.
Parameter meaning depends on the value of the
modefield:- show - List of HTTP headers to hide from response.
- hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.
The following headers are required and cannot be hidden from response:
ConnectionContent-LengthContent-TypeDateServer
- enabled Boolean
- Controls the option state.
- mode String
How HTTP headers are hidden from the response.
Possible values:
- show - Hide only HTTP headers listed in the
exceptedfield. - hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
- show - Hide only HTTP headers listed in the
- excepteds List<String>
List of HTTP headers.
Parameter meaning depends on the value of the
modefield:- show - List of HTTP headers to hide from response.
- hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.
The following headers are required and cannot be hidden from response:
ConnectionContent-LengthContent-TypeDateServer
CdnResourceRuleOptionsRewrite, CdnResourceRuleOptionsRewriteArgs
- Body string
- Path for the Rewrite option.
- Enabled bool
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- Flag string
Flag for the Rewrite option.
Possible values:
- last - Stop processing the current set of
ngx_http_rewrite_moduledirectives and start a search for a new location matching changed URI. - break - Stop processing the current set of the Rewrite option.
- redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with
http://,https://, or$scheme. - permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
- last - Stop processing the current set of
- Body string
- Path for the Rewrite option.
- Enabled bool
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- Flag string
Flag for the Rewrite option.
Possible values:
- last - Stop processing the current set of
ngx_http_rewrite_moduledirectives and start a search for a new location matching changed URI. - break - Stop processing the current set of the Rewrite option.
- redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with
http://,https://, or$scheme. - permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
- last - Stop processing the current set of
- body String
- Path for the Rewrite option.
- enabled Boolean
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- flag String
Flag for the Rewrite option.
Possible values:
- last - Stop processing the current set of
ngx_http_rewrite_moduledirectives and start a search for a new location matching changed URI. - break - Stop processing the current set of the Rewrite option.
- redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with
http://,https://, or$scheme. - permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
- last - Stop processing the current set of
- body string
- Path for the Rewrite option.
- enabled boolean
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- flag string
Flag for the Rewrite option.
Possible values:
- last - Stop processing the current set of
ngx_http_rewrite_moduledirectives and start a search for a new location matching changed URI. - break - Stop processing the current set of the Rewrite option.
- redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with
http://,https://, or$scheme. - permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
- last - Stop processing the current set of
- body str
- Path for the Rewrite option.
- enabled bool
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- flag str
Flag for the Rewrite option.
Possible values:
- last - Stop processing the current set of
ngx_http_rewrite_moduledirectives and start a search for a new location matching changed URI. - break - Stop processing the current set of the Rewrite option.
- redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with
http://,https://, or$scheme. - permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
- last - Stop processing the current set of
- body String
- Path for the Rewrite option.
- enabled Boolean
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- flag String
Flag for the Rewrite option.
Possible values:
- last - Stop processing the current set of
ngx_http_rewrite_moduledirectives and start a search for a new location matching changed URI. - break - Stop processing the current set of the Rewrite option.
- redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with
http://,https://, or$scheme. - permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
- last - Stop processing the current set of
CdnResourceRuleOptionsSecureKey, CdnResourceRuleOptionsSecureKeyArgs
CdnResourceRuleOptionsSlice, CdnResourceRuleOptionsSliceArgs
CdnResourceRuleOptionsSni, CdnResourceRuleOptionsSniArgs
- Custom
Hostname string - Custom SNI hostname.
- Enabled bool
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- Sni
Type string SNI (Server Name Indication) type.
Possible values:
- dynamic - SNI hostname depends on
hostHeaderandforward_host_headeroptions. It has several possible combinations: - If the
hostHeaderoption is enabled and specified, SNI hostname matches the Host header. - If the
forward_host_headeroption is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN. - If the
hostHeaderandforward_host_headeroptions are disabled, SNI hostname matches the primary CNAME. - custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
- dynamic - SNI hostname depends on
- Custom
Hostname string - Custom SNI hostname.
- Enabled bool
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- Sni
Type string SNI (Server Name Indication) type.
Possible values:
- dynamic - SNI hostname depends on
hostHeaderandforward_host_headeroptions. It has several possible combinations: - If the
hostHeaderoption is enabled and specified, SNI hostname matches the Host header. - If the
forward_host_headeroption is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN. - If the
hostHeaderandforward_host_headeroptions are disabled, SNI hostname matches the primary CNAME. - custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
- dynamic - SNI hostname depends on
- custom
Hostname String - Custom SNI hostname.
- enabled Boolean
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- sni
Type String SNI (Server Name Indication) type.
Possible values:
- dynamic - SNI hostname depends on
hostHeaderandforward_host_headeroptions. It has several possible combinations: - If the
hostHeaderoption is enabled and specified, SNI hostname matches the Host header. - If the
forward_host_headeroption is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN. - If the
hostHeaderandforward_host_headeroptions are disabled, SNI hostname matches the primary CNAME. - custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
- dynamic - SNI hostname depends on
- custom
Hostname string - Custom SNI hostname.
- enabled boolean
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- sni
Type string SNI (Server Name Indication) type.
Possible values:
- dynamic - SNI hostname depends on
hostHeaderandforward_host_headeroptions. It has several possible combinations: - If the
hostHeaderoption is enabled and specified, SNI hostname matches the Host header. - If the
forward_host_headeroption is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN. - If the
hostHeaderandforward_host_headeroptions are disabled, SNI hostname matches the primary CNAME. - custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
- dynamic - SNI hostname depends on
- custom_
hostname str - Custom SNI hostname.
- enabled bool
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- sni_
type str SNI (Server Name Indication) type.
Possible values:
- dynamic - SNI hostname depends on
hostHeaderandforward_host_headeroptions. It has several possible combinations: - If the
hostHeaderoption is enabled and specified, SNI hostname matches the Host header. - If the
forward_host_headeroption is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN. - If the
hostHeaderandforward_host_headeroptions are disabled, SNI hostname matches the primary CNAME. - custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
- dynamic - SNI hostname depends on
- custom
Hostname String - Custom SNI hostname.
- enabled Boolean
Controls the option state.
Possible values:
- true - Option is enabled.
- false - Option is disabled.
- sni
Type String SNI (Server Name Indication) type.
Possible values:
- dynamic - SNI hostname depends on
hostHeaderandforward_host_headeroptions. It has several possible combinations: - If the
hostHeaderoption is enabled and specified, SNI hostname matches the Host header. - If the
forward_host_headeroption is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN. - If the
hostHeaderandforward_host_headeroptions are disabled, SNI hostname matches the primary CNAME. - custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
- dynamic - SNI hostname depends on
CdnResourceRuleOptionsStale, CdnResourceRuleOptionsStaleArgs
CdnResourceRuleOptionsStaticHeaders, CdnResourceRuleOptionsStaticHeadersArgs
- Enabled bool
- Controls the option state.
- Value string
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
- Enabled bool
- Controls the option state.
- Value string
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
- enabled Boolean
- Controls the option state.
- value String
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
- enabled boolean
- Controls the option state.
- value string
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
- enabled bool
- Controls the option state.
- value str
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
- enabled Boolean
- Controls the option state.
- value String
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
CdnResourceRuleOptionsStaticRequestHeaders, CdnResourceRuleOptionsStaticRequestHeadersArgs
- Enabled bool
- Controls the option state.
- Value Dictionary<string, string>
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
- Enabled bool
- Controls the option state.
- Value map[string]string
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
- enabled Boolean
- Controls the option state.
- value Map<String,String>
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
- enabled boolean
- Controls the option state.
- value {[key: string]: string}
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
- enabled bool
- Controls the option state.
- value Mapping[str, str]
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
- enabled Boolean
- Controls the option state.
- value Map<String>
A MAP for static headers in a format of
header_name: header_value.Restrictions:
- Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
- Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
CdnResourceRuleOptionsStaticResponseHeaders, CdnResourceRuleOptionsStaticResponseHeadersArgs
- Enabled bool
- Controls the option state.
- Values
List<Cdn
Resource Rule Options Static Response Headers Value>
- Enabled bool
- Controls the option state.
- Values
[]Cdn
Resource Rule Options Static Response Headers Value
- enabled Boolean
- Controls the option state.
- values
List<Cdn
Resource Rule Options Static Response Headers Value>
- enabled boolean
- Controls the option state.
- values
Cdn
Resource Rule Options Static Response Headers Value[]
- enabled bool
- Controls the option state.
- values
Sequence[Cdn
Resource Rule Options Static Response Headers Value]
- enabled Boolean
- Controls the option state.
- values List<Property Map>
CdnResourceRuleOptionsStaticResponseHeadersValue, CdnResourceRuleOptionsStaticResponseHeadersValueArgs
- Name string
- HTTP Header name.
- Values List<string>
Header value.
Restrictions:
- Maximum 512 symbols.
- Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
- Must start with a letter, number, asterisk or {.
- Multiple values can be added.
- Always bool
Defines whether the header will be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response from CDN regardless of response code.
- false - Header will be added only to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
- Name string
- HTTP Header name.
- Values []string
Header value.
Restrictions:
- Maximum 512 symbols.
- Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
- Must start with a letter, number, asterisk or {.
- Multiple values can be added.
- Always bool
Defines whether the header will be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response from CDN regardless of response code.
- false - Header will be added only to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
- name String
- HTTP Header name.
- values List<String>
Header value.
Restrictions:
- Maximum 512 symbols.
- Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
- Must start with a letter, number, asterisk or {.
- Multiple values can be added.
- always Boolean
Defines whether the header will be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response from CDN regardless of response code.
- false - Header will be added only to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
- name string
- HTTP Header name.
- values string[]
Header value.
Restrictions:
- Maximum 512 symbols.
- Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
- Must start with a letter, number, asterisk or {.
- Multiple values can be added.
- always boolean
Defines whether the header will be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response from CDN regardless of response code.
- false - Header will be added only to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
- name str
- HTTP Header name.
- values Sequence[str]
Header value.
Restrictions:
- Maximum 512 symbols.
- Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
- Must start with a letter, number, asterisk or {.
- Multiple values can be added.
- always bool
Defines whether the header will be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response from CDN regardless of response code.
- false - Header will be added only to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
- name String
- HTTP Header name.
- values List<String>
Header value.
Restrictions:
- Maximum 512 symbols.
- Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
- Must start with a letter, number, asterisk or {.
- Multiple values can be added.
- always Boolean
Defines whether the header will be added to a response from CDN regardless of response code.
Possible values:
- true - Header will be added to a response from CDN regardless of response code.
- false - Header will be added only to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.
CdnResourceRuleOptionsUserAgentAcl, CdnResourceRuleOptionsUserAgentAclArgs
- Enabled bool
- Controls the option state.
- Excepted
Values List<string> List of User-Agents that will be allowed/denied.
The meaning of the parameter depends on
policy_type:- allow - List of User-Agents for which access is prohibited.
- deny - List of User-Agents for which access is allowed.
You can provide exact User-Agent strings or regular expressions. Regular expressions must start with
~(case-sensitive) or~*(case-insensitive).Use an empty string
""to allow/deny access when the User-Agent header is empty.- Policy
Type string User-Agents policy type.
Possible values:
- allow - Allow access for all User-Agents except specified in
excepted_valuesfield. - deny - Deny access for all User-Agents except specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access for all User-Agents except specified in
- Enabled bool
- Controls the option state.
- Excepted
Values []string List of User-Agents that will be allowed/denied.
The meaning of the parameter depends on
policy_type:- allow - List of User-Agents for which access is prohibited.
- deny - List of User-Agents for which access is allowed.
You can provide exact User-Agent strings or regular expressions. Regular expressions must start with
~(case-sensitive) or~*(case-insensitive).Use an empty string
""to allow/deny access when the User-Agent header is empty.- Policy
Type string User-Agents policy type.
Possible values:
- allow - Allow access for all User-Agents except specified in
excepted_valuesfield. - deny - Deny access for all User-Agents except specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access for all User-Agents except specified in
- enabled Boolean
- Controls the option state.
- excepted
Values List<String> List of User-Agents that will be allowed/denied.
The meaning of the parameter depends on
policy_type:- allow - List of User-Agents for which access is prohibited.
- deny - List of User-Agents for which access is allowed.
You can provide exact User-Agent strings or regular expressions. Regular expressions must start with
~(case-sensitive) or~*(case-insensitive).Use an empty string
""to allow/deny access when the User-Agent header is empty.- policy
Type String User-Agents policy type.
Possible values:
- allow - Allow access for all User-Agents except specified in
excepted_valuesfield. - deny - Deny access for all User-Agents except specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access for all User-Agents except specified in
- enabled boolean
- Controls the option state.
- excepted
Values string[] List of User-Agents that will be allowed/denied.
The meaning of the parameter depends on
policy_type:- allow - List of User-Agents for which access is prohibited.
- deny - List of User-Agents for which access is allowed.
You can provide exact User-Agent strings or regular expressions. Regular expressions must start with
~(case-sensitive) or~*(case-insensitive).Use an empty string
""to allow/deny access when the User-Agent header is empty.- policy
Type string User-Agents policy type.
Possible values:
- allow - Allow access for all User-Agents except specified in
excepted_valuesfield. - deny - Deny access for all User-Agents except specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access for all User-Agents except specified in
- enabled bool
- Controls the option state.
- excepted_
values Sequence[str] List of User-Agents that will be allowed/denied.
The meaning of the parameter depends on
policy_type:- allow - List of User-Agents for which access is prohibited.
- deny - List of User-Agents for which access is allowed.
You can provide exact User-Agent strings or regular expressions. Regular expressions must start with
~(case-sensitive) or~*(case-insensitive).Use an empty string
""to allow/deny access when the User-Agent header is empty.- policy_
type str User-Agents policy type.
Possible values:
- allow - Allow access for all User-Agents except specified in
excepted_valuesfield. - deny - Deny access for all User-Agents except specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access for all User-Agents except specified in
- enabled Boolean
- Controls the option state.
- excepted
Values List<String> List of User-Agents that will be allowed/denied.
The meaning of the parameter depends on
policy_type:- allow - List of User-Agents for which access is prohibited.
- deny - List of User-Agents for which access is allowed.
You can provide exact User-Agent strings or regular expressions. Regular expressions must start with
~(case-sensitive) or~*(case-insensitive).Use an empty string
""to allow/deny access when the User-Agent header is empty.- policy
Type String User-Agents policy type.
Possible values:
- allow - Allow access for all User-Agents except specified in
excepted_valuesfield. - deny - Deny access for all User-Agents except specified in
excepted_valuesfield. Available values: "allow", "deny".
- allow - Allow access for all User-Agents except specified in
CdnResourceRuleOptionsWaap, CdnResourceRuleOptionsWaapArgs
CdnResourceRuleOptionsWebsockets, CdnResourceRuleOptionsWebsocketsArgs
Import
$ pulumi import gcore:index/cdnResourceRule:CdnResourceRule example '<resource_id>/<rule_id>'
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- gcore g-core/terraform-provider-gcore
- License
- Notes
- This Pulumi package is based on the
gcoreTerraform Provider.
published on Monday, Mar 30, 2026 by g-core
