volcenginecc.cdn.ShareConfig

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Global configuration extends domain configuration capabilities with the following advantages: increases the capacity of denylist and allowlist. For example, an IP denylist can contain up to 30,000 entries. Improves domain configuration efficiency. A single global configuration can be associated with multiple domains. Provides a common list type that can be used in additional domain configurations. Modifications to a global configuration are immediately applied to all associated domains.

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  cDNShareConfigDemo:
    type: volcenginecc:cdn:ShareConfig
    name: CDNShareConfigDemo
    properties:
      configName: CDNShareConfigDemo
      configType: allow_referer_access_rule
      project: default
      allowRefererAccessRule:
        allow_empty: true
        common_type:
          ignoreCase: true
          rules:
            - 139.x.x.1
            - 139.x.x.2

Create ShareConfig Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ShareConfig(name: string, args?: ShareConfigArgs, opts?: CustomResourceOptions);

@overload
def ShareConfig(resource_name: str,
                args: Optional[ShareConfigArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def ShareConfig(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                allow_ip_access_rule: Optional[ShareConfigAllowIpAccessRuleArgs] = None,
                allow_referer_access_rule: Optional[ShareConfigAllowRefererAccessRuleArgs] = None,
                common_match_list: Optional[ShareConfigCommonMatchListArgs] = None,
                config_name: Optional[str] = None,
                config_type: Optional[str] = None,
                deny_ip_access_rule: Optional[ShareConfigDenyIpAccessRuleArgs] = None,
                deny_referer_access_rule: Optional[ShareConfigDenyRefererAccessRuleArgs] = None,
                project: Optional[str] = None)

func NewShareConfig(ctx *Context, name string, args *ShareConfigArgs, opts ...ResourceOption) (*ShareConfig, error)

public ShareConfig(string name, ShareConfigArgs? args = null, CustomResourceOptions? opts = null)

public ShareConfig(String name, ShareConfigArgs args)
public ShareConfig(String name, ShareConfigArgs args, CustomResourceOptions options)

type: volcenginecc:cdn:ShareConfig
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 ShareConfigArgs: 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 ShareConfigArgs: 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 ShareConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ShareConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ShareConfigArgs: 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 shareConfigResource = new Volcenginecc.Cdn.ShareConfig("shareConfigResource", new()
{
    AllowIpAccessRule = new Volcenginecc.Cdn.Inputs.ShareConfigAllowIpAccessRuleArgs
    {
        Rules = new[]
        {
            "string",
        },
    },
    AllowRefererAccessRule = new Volcenginecc.Cdn.Inputs.ShareConfigAllowRefererAccessRuleArgs
    {
        AllowEmpty = false,
        CommonType = new Volcenginecc.Cdn.Inputs.ShareConfigAllowRefererAccessRuleCommonTypeArgs
        {
            IgnoreCase = false,
            Rules = new[]
            {
                "string",
            },
        },
    },
    CommonMatchList = new Volcenginecc.Cdn.Inputs.ShareConfigCommonMatchListArgs
    {
        CommonType = new Volcenginecc.Cdn.Inputs.ShareConfigCommonMatchListCommonTypeArgs
        {
            IgnoreCase = false,
            Rules = new[]
            {
                "string",
            },
        },
    },
    ConfigName = "string",
    ConfigType = "string",
    DenyIpAccessRule = new Volcenginecc.Cdn.Inputs.ShareConfigDenyIpAccessRuleArgs
    {
        Rules = new[]
        {
            "string",
        },
    },
    DenyRefererAccessRule = new Volcenginecc.Cdn.Inputs.ShareConfigDenyRefererAccessRuleArgs
    {
        AllowEmpty = false,
        CommonType = new Volcenginecc.Cdn.Inputs.ShareConfigDenyRefererAccessRuleCommonTypeArgs
        {
            IgnoreCase = false,
            Rules = new[]
            {
                "string",
            },
        },
    },
    Project = "string",
});

example, err := cdn.NewShareConfig(ctx, "shareConfigResource", &cdn.ShareConfigArgs{
	AllowIpAccessRule: &cdn.ShareConfigAllowIpAccessRuleArgs{
		Rules: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	AllowRefererAccessRule: &cdn.ShareConfigAllowRefererAccessRuleArgs{
		AllowEmpty: pulumi.Bool(false),
		CommonType: &cdn.ShareConfigAllowRefererAccessRuleCommonTypeArgs{
			IgnoreCase: pulumi.Bool(false),
			Rules: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	CommonMatchList: &cdn.ShareConfigCommonMatchListArgs{
		CommonType: &cdn.ShareConfigCommonMatchListCommonTypeArgs{
			IgnoreCase: pulumi.Bool(false),
			Rules: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	ConfigName: pulumi.String("string"),
	ConfigType: pulumi.String("string"),
	DenyIpAccessRule: &cdn.ShareConfigDenyIpAccessRuleArgs{
		Rules: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	DenyRefererAccessRule: &cdn.ShareConfigDenyRefererAccessRuleArgs{
		AllowEmpty: pulumi.Bool(false),
		CommonType: &cdn.ShareConfigDenyRefererAccessRuleCommonTypeArgs{
			IgnoreCase: pulumi.Bool(false),
			Rules: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Project: pulumi.String("string"),
})

var shareConfigResource = new ShareConfig("shareConfigResource", ShareConfigArgs.builder()
    .allowIpAccessRule(ShareConfigAllowIpAccessRuleArgs.builder()
        .rules("string")
        .build())
    .allowRefererAccessRule(ShareConfigAllowRefererAccessRuleArgs.builder()
        .allowEmpty(false)
        .commonType(ShareConfigAllowRefererAccessRuleCommonTypeArgs.builder()
            .ignoreCase(false)
            .rules("string")
            .build())
        .build())
    .commonMatchList(ShareConfigCommonMatchListArgs.builder()
        .commonType(ShareConfigCommonMatchListCommonTypeArgs.builder()
            .ignoreCase(false)
            .rules("string")
            .build())
        .build())
    .configName("string")
    .configType("string")
    .denyIpAccessRule(ShareConfigDenyIpAccessRuleArgs.builder()
        .rules("string")
        .build())
    .denyRefererAccessRule(ShareConfigDenyRefererAccessRuleArgs.builder()
        .allowEmpty(false)
        .commonType(ShareConfigDenyRefererAccessRuleCommonTypeArgs.builder()
            .ignoreCase(false)
            .rules("string")
            .build())
        .build())
    .project("string")
    .build());

share_config_resource = volcenginecc.cdn.ShareConfig("shareConfigResource",
    allow_ip_access_rule={
        "rules": ["string"],
    },
    allow_referer_access_rule={
        "allow_empty": False,
        "common_type": {
            "ignore_case": False,
            "rules": ["string"],
        },
    },
    common_match_list={
        "common_type": {
            "ignore_case": False,
            "rules": ["string"],
        },
    },
    config_name="string",
    config_type="string",
    deny_ip_access_rule={
        "rules": ["string"],
    },
    deny_referer_access_rule={
        "allow_empty": False,
        "common_type": {
            "ignore_case": False,
            "rules": ["string"],
        },
    },
    project="string")

const shareConfigResource = new volcenginecc.cdn.ShareConfig("shareConfigResource", {
    allowIpAccessRule: {
        rules: ["string"],
    },
    allowRefererAccessRule: {
        allowEmpty: false,
        commonType: {
            ignoreCase: false,
            rules: ["string"],
        },
    },
    commonMatchList: {
        commonType: {
            ignoreCase: false,
            rules: ["string"],
        },
    },
    configName: "string",
    configType: "string",
    denyIpAccessRule: {
        rules: ["string"],
    },
    denyRefererAccessRule: {
        allowEmpty: false,
        commonType: {
            ignoreCase: false,
            rules: ["string"],
        },
    },
    project: "string",
});

type: volcenginecc:cdn:ShareConfig
properties:
    allowIpAccessRule:
        rules:
            - string
    allowRefererAccessRule:
        allowEmpty: false
        commonType:
            ignoreCase: false
            rules:
                - string
    commonMatchList:
        commonType:
            ignoreCase: false
            rules:
                - string
    configName: string
    configType: string
    denyIpAccessRule:
        rules:
            - string
    denyRefererAccessRule:
        allowEmpty: false
        commonType:
            ignoreCase: false
            rules:
                - string
    project: string

ShareConfig 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 ShareConfig resource accepts the following input properties:

AllowIpAccessRule Volcengine.ShareConfigAllowIpAccessRule: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
AllowRefererAccessRule Volcengine.ShareConfigAllowRefererAccessRule: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
CommonMatchList Volcengine.ShareConfigCommonMatchList: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
ConfigName string: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
ConfigType string: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
DenyIpAccessRule Volcengine.ShareConfigDenyIpAccessRule: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
DenyRefererAccessRule Volcengine.ShareConfigDenyRefererAccessRule: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
Project string: Specifies the project name to which the global configuration belongs.

AllowIpAccessRule ShareConfigAllowIpAccessRuleArgs: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
AllowRefererAccessRule ShareConfigAllowRefererAccessRuleArgs: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
CommonMatchList ShareConfigCommonMatchListArgs: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
ConfigName string: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
ConfigType string: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
DenyIpAccessRule ShareConfigDenyIpAccessRuleArgs: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
DenyRefererAccessRule ShareConfigDenyRefererAccessRuleArgs: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
Project string: Specifies the project name to which the global configuration belongs.

allowIpAccessRule ShareConfigAllowIpAccessRule: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
allowRefererAccessRule ShareConfigAllowRefererAccessRule: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
commonMatchList ShareConfigCommonMatchList: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
configName String: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
configType String: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
denyIpAccessRule ShareConfigDenyIpAccessRule: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
denyRefererAccessRule ShareConfigDenyRefererAccessRule: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
project String: Specifies the project name to which the global configuration belongs.

allowIpAccessRule ShareConfigAllowIpAccessRule: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
allowRefererAccessRule ShareConfigAllowRefererAccessRule: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
commonMatchList ShareConfigCommonMatchList: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
configName string: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
configType string: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
denyIpAccessRule ShareConfigDenyIpAccessRule: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
denyRefererAccessRule ShareConfigDenyRefererAccessRule: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
project string: Specifies the project name to which the global configuration belongs.

allow_ip_access_rule ShareConfigAllowIpAccessRuleArgs: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
allow_referer_access_rule ShareConfigAllowRefererAccessRuleArgs: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
common_match_list ShareConfigCommonMatchListArgs: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
config_name str: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
config_type str: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
deny_ip_access_rule ShareConfigDenyIpAccessRuleArgs: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
deny_referer_access_rule ShareConfigDenyRefererAccessRuleArgs: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
project str: Specifies the project name to which the global configuration belongs.

allowIpAccessRule Property Map: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
allowRefererAccessRule Property Map: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
commonMatchList Property Map: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
configName String: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
configType String: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
denyIpAccessRule Property Map: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
denyRefererAccessRule Property Map: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
project String: Specifies the project name to which the global configuration belongs.

Outputs

All input properties are implicitly available as output properties. Additionally, the ShareConfig resource produces the following output properties:

DomainCount int: Indicates the number of accelerated domains associated with this global configuration.
Id string: The provider-assigned unique ID for this managed resource.
RuleContent string: Specifies the HTML code for the custom error page.
UpdatedTime int: Indicates the last modification time of this global configuration, in Unix timestamp.

DomainCount int: Indicates the number of accelerated domains associated with this global configuration.
Id string: The provider-assigned unique ID for this managed resource.
RuleContent string: Specifies the HTML code for the custom error page.
UpdatedTime int: Indicates the last modification time of this global configuration, in Unix timestamp.

domainCount Integer: Indicates the number of accelerated domains associated with this global configuration.
id String: The provider-assigned unique ID for this managed resource.
ruleContent String: Specifies the HTML code for the custom error page.
updatedTime Integer: Indicates the last modification time of this global configuration, in Unix timestamp.

domainCount number: Indicates the number of accelerated domains associated with this global configuration.
id string: The provider-assigned unique ID for this managed resource.
ruleContent string: Specifies the HTML code for the custom error page.
updatedTime number: Indicates the last modification time of this global configuration, in Unix timestamp.

domain_count int: Indicates the number of accelerated domains associated with this global configuration.
id str: The provider-assigned unique ID for this managed resource.
rule_content str: Specifies the HTML code for the custom error page.
updated_time int: Indicates the last modification time of this global configuration, in Unix timestamp.

domainCount Number: Indicates the number of accelerated domains associated with this global configuration.
id String: The provider-assigned unique ID for this managed resource.
ruleContent String: Specifies the HTML code for the custom error page.
updatedTime Number: Indicates the last modification time of this global configuration, in Unix timestamp.

Look up Existing ShareConfig Resource

Get an existing ShareConfig 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?: ShareConfigState, opts?: CustomResourceOptions): ShareConfig

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_ip_access_rule: Optional[ShareConfigAllowIpAccessRuleArgs] = None,
        allow_referer_access_rule: Optional[ShareConfigAllowRefererAccessRuleArgs] = None,
        common_match_list: Optional[ShareConfigCommonMatchListArgs] = None,
        config_name: Optional[str] = None,
        config_type: Optional[str] = None,
        deny_ip_access_rule: Optional[ShareConfigDenyIpAccessRuleArgs] = None,
        deny_referer_access_rule: Optional[ShareConfigDenyRefererAccessRuleArgs] = None,
        domain_count: Optional[int] = None,
        project: Optional[str] = None,
        rule_content: Optional[str] = None,
        updated_time: Optional[int] = None) -> ShareConfig

func GetShareConfig(ctx *Context, name string, id IDInput, state *ShareConfigState, opts ...ResourceOption) (*ShareConfig, error)

public static ShareConfig Get(string name, Input<string> id, ShareConfigState? state, CustomResourceOptions? opts = null)

public static ShareConfig get(String name, Output<String> id, ShareConfigState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:cdn:ShareConfig    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.

The following state arguments are supported:

AllowIpAccessRule Volcengine.ShareConfigAllowIpAccessRule: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
AllowRefererAccessRule Volcengine.ShareConfigAllowRefererAccessRule: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
CommonMatchList Volcengine.ShareConfigCommonMatchList: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
ConfigName string: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
ConfigType string: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
DenyIpAccessRule Volcengine.ShareConfigDenyIpAccessRule: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
DenyRefererAccessRule Volcengine.ShareConfigDenyRefererAccessRule: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
DomainCount int: Indicates the number of accelerated domains associated with this global configuration.
Project string: Specifies the project name to which the global configuration belongs.
RuleContent string: Specifies the HTML code for the custom error page.
UpdatedTime int: Indicates the last modification time of this global configuration, in Unix timestamp.

AllowIpAccessRule ShareConfigAllowIpAccessRuleArgs: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
AllowRefererAccessRule ShareConfigAllowRefererAccessRuleArgs: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
CommonMatchList ShareConfigCommonMatchListArgs: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
ConfigName string: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
ConfigType string: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
DenyIpAccessRule ShareConfigDenyIpAccessRuleArgs: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
DenyRefererAccessRule ShareConfigDenyRefererAccessRuleArgs: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
DomainCount int: Indicates the number of accelerated domains associated with this global configuration.
Project string: Specifies the project name to which the global configuration belongs.
RuleContent string: Specifies the HTML code for the custom error page.
UpdatedTime int: Indicates the last modification time of this global configuration, in Unix timestamp.

allowIpAccessRule ShareConfigAllowIpAccessRule: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
allowRefererAccessRule ShareConfigAllowRefererAccessRule: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
commonMatchList ShareConfigCommonMatchList: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
configName String: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
configType String: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
denyIpAccessRule ShareConfigDenyIpAccessRule: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
denyRefererAccessRule ShareConfigDenyRefererAccessRule: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
domainCount Integer: Indicates the number of accelerated domains associated with this global configuration.
project String: Specifies the project name to which the global configuration belongs.
ruleContent String: Specifies the HTML code for the custom error page.
updatedTime Integer: Indicates the last modification time of this global configuration, in Unix timestamp.

allowIpAccessRule ShareConfigAllowIpAccessRule: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
allowRefererAccessRule ShareConfigAllowRefererAccessRule: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
commonMatchList ShareConfigCommonMatchList: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
configName string: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
configType string: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
denyIpAccessRule ShareConfigDenyIpAccessRule: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
denyRefererAccessRule ShareConfigDenyRefererAccessRule: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
domainCount number: Indicates the number of accelerated domains associated with this global configuration.
project string: Specifies the project name to which the global configuration belongs.
ruleContent string: Specifies the HTML code for the custom error page.
updatedTime number: Indicates the last modification time of this global configuration, in Unix timestamp.

allow_ip_access_rule ShareConfigAllowIpAccessRuleArgs: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
allow_referer_access_rule ShareConfigAllowRefererAccessRuleArgs: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
common_match_list ShareConfigCommonMatchListArgs: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
config_name str: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
config_type str: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
deny_ip_access_rule ShareConfigDenyIpAccessRuleArgs: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
deny_referer_access_rule ShareConfigDenyRefererAccessRuleArgs: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
domain_count int: Indicates the number of accelerated domains associated with this global configuration.
project str: Specifies the project name to which the global configuration belongs.
rule_content str: Specifies the HTML code for the custom error page.
updated_time int: Indicates the last modification time of this global configuration, in Unix timestamp.

allowIpAccessRule Property Map: Specifies the configuration for an IP allowlist, where ConfigType is allowipaccess*rule.
allowRefererAccessRule Property Map: Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allowrefereraccess*rule.
commonMatchList Property Map: Specifies the configuration for a common list, where ConfigType is commonmatchlist.
configName String: Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.
configType String: This parameter specifies the type of global configuration. Available values are: denyipaccessrule: indicates an IP denylist. allowipaccessrule: indicates an IP allowlist. denyrefereraccessrule: indicates a Referer denylist. allowrefereraccessrule: indicates a Referer allowlist. commonmatchlist: indicates a common list.
denyIpAccessRule Property Map: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess*rule.
denyRefererAccessRule Property Map: Indicates a configuration for a Referer denylist. The corresponding ConfigType is denyrefereraccess*rule.
domainCount Number: Indicates the number of accelerated domains associated with this global configuration.
project String: Specifies the project name to which the global configuration belongs.
ruleContent String: Specifies the HTML code for the custom error page.
updatedTime Number: Indicates the last modification time of this global configuration, in Unix timestamp.

Supporting Types

ShareConfigAllowIpAccessRule, ShareConfigAllowIpAccessRuleArgs

Rules List<string>: Specifies a list of entries. Each entry in the list is an IP address or CIDR block. IP addresses and blocks can be in IPv4 or IPv6 format. List limits: For AddSharedConfig, the number of entries in the list cannot exceed 30,000.

Rules []string: Specifies a list of entries. Each entry in the list is an IP address or CIDR block. IP addresses and blocks can be in IPv4 or IPv6 format. List limits: For AddSharedConfig, the number of entries in the list cannot exceed 30,000.

rules List<String>: Specifies a list of entries. Each entry in the list is an IP address or CIDR block. IP addresses and blocks can be in IPv4 or IPv6 format. List limits: For AddSharedConfig, the number of entries in the list cannot exceed 30,000.

rules string[]: Specifies a list of entries. Each entry in the list is an IP address or CIDR block. IP addresses and blocks can be in IPv4 or IPv6 format. List limits: For AddSharedConfig, the number of entries in the list cannot exceed 30,000.

rules Sequence[str]: Specifies a list of entries. Each entry in the list is an IP address or CIDR block. IP addresses and blocks can be in IPv4 or IPv6 format. List limits: For AddSharedConfig, the number of entries in the list cannot exceed 30,000.

rules List<String>: Specifies a list of entries. Each entry in the list is an IP address or CIDR block. IP addresses and blocks can be in IPv4 or IPv6 format. List limits: For AddSharedConfig, the number of entries in the list cannot exceed 30,000.

ShareConfigAllowRefererAccessRule, ShareConfigAllowRefererAccessRuleArgs

AllowEmpty bool: Indicates whether requests with an empty Referer header or without a Referer header are not allowed. This parameter has the following values: true: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. false: Allowed. The default value is false.
CommonType Volcengine.ShareConfigAllowRefererAccessRuleCommonType: Specifies the contents of the common list.

AllowEmpty bool: Indicates whether requests with an empty Referer header or without a Referer header are not allowed. This parameter has the following values: true: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. false: Allowed. The default value is false.
CommonType ShareConfigAllowRefererAccessRuleCommonType: Specifies the contents of the common list.

allowEmpty Boolean: Indicates whether requests with an empty Referer header or without a Referer header are not allowed. This parameter has the following values: true: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. false: Allowed. The default value is false.
commonType ShareConfigAllowRefererAccessRuleCommonType: Specifies the contents of the common list.

allowEmpty boolean: Indicates whether requests with an empty Referer header or without a Referer header are not allowed. This parameter has the following values: true: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. false: Allowed. The default value is false.
commonType ShareConfigAllowRefererAccessRuleCommonType: Specifies the contents of the common list.

allow_empty bool: Indicates whether requests with an empty Referer header or without a Referer header are not allowed. This parameter has the following values: true: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. false: Allowed. The default value is false.
common_type ShareConfigAllowRefererAccessRuleCommonType: Specifies the contents of the common list.

allowEmpty Boolean: Indicates whether requests with an empty Referer header or without a Referer header are not allowed. This parameter has the following values: true: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. false: Allowed. The default value is false.
commonType Property Map: Specifies the contents of the common list.

ShareConfigAllowRefererAccessRuleCommonType, ShareConfigAllowRefererAccessRuleCommonTypeArgs

IgnoreCase bool: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
Rules List<string>: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

IgnoreCase bool: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
Rules []string: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignoreCase Boolean: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules List<String>: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignoreCase boolean: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules string[]: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignore_case bool: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules Sequence[str]: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignoreCase Boolean: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules List<String>: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ShareConfigCommonMatchList, ShareConfigCommonMatchListArgs

CommonType Volcengine.ShareConfigCommonMatchListCommonType: Specifies the contents of the common list.

CommonType ShareConfigCommonMatchListCommonType: Specifies the contents of the common list.

commonType ShareConfigCommonMatchListCommonType: Specifies the contents of the common list.

commonType ShareConfigCommonMatchListCommonType: Specifies the contents of the common list.

common_type ShareConfigCommonMatchListCommonType: Specifies the contents of the common list.

commonType Property Map: Specifies the contents of the common list.

ShareConfigCommonMatchListCommonType, ShareConfigCommonMatchListCommonTypeArgs

IgnoreCase bool: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
Rules List<string>: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

IgnoreCase bool: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
Rules []string: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignoreCase Boolean: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules List<String>: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignoreCase boolean: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules string[]: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignore_case bool: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules Sequence[str]: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignoreCase Boolean: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules List<String>: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ShareConfigDenyIpAccessRule, ShareConfigDenyIpAccessRuleArgs

Rules List<string>: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess_rule.

Rules []string: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess_rule.

rules List<String>: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess_rule.

rules string[]: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess_rule.

rules Sequence[str]: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess_rule.

rules List<String>: Specifies the configuration for an IP denylist, where ConfigType is denyipaccess_rule.

ShareConfigDenyRefererAccessRule, ShareConfigDenyRefererAccessRuleArgs

AllowEmpty bool: Indicates whether requests with an empty Referer header or without a Referer header are allowed. This parameter has the following values: true: Allowed. false: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. The default value is true.
CommonType Volcengine.ShareConfigDenyRefererAccessRuleCommonType: Specifies the contents of the common list.

AllowEmpty bool: Indicates whether requests with an empty Referer header or without a Referer header are allowed. This parameter has the following values: true: Allowed. false: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. The default value is true.
CommonType ShareConfigDenyRefererAccessRuleCommonType: Specifies the contents of the common list.

allowEmpty Boolean: Indicates whether requests with an empty Referer header or without a Referer header are allowed. This parameter has the following values: true: Allowed. false: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. The default value is true.
commonType ShareConfigDenyRefererAccessRuleCommonType: Specifies the contents of the common list.

allowEmpty boolean: Indicates whether requests with an empty Referer header or without a Referer header are allowed. This parameter has the following values: true: Allowed. false: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. The default value is true.
commonType ShareConfigDenyRefererAccessRuleCommonType: Specifies the contents of the common list.

allow_empty bool: Indicates whether requests with an empty Referer header or without a Referer header are allowed. This parameter has the following values: true: Allowed. false: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. The default value is true.
common_type ShareConfigDenyRefererAccessRuleCommonType: Specifies the contents of the common list.

allowEmpty Boolean: Indicates whether requests with an empty Referer header or without a Referer header are allowed. This parameter has the following values: true: Allowed. false: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. The default value is true.
commonType Property Map: Specifies the contents of the common list.

ShareConfigDenyRefererAccessRuleCommonType, ShareConfigDenyRefererAccessRuleCommonTypeArgs

IgnoreCase bool: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
Rules List<string>: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

IgnoreCase bool: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
Rules []string: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignoreCase Boolean: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules List<String>: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignoreCase boolean: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules string[]: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignore_case bool: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules Sequence[str]: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

ignoreCase Boolean: Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.
rules List<String>: Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.

Import

$ pulumi import volcenginecc:cdn/shareConfig:ShareConfig example "config_name"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.cdn.ShareConfig

On this page

On this page

Example Usage

Create ShareConfig Resource

Constructor syntax

Parameters

Constructor example

ShareConfig Resource Properties

Inputs

Outputs

Look up Existing ShareConfig Resource

Supporting Types

ShareConfigAllowIpAccessRule, ShareConfigAllowIpAccessRuleArgs

ShareConfigAllowRefererAccessRule, ShareConfigAllowRefererAccessRuleArgs

ShareConfigAllowRefererAccessRuleCommonType, ShareConfigAllowRefererAccessRuleCommonTypeArgs

ShareConfigCommonMatchList, ShareConfigCommonMatchListArgs

ShareConfigCommonMatchListCommonType, ShareConfigCommonMatchListCommonTypeArgs

ShareConfigDenyIpAccessRule, ShareConfigDenyIpAccessRuleArgs

ShareConfigDenyRefererAccessRule, ShareConfigDenyRefererAccessRuleArgs

ShareConfigDenyRefererAccessRuleCommonType, ShareConfigDenyRefererAccessRuleCommonTypeArgs

Import

Package Details

On this page

On this page