1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. WaitingRoomRules
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.WaitingRoomRules

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleWaitingRoomRules = new cloudflare.WaitingRoomRules("example_waiting_room_rules", {
        zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
        waitingRoomId: "699d98642c564d2e855e9661899b7252",
        rules: [{
            action: "bypass_waiting_room",
            expression: "ip.src in {10.20.30.40}",
            description: "allow all traffic from 10.20.30.40",
            enabled: true,
        }],
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_waiting_room_rules = cloudflare.WaitingRoomRules("example_waiting_room_rules",
        zone_id="023e105f4ecef8ad9ca31a8372d0c353",
        waiting_room_id="699d98642c564d2e855e9661899b7252",
        rules=[{
            "action": "bypass_waiting_room",
            "expression": "ip.src in {10.20.30.40}",
            "description": "allow all traffic from 10.20.30.40",
            "enabled": True,
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.NewWaitingRoomRules(ctx, "example_waiting_room_rules", &cloudflare.WaitingRoomRulesArgs{
    			ZoneId:        pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    			WaitingRoomId: pulumi.String("699d98642c564d2e855e9661899b7252"),
    			Rules: cloudflare.WaitingRoomRulesRuleArray{
    				&cloudflare.WaitingRoomRulesRuleArgs{
    					Action:      pulumi.String("bypass_waiting_room"),
    					Expression:  pulumi.String("ip.src in {10.20.30.40}"),
    					Description: pulumi.String("allow all traffic from 10.20.30.40"),
    					Enabled:     pulumi.Bool(true),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleWaitingRoomRules = new Cloudflare.WaitingRoomRules("example_waiting_room_rules", new()
        {
            ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
            WaitingRoomId = "699d98642c564d2e855e9661899b7252",
            Rules = new[]
            {
                new Cloudflare.Inputs.WaitingRoomRulesRuleArgs
                {
                    Action = "bypass_waiting_room",
                    Expression = "ip.src in {10.20.30.40}",
                    Description = "allow all traffic from 10.20.30.40",
                    Enabled = true,
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.WaitingRoomRules;
    import com.pulumi.cloudflare.WaitingRoomRulesArgs;
    import com.pulumi.cloudflare.inputs.WaitingRoomRulesRuleArgs;
    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) {
            var exampleWaitingRoomRules = new WaitingRoomRules("exampleWaitingRoomRules", WaitingRoomRulesArgs.builder()
                .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
                .waitingRoomId("699d98642c564d2e855e9661899b7252")
                .rules(WaitingRoomRulesRuleArgs.builder()
                    .action("bypass_waiting_room")
                    .expression("ip.src in {10.20.30.40}")
                    .description("allow all traffic from 10.20.30.40")
                    .enabled(true)
                    .build())
                .build());
    
        }
    }
    
    resources:
      exampleWaitingRoomRules:
        type: cloudflare:WaitingRoomRules
        name: example_waiting_room_rules
        properties:
          zoneId: 023e105f4ecef8ad9ca31a8372d0c353
          waitingRoomId: 699d98642c564d2e855e9661899b7252
          rules:
            - action: bypass_waiting_room
              expression: ip.src in {10.20.30.40}
              description: allow all traffic from 10.20.30.40
              enabled: true
    

    Create WaitingRoomRules Resource

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

    Constructor syntax

    new WaitingRoomRules(name: string, args: WaitingRoomRulesArgs, opts?: CustomResourceOptions);
    @overload
    def WaitingRoomRules(resource_name: str,
                         args: WaitingRoomRulesArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def WaitingRoomRules(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         rules: Optional[Sequence[WaitingRoomRulesRuleArgs]] = None,
                         waiting_room_id: Optional[str] = None,
                         zone_id: Optional[str] = None)
    func NewWaitingRoomRules(ctx *Context, name string, args WaitingRoomRulesArgs, opts ...ResourceOption) (*WaitingRoomRules, error)
    public WaitingRoomRules(string name, WaitingRoomRulesArgs args, CustomResourceOptions? opts = null)
    public WaitingRoomRules(String name, WaitingRoomRulesArgs args)
    public WaitingRoomRules(String name, WaitingRoomRulesArgs args, CustomResourceOptions options)
    
    type: cloudflare:WaitingRoomRules
    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 WaitingRoomRulesArgs
    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 WaitingRoomRulesArgs
    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 WaitingRoomRulesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WaitingRoomRulesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WaitingRoomRulesArgs
    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 waitingRoomRulesResource = new Cloudflare.WaitingRoomRules("waitingRoomRulesResource", new()
    {
        Rules = new[]
        {
            new Cloudflare.Inputs.WaitingRoomRulesRuleArgs
            {
                Action = "string",
                Expression = "string",
                Description = "string",
                Enabled = false,
            },
        },
        WaitingRoomId = "string",
        ZoneId = "string",
    });
    
    example, err := cloudflare.NewWaitingRoomRules(ctx, "waitingRoomRulesResource", &cloudflare.WaitingRoomRulesArgs{
    	Rules: cloudflare.WaitingRoomRulesRuleArray{
    		&cloudflare.WaitingRoomRulesRuleArgs{
    			Action:      pulumi.String("string"),
    			Expression:  pulumi.String("string"),
    			Description: pulumi.String("string"),
    			Enabled:     pulumi.Bool(false),
    		},
    	},
    	WaitingRoomId: pulumi.String("string"),
    	ZoneId:        pulumi.String("string"),
    })
    
    var waitingRoomRulesResource = new WaitingRoomRules("waitingRoomRulesResource", WaitingRoomRulesArgs.builder()
        .rules(WaitingRoomRulesRuleArgs.builder()
            .action("string")
            .expression("string")
            .description("string")
            .enabled(false)
            .build())
        .waitingRoomId("string")
        .zoneId("string")
        .build());
    
    waiting_room_rules_resource = cloudflare.WaitingRoomRules("waitingRoomRulesResource",
        rules=[{
            "action": "string",
            "expression": "string",
            "description": "string",
            "enabled": False,
        }],
        waiting_room_id="string",
        zone_id="string")
    
    const waitingRoomRulesResource = new cloudflare.WaitingRoomRules("waitingRoomRulesResource", {
        rules: [{
            action: "string",
            expression: "string",
            description: "string",
            enabled: false,
        }],
        waitingRoomId: "string",
        zoneId: "string",
    });
    
    type: cloudflare:WaitingRoomRules
    properties:
        rules:
            - action: string
              description: string
              enabled: false
              expression: string
        waitingRoomId: string
        zoneId: string
    

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

    Outputs

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

    Action string
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    Description string
    The description of the rule.
    Enabled bool
    When set to true, the rule is enabled.
    Expression string
    Criteria defining when there is a match for the current rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    Version string
    The version of the rule.
    Action string
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    Description string
    The description of the rule.
    Enabled bool
    When set to true, the rule is enabled.
    Expression string
    Criteria defining when there is a match for the current rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    Version string
    The version of the rule.
    action String
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    description String
    The description of the rule.
    enabled Boolean
    When set to true, the rule is enabled.
    expression String
    Criteria defining when there is a match for the current rule.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    version String
    The version of the rule.
    action string
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    description string
    The description of the rule.
    enabled boolean
    When set to true, the rule is enabled.
    expression string
    Criteria defining when there is a match for the current rule.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdated string
    version string
    The version of the rule.
    action str
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    description str
    The description of the rule.
    enabled bool
    When set to true, the rule is enabled.
    expression str
    Criteria defining when there is a match for the current rule.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated str
    version str
    The version of the rule.
    action String
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    description String
    The description of the rule.
    enabled Boolean
    When set to true, the rule is enabled.
    expression String
    Criteria defining when there is a match for the current rule.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    version String
    The version of the rule.

    Look up Existing WaitingRoomRules Resource

    Get an existing WaitingRoomRules 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?: WaitingRoomRulesState, opts?: CustomResourceOptions): WaitingRoomRules
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action: Optional[str] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            expression: Optional[str] = None,
            last_updated: Optional[str] = None,
            rules: Optional[Sequence[WaitingRoomRulesRuleArgs]] = None,
            version: Optional[str] = None,
            waiting_room_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> WaitingRoomRules
    func GetWaitingRoomRules(ctx *Context, name string, id IDInput, state *WaitingRoomRulesState, opts ...ResourceOption) (*WaitingRoomRules, error)
    public static WaitingRoomRules Get(string name, Input<string> id, WaitingRoomRulesState? state, CustomResourceOptions? opts = null)
    public static WaitingRoomRules get(String name, Output<String> id, WaitingRoomRulesState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:WaitingRoomRules    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:
    Action string
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    Description string
    The description of the rule.
    Enabled bool
    When set to true, the rule is enabled.
    Expression string
    Criteria defining when there is a match for the current rule.
    LastUpdated string
    Rules List<WaitingRoomRulesRule>
    Version string
    The version of the rule.
    WaitingRoomId string
    ZoneId string
    Identifier
    Action string
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    Description string
    The description of the rule.
    Enabled bool
    When set to true, the rule is enabled.
    Expression string
    Criteria defining when there is a match for the current rule.
    LastUpdated string
    Rules []WaitingRoomRulesRuleArgs
    Version string
    The version of the rule.
    WaitingRoomId string
    ZoneId string
    Identifier
    action String
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    description String
    The description of the rule.
    enabled Boolean
    When set to true, the rule is enabled.
    expression String
    Criteria defining when there is a match for the current rule.
    lastUpdated String
    rules List<WaitingRoomRulesRule>
    version String
    The version of the rule.
    waitingRoomId String
    zoneId String
    Identifier
    action string
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    description string
    The description of the rule.
    enabled boolean
    When set to true, the rule is enabled.
    expression string
    Criteria defining when there is a match for the current rule.
    lastUpdated string
    rules WaitingRoomRulesRule[]
    version string
    The version of the rule.
    waitingRoomId string
    zoneId string
    Identifier
    action str
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    description str
    The description of the rule.
    enabled bool
    When set to true, the rule is enabled.
    expression str
    Criteria defining when there is a match for the current rule.
    last_updated str
    rules Sequence[WaitingRoomRulesRuleArgs]
    version str
    The version of the rule.
    waiting_room_id str
    zone_id str
    Identifier
    action String
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    description String
    The description of the rule.
    enabled Boolean
    When set to true, the rule is enabled.
    expression String
    Criteria defining when there is a match for the current rule.
    lastUpdated String
    rules List<Property Map>
    version String
    The version of the rule.
    waitingRoomId String
    zoneId String
    Identifier

    Supporting Types

    WaitingRoomRulesRule, WaitingRoomRulesRuleArgs

    Action string
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    Expression string
    Criteria defining when there is a match for the current rule.
    Description string
    The description of the rule.
    Enabled bool
    When set to true, the rule is enabled.
    Action string
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    Expression string
    Criteria defining when there is a match for the current rule.
    Description string
    The description of the rule.
    Enabled bool
    When set to true, the rule is enabled.
    action String
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    expression String
    Criteria defining when there is a match for the current rule.
    description String
    The description of the rule.
    enabled Boolean
    When set to true, the rule is enabled.
    action string
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    expression string
    Criteria defining when there is a match for the current rule.
    description string
    The description of the rule.
    enabled boolean
    When set to true, the rule is enabled.
    action str
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    expression str
    Criteria defining when there is a match for the current rule.
    description str
    The description of the rule.
    enabled bool
    When set to true, the rule is enabled.
    action String
    The action to take when the expression matches. Available values: "bypasswaitingroom".
    expression String
    Criteria defining when there is a match for the current rule.
    description String
    The description of the rule.
    enabled Boolean
    When set to true, the rule is enabled.

    Import

    $ pulumi import cloudflare:index/waitingRoomRules:WaitingRoomRules example '<zone_id>/<waiting_room_id>'
    

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

    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