Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. SnippetRules
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.SnippetRules

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  exampleSnippetRules:
    type: cloudflare:SnippetRules
    name: example_snippet_rules
    properties:
      zoneId: 023e105f4ecef8ad9ca31a8372d0c353
      rules:
        - description: Rule description
          enabled: true
          expression: http.cookie eq "a=b"
          snippet_name: snippet_name_01

    Create SnippetRules Resource

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

    Constructor syntax

    new SnippetRules(name: string, args: SnippetRulesArgs, opts?: CustomResourceOptions);
    @overload
def SnippetRules(resource_name: str,
                 args: SnippetRulesArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def SnippetRules(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 zone_id: Optional[str] = None,
                 rules: Optional[Sequence[SnippetRulesRuleArgs]] = None)
    func NewSnippetRules(ctx *Context, name string, args SnippetRulesArgs, opts ...ResourceOption) (*SnippetRules, error)
    public SnippetRules(string name, SnippetRulesArgs args, CustomResourceOptions? opts = null)
    public SnippetRules(String name, SnippetRulesArgs args)
public SnippetRules(String name, SnippetRulesArgs args, CustomResourceOptions options)

    type: cloudflare:SnippetRules
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 SnippetRulesArgs
    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 SnippetRulesArgs
    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 SnippetRulesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnippetRulesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnippetRulesArgs
    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 snippetRulesResource = new Cloudflare.SnippetRules("snippetRulesResource", new()
{
    ZoneId = "string",
    Rules = new[]
    {
        new Cloudflare.Inputs.SnippetRulesRuleArgs
        {
            Description = "string",
            Enabled = false,
            Expression = "string",
            SnippetName = "string",
        },
    },
});

    example, err := cloudflare.NewSnippetRules(ctx, "snippetRulesResource", &cloudflare.SnippetRulesArgs{
	ZoneId: pulumi.String("string"),
	Rules: cloudflare.SnippetRulesRuleArray{
		&cloudflare.SnippetRulesRuleArgs{
			Description: pulumi.String("string"),
			Enabled:     pulumi.Bool(false),
			Expression:  pulumi.String("string"),
			SnippetName: pulumi.String("string"),
		},
	},
})

    var snippetRulesResource = new SnippetRules("snippetRulesResource", SnippetRulesArgs.builder()
    .zoneId("string")
    .rules(SnippetRulesRuleArgs.builder()
        .description("string")
        .enabled(false)
        .expression("string")
        .snippetName("string")
        .build())
    .build());

    snippet_rules_resource = cloudflare.SnippetRules("snippetRulesResource",
    zone_id="string",
    rules=[{
        "description": "string",
        "enabled": False,
        "expression": "string",
        "snippet_name": "string",
    }])

    const snippetRulesResource = new cloudflare.SnippetRules("snippetRulesResource", {
    zoneId: "string",
    rules: [{
        description: "string",
        enabled: false,
        expression: "string",
        snippetName: "string",
    }],
});

    type: cloudflare:SnippetRules
properties:
    rules:
        - description: string
          enabled: false
          expression: string
          snippetName: string
    zoneId: string

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

    ZoneId string
    Identifier
    Rules List<SnippetRulesRule>
    List of snippet rules
    ZoneId string
    Identifier
    Rules []SnippetRulesRuleArgs
    List of snippet rules
    zoneId String
    Identifier
    rules List<SnippetRulesRule>
    List of snippet rules
    zoneId string
    Identifier
    rules SnippetRulesRule[]
    List of snippet rules
    zone_id str
    Identifier
    rules Sequence[SnippetRulesRuleArgs]
    List of snippet rules
    zoneId String
    Identifier
    rules List<Property Map>
    List of snippet rules

    Outputs

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

    Description string
    Enabled bool
    Expression string
    Id string
    The provider-assigned unique ID for this managed resource.
    SnippetName string
    Snippet identifying name
    Description string
    Enabled bool
    Expression string
    Id string
    The provider-assigned unique ID for this managed resource.
    SnippetName string
    Snippet identifying name
    description String
    enabled Boolean
    expression String
    id String
    The provider-assigned unique ID for this managed resource.
    snippetName String
    Snippet identifying name
    description string
    enabled boolean
    expression string
    id string
    The provider-assigned unique ID for this managed resource.
    snippetName string
    Snippet identifying name
    description str
    enabled bool
    expression str
    id str
    The provider-assigned unique ID for this managed resource.
    snippet_name str
    Snippet identifying name
    description String
    enabled Boolean
    expression String
    id String
    The provider-assigned unique ID for this managed resource.
    snippetName String
    Snippet identifying name

    Look up Existing SnippetRules Resource

    Get an existing SnippetRules 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?: SnippetRulesState, opts?: CustomResourceOptions): SnippetRules
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        expression: Optional[str] = None,
        rules: Optional[Sequence[SnippetRulesRuleArgs]] = None,
        snippet_name: Optional[str] = None,
        zone_id: Optional[str] = None) -> SnippetRules
    func GetSnippetRules(ctx *Context, name string, id IDInput, state *SnippetRulesState, opts ...ResourceOption) (*SnippetRules, error)
    public static SnippetRules Get(string name, Input<string> id, SnippetRulesState? state, CustomResourceOptions? opts = null)
    public static SnippetRules get(String name, Output<String> id, SnippetRulesState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:SnippetRules    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:
    Description string
    Enabled bool
    Expression string
    Rules List<SnippetRulesRule>
    List of snippet rules
    SnippetName string
    Snippet identifying name
    ZoneId string
    Identifier
    Description string
    Enabled bool
    Expression string
    Rules []SnippetRulesRuleArgs
    List of snippet rules
    SnippetName string
    Snippet identifying name
    ZoneId string
    Identifier
    description String
    enabled Boolean
    expression String
    rules List<SnippetRulesRule>
    List of snippet rules
    snippetName String
    Snippet identifying name
    zoneId String
    Identifier
    description string
    enabled boolean
    expression string
    rules SnippetRulesRule[]
    List of snippet rules
    snippetName string
    Snippet identifying name
    zoneId string
    Identifier
    description str
    enabled bool
    expression str
    rules Sequence[SnippetRulesRuleArgs]
    List of snippet rules
    snippet_name str
    Snippet identifying name
    zone_id str
    Identifier
    description String
    enabled Boolean
    expression String
    rules List<Property Map>
    List of snippet rules
    snippetName String
    Snippet identifying name
    zoneId String
    Identifier

    Supporting Types

    SnippetRulesRule, SnippetRulesRuleArgs

    Description string
    Enabled bool
    Expression string
    SnippetName string
    Snippet identifying name
    Description string
    Enabled bool
    Expression string
    SnippetName string
    Snippet identifying name
    description String
    enabled Boolean
    expression String
    snippetName String
    Snippet identifying name
    description string
    enabled boolean
    expression string
    snippetName string
    Snippet identifying name
    description str
    enabled bool
    expression str
    snippet_name str
    Snippet identifying name
    description String
    enabled Boolean
    expression String
    snippetName String
    Snippet identifying name

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-cloudflare