pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin/ZoneArgs

ZoneArgs

data class ZoneArgs(val accountId: Output<String>? = null, val jumpStart: Output<Boolean>? = null, val paused: Output<Boolean>? = null, val plan: Output<String>? = null, val type: Output<String>? = null, val vanityNameServers: Output<List<String>>? = null, val zone: Output<String>? = null) : ConvertibleToJava<ZoneArgs>

Provides a Cloudflare Zone resource. Zone is the basic resource for working with Cloudflare and is roughly equivalent to a domain name that the user purchases.

If you are attempting to sign up a subdomain of a zone you must first have Subdomain Support entitlement for your account.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const example = new cloudflare.Zone("example", {
    accountId: "f037e56e89293a057740de681ac9abbe",
    zone: "example.com",
});
Content copied to clipboard
import pulumi
import pulumi_cloudflare as cloudflare
example = cloudflare.Zone("example",
    account_id="f037e56e89293a057740de681ac9abbe",
    zone="example.com")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
    var example = new Cloudflare.Zone("example", new()
    {
        AccountId = "f037e56e89293a057740de681ac9abbe",
        ZoneName = "example.com",
    });
});
Content copied to clipboard
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.NewZone(ctx, "example", &cloudflare.ZoneArgs{
			AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
			Zone:      pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.Zone;
import com.pulumi.cloudflare.ZoneArgs;
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 Zone("example", ZoneArgs.builder()
            .accountId("f037e56e89293a057740de681ac9abbe")
            .zone("example.com")
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: cloudflare:Zone
    properties:
      accountId: f037e56e89293a057740de681ac9abbe
      zone: example.com
Content copied to clipboard

Import

$ pulumi import cloudflare:index/zone:Zone example <zone_id>
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(accountId: Output<String>? = null, jumpStart: Output<Boolean>? = null, paused: Output<Boolean>? = null, plan: Output<String>? = null, type: Output<String>? = null, vanityNameServers: Output<List<String>>? = null, zone: Output<String>? = null)

Properties

Link copied to clipboard
val accountId: Output<String>? = null

Account ID to manage the zone resource in.

Link copied to clipboard
val jumpStart: Output<Boolean>? = null

Whether to scan for DNS records on creation. Ignored after zone is created.

Link copied to clipboard
val paused: Output<Boolean>? = null

Whether this zone is paused (traffic bypasses Cloudflare). Defaults to false.

Link copied to clipboard
val plan: Output<String>? = null

The name of the commercial plan to apply to the zone. Available values: free, lite, pro, pro_plus, business, enterprise, partners_free, partners_pro, partners_business, partners_enterprise.

Link copied to clipboard
val type: Output<String>? = null

A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. Available values: full, partial, secondary. Defaults to full.

Link copied to clipboard
val vanityNameServers: Output<List<String>>? = null

List of Vanity Nameservers (if set).

Link copied to clipboard
val zone: Output<String>? = null

The DNS zone name which will be added. Modifying this attribute will force creation of a new resource.

Functions

Link copied to clipboard
open override fun toJava(): ZoneArgs