1. Docs
  2. Reference
  3. API
  4. ns1
  5. Zone

Zone

Create a Zone Resource

new Zone(name: string, args: ZoneArgs, opts?: CustomResourceOptions);
def Zone(resource_name, opts=None, additional_primaries=None, autogenerate_ns_record=None, dnssec=None, expiry=None, link=None, networks=None, nx_ttl=None, primary=None, refresh=None, retry=None, secondaries=None, ttl=None, zone=None, __props__=None);
func NewZone(ctx *Context, name string, args ZoneArgs, opts ...ResourceOption) (*Zone, error)
public Zone(string name, ZoneArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ZoneArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ZoneArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ZoneArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Zone Resource Properties

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

Inputs

The Zone resource accepts the following input properties:

ZoneName string

The domain name of the zone.

AdditionalPrimaries List<string>

List of additional IPv4 addresses for the primary zone. Conflicts with secondaries.

AutogenerateNsRecord bool
Dnssec bool

Whether or not DNSSEC is enabled for the zone. Note that DNSSEC must be enabled on the account by support for this to be set to true.

Expiry int

The SOA Expiry. Conflicts with primary and additional_primaries (default must be accepted).

Link string

The target zone(domain name) to link to.

Networks List<int>
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
NxTtl int

The SOA NX TTL. Conflicts with primary and additional_primaries (default must be accepted).

Primary string

The primary zones’ IPv4 address. This makes the zone a secondary. Conflicts with secondaries.

Refresh int

The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).

Retry int

The SOA Retry. Conflicts with primary and additional_primaries (default must be accepted).

Secondaries List<ZoneSecondaryArgs>

List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.

Ttl int

The SOA TTL.

Zone string

The domain name of the zone.

AdditionalPrimaries []string

List of additional IPv4 addresses for the primary zone. Conflicts with secondaries.

AutogenerateNsRecord bool
Dnssec bool

Whether or not DNSSEC is enabled for the zone. Note that DNSSEC must be enabled on the account by support for this to be set to true.

Expiry int

The SOA Expiry. Conflicts with primary and additional_primaries (default must be accepted).

Link string

The target zone(domain name) to link to.

Networks []int
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
NxTtl int

The SOA NX TTL. Conflicts with primary and additional_primaries (default must be accepted).

Primary string

The primary zones’ IPv4 address. This makes the zone a secondary. Conflicts with secondaries.

Refresh int

The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).

Retry int

The SOA Retry. Conflicts with primary and additional_primaries (default must be accepted).

Secondaries []ZoneSecondary

List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.

Ttl int

The SOA TTL.

zone string

The domain name of the zone.

additionalPrimaries string[]

List of additional IPv4 addresses for the primary zone. Conflicts with secondaries.

autogenerateNsRecord boolean
dnssec boolean

Whether or not DNSSEC is enabled for the zone. Note that DNSSEC must be enabled on the account by support for this to be set to true.

expiry number

The SOA Expiry. Conflicts with primary and additional_primaries (default must be accepted).

link string

The target zone(domain name) to link to.

networks number[]
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
nxTtl number

The SOA NX TTL. Conflicts with primary and additional_primaries (default must be accepted).

primary string

The primary zones’ IPv4 address. This makes the zone a secondary. Conflicts with secondaries.

refresh number

The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).

retry number

The SOA Retry. Conflicts with primary and additional_primaries (default must be accepted).

secondaries ZoneSecondary[]

List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.

ttl number

The SOA TTL.

zone str

The domain name of the zone.

additional_primaries List[str]

List of additional IPv4 addresses for the primary zone. Conflicts with secondaries.

autogenerate_ns_record bool
dnssec bool

Whether or not DNSSEC is enabled for the zone. Note that DNSSEC must be enabled on the account by support for this to be set to true.

expiry float

The SOA Expiry. Conflicts with primary and additional_primaries (default must be accepted).

link str

The target zone(domain name) to link to.

networks List[Integer]
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
nx_ttl float

The SOA NX TTL. Conflicts with primary and additional_primaries (default must be accepted).

primary str

The primary zones’ IPv4 address. This makes the zone a secondary. Conflicts with secondaries.

refresh float

The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).

retry float

The SOA Retry. Conflicts with primary and additional_primaries (default must be accepted).

secondaries List[ZoneSecondary]

List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.

ttl float

The SOA TTL.

Outputs

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

DnsServers string

(Computed) Authoritative Name Servers.

Hostmaster string

(Computed) The SOA Hostmaster.

Id string
The provider-assigned unique ID for this managed resource.
DnsServers string

(Computed) Authoritative Name Servers.

Hostmaster string

(Computed) The SOA Hostmaster.

Id string
The provider-assigned unique ID for this managed resource.
dnsServers string

(Computed) Authoritative Name Servers.

hostmaster string

(Computed) The SOA Hostmaster.

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

(Computed) Authoritative Name Servers.

hostmaster str

(Computed) The SOA Hostmaster.

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

Look up an Existing Zone Resource

Get an existing Zone 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?: ZoneState, opts?: CustomResourceOptions): Zone
static get(resource_name, id, opts=None, additional_primaries=None, autogenerate_ns_record=None, dns_servers=None, dnssec=None, expiry=None, hostmaster=None, link=None, networks=None, nx_ttl=None, primary=None, refresh=None, retry=None, secondaries=None, ttl=None, zone=None, __props__=None);
func GetZone(ctx *Context, name string, id IDInput, state *ZoneState, opts ...ResourceOption) (*Zone, error)
public static Zone Get(string name, Input<string> id, ZoneState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

AdditionalPrimaries List<string>

List of additional IPv4 addresses for the primary zone. Conflicts with secondaries.

AutogenerateNsRecord bool
DnsServers string

(Computed) Authoritative Name Servers.

Dnssec bool

Whether or not DNSSEC is enabled for the zone. Note that DNSSEC must be enabled on the account by support for this to be set to true.

Expiry int

The SOA Expiry. Conflicts with primary and additional_primaries (default must be accepted).

Hostmaster string

(Computed) The SOA Hostmaster.

Link string

The target zone(domain name) to link to.

Networks List<int>
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
NxTtl int

The SOA NX TTL. Conflicts with primary and additional_primaries (default must be accepted).

Primary string

The primary zones’ IPv4 address. This makes the zone a secondary. Conflicts with secondaries.

Refresh int

The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).

Retry int

The SOA Retry. Conflicts with primary and additional_primaries (default must be accepted).

Secondaries List<ZoneSecondaryArgs>

List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.

Ttl int

The SOA TTL.

ZoneName string

The domain name of the zone.

AdditionalPrimaries []string

List of additional IPv4 addresses for the primary zone. Conflicts with secondaries.

AutogenerateNsRecord bool
DnsServers string

(Computed) Authoritative Name Servers.

Dnssec bool

Whether or not DNSSEC is enabled for the zone. Note that DNSSEC must be enabled on the account by support for this to be set to true.

Expiry int

The SOA Expiry. Conflicts with primary and additional_primaries (default must be accepted).

Hostmaster string

(Computed) The SOA Hostmaster.

Link string

The target zone(domain name) to link to.

Networks []int
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
NxTtl int

The SOA NX TTL. Conflicts with primary and additional_primaries (default must be accepted).

Primary string

The primary zones’ IPv4 address. This makes the zone a secondary. Conflicts with secondaries.

Refresh int

The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).

Retry int

The SOA Retry. Conflicts with primary and additional_primaries (default must be accepted).

Secondaries []ZoneSecondary

List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.

Ttl int

The SOA TTL.

Zone string

The domain name of the zone.

additionalPrimaries string[]

List of additional IPv4 addresses for the primary zone. Conflicts with secondaries.

autogenerateNsRecord boolean
dnsServers string

(Computed) Authoritative Name Servers.

dnssec boolean

Whether or not DNSSEC is enabled for the zone. Note that DNSSEC must be enabled on the account by support for this to be set to true.

expiry number

The SOA Expiry. Conflicts with primary and additional_primaries (default must be accepted).

hostmaster string

(Computed) The SOA Hostmaster.

link string

The target zone(domain name) to link to.

networks number[]
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
nxTtl number

The SOA NX TTL. Conflicts with primary and additional_primaries (default must be accepted).

primary string

The primary zones’ IPv4 address. This makes the zone a secondary. Conflicts with secondaries.

refresh number

The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).

retry number

The SOA Retry. Conflicts with primary and additional_primaries (default must be accepted).

secondaries ZoneSecondary[]

List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.

ttl number

The SOA TTL.

zone string

The domain name of the zone.

additional_primaries List[str]

List of additional IPv4 addresses for the primary zone. Conflicts with secondaries.

autogenerate_ns_record bool
dns_servers str

(Computed) Authoritative Name Servers.

dnssec bool

Whether or not DNSSEC is enabled for the zone. Note that DNSSEC must be enabled on the account by support for this to be set to true.

expiry float

The SOA Expiry. Conflicts with primary and additional_primaries (default must be accepted).

hostmaster str

(Computed) The SOA Hostmaster.

link str

The target zone(domain name) to link to.

networks List[Integer]
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
nx_ttl float

The SOA NX TTL. Conflicts with primary and additional_primaries (default must be accepted).

primary str

The primary zones’ IPv4 address. This makes the zone a secondary. Conflicts with secondaries.

refresh float

The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).

retry float

The SOA Retry. Conflicts with primary and additional_primaries (default must be accepted).

secondaries List[ZoneSecondary]

List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.

ttl float

The SOA TTL.

zone str

The domain name of the zone.

Supporting Types

ZoneSecondary

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Ip string

IPv4 address of the secondary server.

Networks List<int>
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
Notify bool

Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.

Port int

Port of the the secondary server. Default 53.

Ip string

IPv4 address of the secondary server.

Networks []int
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
Notify bool

Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.

Port int

Port of the the secondary server. Default 53.

ip string

IPv4 address of the secondary server.

networks number[]
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
notify boolean

Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.

port number

Port of the the secondary server. Default 53.

ip str

IPv4 address of the secondary server.

networks List[Integer]
  • List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
notify bool

Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.

port float

Port of the the secondary server. Default 53.

Package Details

Repository
https://github.com/pulumi/pulumi-ns1
License
Apache-2.0
Notes
This Pulumi package is based on the ns1 Terraform Provider.