1. Packages
  2. Cloudflare
  3. API Docs
  4. WaitingRoomSettings
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

cloudflare.WaitingRoomSettings

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

    Configure zone-wide settings for Cloudflare waiting rooms.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = new cloudflare.WaitingRoomSettings("example", {
        zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
        searchEngineCrawlerBypass: true,
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.WaitingRoomSettings("example",
        zone_id="0da42c8d2132a9ddaf714f9e7c920711",
        search_engine_crawler_bypass=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.NewWaitingRoomSettings(ctx, "example", &cloudflare.WaitingRoomSettingsArgs{
    			ZoneId:                    pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
    			SearchEngineCrawlerBypass: 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 example = new Cloudflare.WaitingRoomSettings("example", new()
        {
            ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
            SearchEngineCrawlerBypass = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.WaitingRoomSettings;
    import com.pulumi.cloudflare.WaitingRoomSettingsArgs;
    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 example = new WaitingRoomSettings("example", WaitingRoomSettingsArgs.builder()
                .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
                .searchEngineCrawlerBypass(true)
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:WaitingRoomSettings
        properties:
          zoneId: 0da42c8d2132a9ddaf714f9e7c920711
          searchEngineCrawlerBypass: true
    

    Create WaitingRoomSettings Resource

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

    Constructor syntax

    new WaitingRoomSettings(name: string, args: WaitingRoomSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def WaitingRoomSettings(resource_name: str,
                            args: WaitingRoomSettingsArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def WaitingRoomSettings(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            zone_id: Optional[str] = None,
                            search_engine_crawler_bypass: Optional[bool] = None)
    func NewWaitingRoomSettings(ctx *Context, name string, args WaitingRoomSettingsArgs, opts ...ResourceOption) (*WaitingRoomSettings, error)
    public WaitingRoomSettings(string name, WaitingRoomSettingsArgs args, CustomResourceOptions? opts = null)
    public WaitingRoomSettings(String name, WaitingRoomSettingsArgs args)
    public WaitingRoomSettings(String name, WaitingRoomSettingsArgs args, CustomResourceOptions options)
    
    type: cloudflare:WaitingRoomSettings
    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 WaitingRoomSettingsArgs
    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 WaitingRoomSettingsArgs
    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 WaitingRoomSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WaitingRoomSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WaitingRoomSettingsArgs
    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 waitingRoomSettingsResource = new Cloudflare.WaitingRoomSettings("waitingRoomSettingsResource", new()
    {
        ZoneId = "string",
        SearchEngineCrawlerBypass = false,
    });
    
    example, err := cloudflare.NewWaitingRoomSettings(ctx, "waitingRoomSettingsResource", &cloudflare.WaitingRoomSettingsArgs{
    	ZoneId:                    pulumi.String("string"),
    	SearchEngineCrawlerBypass: pulumi.Bool(false),
    })
    
    var waitingRoomSettingsResource = new WaitingRoomSettings("waitingRoomSettingsResource", WaitingRoomSettingsArgs.builder()
        .zoneId("string")
        .searchEngineCrawlerBypass(false)
        .build());
    
    waiting_room_settings_resource = cloudflare.WaitingRoomSettings("waitingRoomSettingsResource",
        zone_id="string",
        search_engine_crawler_bypass=False)
    
    const waitingRoomSettingsResource = new cloudflare.WaitingRoomSettings("waitingRoomSettingsResource", {
        zoneId: "string",
        searchEngineCrawlerBypass: false,
    });
    
    type: cloudflare:WaitingRoomSettings
    properties:
        searchEngineCrawlerBypass: false
        zoneId: string
    

    WaitingRoomSettings Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The WaitingRoomSettings resource accepts the following input properties:

    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    SearchEngineCrawlerBypass bool
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    SearchEngineCrawlerBypass bool
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    searchEngineCrawlerBypass Boolean
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    zoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    searchEngineCrawlerBypass boolean
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    zone_id str
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    search_engine_crawler_bypass bool
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    searchEngineCrawlerBypass Boolean
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WaitingRoomSettings Resource

    Get an existing WaitingRoomSettings 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?: WaitingRoomSettingsState, opts?: CustomResourceOptions): WaitingRoomSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            search_engine_crawler_bypass: Optional[bool] = None,
            zone_id: Optional[str] = None) -> WaitingRoomSettings
    func GetWaitingRoomSettings(ctx *Context, name string, id IDInput, state *WaitingRoomSettingsState, opts ...ResourceOption) (*WaitingRoomSettings, error)
    public static WaitingRoomSettings Get(string name, Input<string> id, WaitingRoomSettingsState? state, CustomResourceOptions? opts = null)
    public static WaitingRoomSettings get(String name, Output<String> id, WaitingRoomSettingsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    SearchEngineCrawlerBypass bool
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    SearchEngineCrawlerBypass bool
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    searchEngineCrawlerBypass Boolean
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    searchEngineCrawlerBypass boolean
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    zoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    search_engine_crawler_bypass bool
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    zone_id str
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    searchEngineCrawlerBypass Boolean
    Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Defaults to false.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

    Import

    $ pulumi import cloudflare:index/waitingRoomSettings:WaitingRoomSettings example <zone_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 v5.34.0 published on Friday, Jul 12, 2024 by Pulumi