Class Zone

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.

Example Usage

using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

class MyStack : Stack
{
public MyStack()
{
    var example = new Cloudflare.Zone("example", new Cloudflare.ZoneArgs
    {
        Zone = "example.com",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Zone

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Cloudflare

Assembly: Pulumi.Cloudflare.dll

Syntax

public class Zone : CustomResource

Constructors

Zone(String, ZoneArgs, CustomResourceOptions)

Create a Zone resource with the given unique name, arguments, and options.

Declaration

public Zone(string name, ZoneArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ZoneArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

JumpStart

Boolean of whether to scan for DNS records on creation. Ignored after zone is created. Default: false.

Declaration

public Output<bool?> JumpStart { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Meta

Declaration

public Output<ZoneMeta> Meta { get; }

Property Value

Type	Description
Output<ZoneMeta>

NameServers

Cloudflare-assigned name servers. This is only populated for zones that use Cloudflare DNS.

Declaration

public Output<ImmutableArray<string>> NameServers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Paused

Boolean of whether this zone is paused (traffic bypasses Cloudflare). Default: false.

Declaration

public Output<bool?> Paused { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Plan

The name of the commercial plan to apply to the zone, can be updated once the one is created; one of free, pro, business, enterprise.

Declaration

public Output<string> Plan { get; }

Property Value

Type	Description
Output<System.String>

Status

Status of the zone. Valid values: active, pending, initializing, moved, deleted, deactivated.

Declaration

public Output<string> Status { get; }

Property Value

Type	Description
Output<System.String>

Type

A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. Valid values: full, partial. Default is full.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

VanityNameServers

List of Vanity Nameservers (if set).

• meta.wildcard_proxiable - Indicates whether wildcard DNS records can receive Cloudflare security and performance features.
• meta.phishing_detected - Indicates if URLs on the zone have been identified as hosting phishing content.

Declaration

public Output<ImmutableArray<string>> VanityNameServers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

VerificationKey

Contains the TXT record value to validate domain ownership. This is only populated for zones of type partial.

Declaration

public Output<string> VerificationKey { get; }

Property Value

Type	Description
Output<System.String>

ZoneName

The DNS zone name which will be added.

Declaration

public Output<string> ZoneName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ZoneState, CustomResourceOptions)

Get an existing Zone resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Zone Get(string name, Input<string> id, ZoneState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ZoneState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Zone