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

cloudflare.ZoneHold

Explore with Pulumi AI

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

    Provides a Cloudflare Zone Hold resource that prevents adding the hostname to another account for use.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = new cloudflare.ZoneHold("example", {
        zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
        hold: true,
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.ZoneHold("example",
        zone_id="0da42c8d2132a9ddaf714f9e7c920711",
        hold=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.NewZoneHold(ctx, "example", &cloudflare.ZoneHoldArgs{
    			ZoneId: pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
    			Hold:   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.ZoneHold("example", new()
        {
            ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
            Hold = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.ZoneHold;
    import com.pulumi.cloudflare.ZoneHoldArgs;
    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 ZoneHold("example", ZoneHoldArgs.builder()
                .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
                .hold(true)
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:ZoneHold
        properties:
          zoneId: 0da42c8d2132a9ddaf714f9e7c920711
          hold: true
    

    Create ZoneHold Resource

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

    Constructor syntax

    new ZoneHold(name: string, args: ZoneHoldArgs, opts?: CustomResourceOptions);
    @overload
    def ZoneHold(resource_name: str,
                 args: ZoneHoldArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def ZoneHold(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 hold: Optional[bool] = None,
                 zone_id: Optional[str] = None,
                 hold_after: Optional[str] = None,
                 include_subdomains: Optional[bool] = None)
    func NewZoneHold(ctx *Context, name string, args ZoneHoldArgs, opts ...ResourceOption) (*ZoneHold, error)
    public ZoneHold(string name, ZoneHoldArgs args, CustomResourceOptions? opts = null)
    public ZoneHold(String name, ZoneHoldArgs args)
    public ZoneHold(String name, ZoneHoldArgs args, CustomResourceOptions options)
    
    type: cloudflare:ZoneHold
    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 ZoneHoldArgs
    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 ZoneHoldArgs
    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 ZoneHoldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZoneHoldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZoneHoldArgs
    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 zoneHoldResource = new Cloudflare.ZoneHold("zoneHoldResource", new()
    {
        Hold = false,
        ZoneId = "string",
        HoldAfter = "string",
        IncludeSubdomains = false,
    });
    
    example, err := cloudflare.NewZoneHold(ctx, "zoneHoldResource", &cloudflare.ZoneHoldArgs{
    	Hold:              pulumi.Bool(false),
    	ZoneId:            pulumi.String("string"),
    	HoldAfter:         pulumi.String("string"),
    	IncludeSubdomains: pulumi.Bool(false),
    })
    
    var zoneHoldResource = new ZoneHold("zoneHoldResource", ZoneHoldArgs.builder()
        .hold(false)
        .zoneId("string")
        .holdAfter("string")
        .includeSubdomains(false)
        .build());
    
    zone_hold_resource = cloudflare.ZoneHold("zoneHoldResource",
        hold=False,
        zone_id="string",
        hold_after="string",
        include_subdomains=False)
    
    const zoneHoldResource = new cloudflare.ZoneHold("zoneHoldResource", {
        hold: false,
        zoneId: "string",
        holdAfter: "string",
        includeSubdomains: false,
    });
    
    type: cloudflare:ZoneHold
    properties:
        hold: false
        holdAfter: string
        includeSubdomains: false
        zoneId: string
    

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

    Hold bool
    Enablement status of the zone hold.
    ZoneId string
    The zone identifier to target for the resource.
    HoldAfter string
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    IncludeSubdomains bool
    Whether to extend to block any subdomain of the given zone.
    Hold bool
    Enablement status of the zone hold.
    ZoneId string
    The zone identifier to target for the resource.
    HoldAfter string
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    IncludeSubdomains bool
    Whether to extend to block any subdomain of the given zone.
    hold Boolean
    Enablement status of the zone hold.
    zoneId String
    The zone identifier to target for the resource.
    holdAfter String
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    includeSubdomains Boolean
    Whether to extend to block any subdomain of the given zone.
    hold boolean
    Enablement status of the zone hold.
    zoneId string
    The zone identifier to target for the resource.
    holdAfter string
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    includeSubdomains boolean
    Whether to extend to block any subdomain of the given zone.
    hold bool
    Enablement status of the zone hold.
    zone_id str
    The zone identifier to target for the resource.
    hold_after str
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    include_subdomains bool
    Whether to extend to block any subdomain of the given zone.
    hold Boolean
    Enablement status of the zone hold.
    zoneId String
    The zone identifier to target for the resource.
    holdAfter String
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    includeSubdomains Boolean
    Whether to extend to block any subdomain of the given zone.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ZoneHold 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 ZoneHold Resource

    Get an existing ZoneHold 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?: ZoneHoldState, opts?: CustomResourceOptions): ZoneHold
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            hold: Optional[bool] = None,
            hold_after: Optional[str] = None,
            include_subdomains: Optional[bool] = None,
            zone_id: Optional[str] = None) -> ZoneHold
    func GetZoneHold(ctx *Context, name string, id IDInput, state *ZoneHoldState, opts ...ResourceOption) (*ZoneHold, error)
    public static ZoneHold Get(string name, Input<string> id, ZoneHoldState? state, CustomResourceOptions? opts = null)
    public static ZoneHold get(String name, Output<String> id, ZoneHoldState 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:
    Hold bool
    Enablement status of the zone hold.
    HoldAfter string
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    IncludeSubdomains bool
    Whether to extend to block any subdomain of the given zone.
    ZoneId string
    The zone identifier to target for the resource.
    Hold bool
    Enablement status of the zone hold.
    HoldAfter string
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    IncludeSubdomains bool
    Whether to extend to block any subdomain of the given zone.
    ZoneId string
    The zone identifier to target for the resource.
    hold Boolean
    Enablement status of the zone hold.
    holdAfter String
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    includeSubdomains Boolean
    Whether to extend to block any subdomain of the given zone.
    zoneId String
    The zone identifier to target for the resource.
    hold boolean
    Enablement status of the zone hold.
    holdAfter string
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    includeSubdomains boolean
    Whether to extend to block any subdomain of the given zone.
    zoneId string
    The zone identifier to target for the resource.
    hold bool
    Enablement status of the zone hold.
    hold_after str
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    include_subdomains bool
    Whether to extend to block any subdomain of the given zone.
    zone_id str
    The zone identifier to target for the resource.
    hold Boolean
    Enablement status of the zone hold.
    holdAfter String
    The RFC3339 compatible timestamp when to automatically re-enable the zone hold.
    includeSubdomains Boolean
    Whether to extend to block any subdomain of the given zone.
    zoneId String
    The zone identifier to target for the resource.

    Import

    $ pulumi import cloudflare:index/zoneHold:ZoneHold 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