Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ns1 Provider
  3. API Docs
  4. Zone
NS1 v3.4.6 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-ns1

ns1.Zone

Explore with Pulumi AI

ns1 logo
NS1 v3.4.6 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-ns1

    Import

    $ pulumi import ns1:index/zone:Zone <name> <zone>`

    So for the example above:

    $ pulumi import ns1:index/zone:Zone example terraform.example.io`

    Create Zone Resource

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

    Constructor syntax

    new Zone(name: string, args: ZoneArgs, opts?: CustomResourceOptions);
    @overload
def Zone(resource_name: str,
         args: ZoneArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Zone(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         zone: Optional[str] = None,
         nx_ttl: Optional[int] = None,
         hostmaster: Optional[str] = None,
         primary: Optional[str] = None,
         expiry: Optional[int] = None,
         primary_port: Optional[int] = None,
         link: Optional[str] = None,
         networks: Optional[Sequence[int]] = None,
         refresh: Optional[int] = None,
         dnssec: Optional[bool] = None,
         autogenerate_ns_record: Optional[bool] = None,
         additional_ports: Optional[Sequence[int]] = None,
         retry: Optional[int] = None,
         secondaries: Optional[Sequence[ZoneSecondaryArgs]] = None,
         tags: Optional[Mapping[str, str]] = None,
         tsig: Optional[Mapping[str, str]] = None,
         ttl: Optional[int] = None,
         additional_primaries: Optional[Sequence[str]] = None)
    func NewZone(ctx *Context, name string, args ZoneArgs, opts ...ResourceOption) (*Zone, error)
    public Zone(string name, ZoneArgs args, CustomResourceOptions? opts = null)
    public Zone(String name, ZoneArgs args)
public Zone(String name, ZoneArgs args, CustomResourceOptions options)

    type: ns1:Zone
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 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.
    args ZoneArgs
    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 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.
    name String
    The unique name of the resource.
    args ZoneArgs
    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 zoneResource = new Ns1.Zone("zoneResource", new()
{
    ZoneName = "string",
    NxTtl = 0,
    Hostmaster = "string",
    Primary = "string",
    Expiry = 0,
    PrimaryPort = 0,
    Link = "string",
    Networks = new[]
    {
        0,
    },
    Refresh = 0,
    Dnssec = false,
    AutogenerateNsRecord = false,
    AdditionalPorts = new[]
    {
        0,
    },
    Retry = 0,
    Secondaries = new[]
    {
        new Ns1.Inputs.ZoneSecondaryArgs
        {
            Ip = "string",
            Networks = new[]
            {
                0,
            },
            Notify = false,
            Port = 0,
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    Tsig = 
    {
        { "string", "string" },
    },
    Ttl = 0,
    AdditionalPrimaries = new[]
    {
        "string",
    },
});

    example, err := ns1.NewZone(ctx, "zoneResource", &ns1.ZoneArgs{
	Zone:        pulumi.String("string"),
	NxTtl:       pulumi.Int(0),
	Hostmaster:  pulumi.String("string"),
	Primary:     pulumi.String("string"),
	Expiry:      pulumi.Int(0),
	PrimaryPort: pulumi.Int(0),
	Link:        pulumi.String("string"),
	Networks: pulumi.IntArray{
		pulumi.Int(0),
	},
	Refresh:              pulumi.Int(0),
	Dnssec:               pulumi.Bool(false),
	AutogenerateNsRecord: pulumi.Bool(false),
	AdditionalPorts: pulumi.IntArray{
		pulumi.Int(0),
	},
	Retry: pulumi.Int(0),
	Secondaries: ns1.ZoneSecondaryArray{
		&ns1.ZoneSecondaryArgs{
			Ip: pulumi.String("string"),
			Networks: pulumi.IntArray{
				pulumi.Int(0),
			},
			Notify: pulumi.Bool(false),
			Port:   pulumi.Int(0),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tsig: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Ttl: pulumi.Int(0),
	AdditionalPrimaries: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var zoneResource = new Zone("zoneResource", ZoneArgs.builder()
    .zone("string")
    .nxTtl(0)
    .hostmaster("string")
    .primary("string")
    .expiry(0)
    .primaryPort(0)
    .link("string")
    .networks(0)
    .refresh(0)
    .dnssec(false)
    .autogenerateNsRecord(false)
    .additionalPorts(0)
    .retry(0)
    .secondaries(ZoneSecondaryArgs.builder()
        .ip("string")
        .networks(0)
        .notify(false)
        .port(0)
        .build())
    .tags(Map.of("string", "string"))
    .tsig(Map.of("string", "string"))
    .ttl(0)
    .additionalPrimaries("string")
    .build());

    zone_resource = ns1.Zone("zoneResource",
    zone="string",
    nx_ttl=0,
    hostmaster="string",
    primary="string",
    expiry=0,
    primary_port=0,
    link="string",
    networks=[0],
    refresh=0,
    dnssec=False,
    autogenerate_ns_record=False,
    additional_ports=[0],
    retry=0,
    secondaries=[{
        "ip": "string",
        "networks": [0],
        "notify": False,
        "port": 0,
    }],
    tags={
        "string": "string",
    },
    tsig={
        "string": "string",
    },
    ttl=0,
    additional_primaries=["string"])

    const zoneResource = new ns1.Zone("zoneResource", {
    zone: "string",
    nxTtl: 0,
    hostmaster: "string",
    primary: "string",
    expiry: 0,
    primaryPort: 0,
    link: "string",
    networks: [0],
    refresh: 0,
    dnssec: false,
    autogenerateNsRecord: false,
    additionalPorts: [0],
    retry: 0,
    secondaries: [{
        ip: "string",
        networks: [0],
        notify: false,
        port: 0,
    }],
    tags: {
        string: "string",
    },
    tsig: {
        string: "string",
    },
    ttl: 0,
    additionalPrimaries: ["string"],
});

    type: ns1:Zone
properties:
    additionalPorts:
        - 0
    additionalPrimaries:
        - string
    autogenerateNsRecord: false
    dnssec: false
    expiry: 0
    hostmaster: string
    link: string
    networks:
        - 0
    nxTtl: 0
    primary: string
    primaryPort: 0
    refresh: 0
    retry: 0
    secondaries:
        - ip: string
          networks:
            - 0
          notify: false
          port: 0
    tags:
        string: string
    tsig:
        string: string
    ttl: 0
    zone: string

    Zone Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Zone resource accepts the following input properties:

    ZoneName string
    The domain name of the zone.
    AdditionalPorts List<int>
    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).
    Hostmaster string
    (Computed) The SOA Hostmaster.
    Link string
    The target zone(domain name) to link to.
    Networks List<int>
    List of network IDs for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    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.
    PrimaryPort int
    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<ZoneSecondary>
    List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.
    Tags Dictionary<string, string>
    map of tags in the form of "key" = "value" where both key and value are strings
    Tsig Dictionary<string, string>
    TSIG is documented below
    Ttl int
    The SOA TTL.
    Zone string
    The domain name of the zone.
    AdditionalPorts []int
    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).
    Hostmaster string
    (Computed) The SOA Hostmaster.
    Link string
    The target zone(domain name) to link to.
    Networks []int
    List of network IDs for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    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.
    PrimaryPort int
    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 []ZoneSecondaryArgs
    List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.
    Tags map[string]string
    map of tags in the form of "key" = "value" where both key and value are strings
    Tsig map[string]string
    TSIG is documented below
    Ttl int
    The SOA TTL.
    zone String
    The domain name of the zone.
    additionalPorts List<Integer>
    additionalPrimaries List<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 Integer
    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<Integer>
    List of network IDs for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    nxTtl Integer
    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.
    primaryPort Integer
    refresh Integer
    The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).
    retry Integer
    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.
    tags Map<String,String>
    map of tags in the form of "key" = "value" where both key and value are strings
    tsig Map<String,String>
    TSIG is documented below
    ttl Integer
    The SOA TTL.
    zone string
    The domain name of the zone.
    additionalPorts number[]
    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).
    hostmaster string
    (Computed) The SOA Hostmaster.
    link string
    The target zone(domain name) to link to.
    networks number[]
    List of network IDs for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    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.
    primaryPort number
    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.
    tags {[key: string]: string}
    map of tags in the form of "key" = "value" where both key and value are strings
    tsig {[key: string]: string}
    TSIG is documented below
    ttl number
    The SOA TTL.
    zone str
    The domain name of the zone.
    additional_ports Sequence[int]
    additional_primaries Sequence[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 int
    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 Sequence[int]
    List of network IDs for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    nx_ttl int
    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.
    primary_port int
    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 Sequence[ZoneSecondaryArgs]
    List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.
    tags Mapping[str, str]
    map of tags in the form of "key" = "value" where both key and value are strings
    tsig Mapping[str, str]
    TSIG is documented below
    ttl int
    The SOA TTL.
    zone String
    The domain name of the zone.
    additionalPorts List<Number>
    additionalPrimaries List<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).
    hostmaster String
    (Computed) The SOA Hostmaster.
    link String
    The target zone(domain name) to link to.
    networks List<Number>
    List of network IDs for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    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.
    primaryPort Number
    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 List<Property Map>
    List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.
    tags Map<String>
    map of tags in the form of "key" = "value" where both key and value are strings
    tsig Map<String>
    TSIG is documented below
    ttl Number
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    DnsServers string
    (Computed) Authoritative Name Servers.
    Id string
    The provider-assigned unique ID for this managed resource.
    dnsServers String
    (Computed) Authoritative Name Servers.
    id String
    The provider-assigned unique ID for this managed resource.
    dnsServers string
    (Computed) Authoritative Name Servers.
    id string
    The provider-assigned unique ID for this managed resource.
    dns_servers str
    (Computed) Authoritative Name Servers.
    id str
    The provider-assigned unique ID for this managed resource.
    dnsServers String
    (Computed) Authoritative Name Servers.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_ports: Optional[Sequence[int]] = None,
        additional_primaries: Optional[Sequence[str]] = None,
        autogenerate_ns_record: Optional[bool] = None,
        dns_servers: Optional[str] = None,
        dnssec: Optional[bool] = None,
        expiry: Optional[int] = None,
        hostmaster: Optional[str] = None,
        link: Optional[str] = None,
        networks: Optional[Sequence[int]] = None,
        nx_ttl: Optional[int] = None,
        primary: Optional[str] = None,
        primary_port: Optional[int] = None,
        refresh: Optional[int] = None,
        retry: Optional[int] = None,
        secondaries: Optional[Sequence[ZoneSecondaryArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tsig: Optional[Mapping[str, str]] = None,
        ttl: Optional[int] = None,
        zone: Optional[str] = None) -> Zone
    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)
    public static Zone get(String name, Output<String> id, ZoneState 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:
    AdditionalPorts List<int>
    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 for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    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.
    PrimaryPort int
    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<ZoneSecondary>
    List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.
    Tags Dictionary<string, string>
    map of tags in the form of "key" = "value" where both key and value are strings
    Tsig Dictionary<string, string>
    TSIG is documented below
    Ttl int
    The SOA TTL.
    ZoneName string
    The domain name of the zone.
    AdditionalPorts []int
    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 for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    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.
    PrimaryPort int
    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 []ZoneSecondaryArgs
    List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.
    Tags map[string]string
    map of tags in the form of "key" = "value" where both key and value are strings
    Tsig map[string]string
    TSIG is documented below
    Ttl int
    The SOA TTL.
    Zone string
    The domain name of the zone.
    additionalPorts List<Integer>
    additionalPrimaries List<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 Integer
    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<Integer>
    List of network IDs for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    nxTtl Integer
    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.
    primaryPort Integer
    refresh Integer
    The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).
    retry Integer
    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.
    tags Map<String,String>
    map of tags in the form of "key" = "value" where both key and value are strings
    tsig Map<String,String>
    TSIG is documented below
    ttl Integer
    The SOA TTL.
    zone String
    The domain name of the zone.
    additionalPorts number[]
    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 for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    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.
    primaryPort number
    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.
    tags {[key: string]: string}
    map of tags in the form of "key" = "value" where both key and value are strings
    tsig {[key: string]: string}
    TSIG is documented below
    ttl number
    The SOA TTL.
    zone string
    The domain name of the zone.
    additional_ports Sequence[int]
    additional_primaries Sequence[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 int
    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 Sequence[int]
    List of network IDs for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    nx_ttl int
    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.
    primary_port int
    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 Sequence[ZoneSecondaryArgs]
    List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.
    tags Mapping[str, str]
    map of tags in the form of "key" = "value" where both key and value are strings
    tsig Mapping[str, str]
    TSIG is documented below
    ttl int
    The SOA TTL.
    zone str
    The domain name of the zone.
    additionalPorts List<Number>
    additionalPrimaries List<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 List<Number>
    List of network IDs for which the zone is available. If no network is provided, the zone will be created in network 0, the primary NS1 Global Network.
    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.
    primaryPort Number
    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 List<Property Map>
    List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.
    tags Map<String>
    map of tags in the form of "key" = "value" where both key and value are strings
    tsig Map<String>
    TSIG is documented below
    ttl Number
    The SOA TTL.
    zone String
    The domain name of the zone.

    Supporting Types

    ZoneSecondary, ZoneSecondaryArgs

    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 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_ Boolean
    Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.
    port Integer
    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 Sequence[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 List<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.

    Package Details

    Repository
    NS1 pulumi/pulumi-ns1
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ns1 Terraform Provider.
    ns1 logo
    NS1 v3.4.6 published on Friday, Oct 18, 2024 by Pulumi
    pulumi/pulumi-ns1