1. Docs
2. Reference
3. API
4. @pulumi/ns1

Package @pulumi/ns1

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-ns1 repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-ns1 repo.

var ns1 = require("@pulumi/ns1");

import * as ns1 from "@pulumi/ns1";

Modules

• config
• types

Resources

• APIKey
• DataFeed
• DataSource
• MonitoringJob
• NotifyList
• Provider
• Record
• Team
• User
• Zone

Functions

• getDNSSec
• getZone

Others

• APIKeyArgs
• APIKeyState
• DataFeedArgs
• DataFeedState
• DataSourceArgs
• DataSourceState
• GetDNSSecArgs
• GetDNSSecResult
• getEnv
• getEnvBoolean
• getEnvNumber
• getVersion
• GetZoneArgs
• GetZoneResult
• MonitoringJobArgs
• MonitoringJobState
• NotifyListArgs
• NotifyListState
• ProviderArgs
• RecordArgs
• RecordState
• TeamArgs
• TeamState
• UserArgs
• UserState
• ZoneArgs
• ZoneState

Resources

Resource APIKey

class APIKey extends CustomResource

constructor

new APIKey(name: string, args?: APIKeyArgs, opts?: pulumi.CustomResourceOptions)

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

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: APIKeyState, opts?: pulumi.CustomResourceOptions): APIKey

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is APIKey

Returns true if the given object is an instance of APIKey. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountManageAccountSettings

public accountManageAccountSettings: pulumi.Output<boolean | undefined>;

Whether the apikey can modify account settings.

property accountManageApikeys

public accountManageApikeys: pulumi.Output<boolean | undefined>;

Whether the apikey can modify account apikeys.

property accountManagePaymentMethods

public accountManagePaymentMethods: pulumi.Output<boolean | undefined>;

Whether the apikey can modify account payment methods.

property accountManagePlan

public accountManagePlan: pulumi.Output<boolean | undefined>;

Whether the apikey can modify the account plan.

property accountManageTeams

public accountManageTeams: pulumi.Output<boolean | undefined>;

Whether the apikey can modify other teams in the account.

property accountManageUsers

public accountManageUsers: pulumi.Output<boolean | undefined>;

Whether the apikey can modify account users.

property accountViewActivityLog

public accountViewActivityLog: pulumi.Output<boolean | undefined>;

Whether the apikey can view activity logs.

property accountViewInvoices

public accountViewInvoices: pulumi.Output<boolean | undefined>;

Whether the apikey can view invoices.

property dataManageDatafeeds

public dataManageDatafeeds: pulumi.Output<boolean | undefined>;

Whether the apikey can modify data feeds.

property dataManageDatasources

public dataManageDatasources: pulumi.Output<boolean | undefined>;

Whether the apikey can modify data sources.

property dataPushToDatafeeds

public dataPushToDatafeeds: pulumi.Output<boolean | undefined>;

Whether the apikey can publish to data feeds.

property dhcpManageDhcp

public dhcpManageDhcp: pulumi.Output<boolean | undefined>;

Whether the apikey can manage DHCP. Only relevant for the DDI product.

property dhcpViewDhcp

public dhcpViewDhcp: pulumi.Output<boolean | undefined>;

Whether the apikey can view DHCP. Only relevant for the DDI product.

property dnsManageZones

public dnsManageZones: pulumi.Output<boolean | undefined>;

Whether the apikey can modify the accounts zones.

property dnsViewZones

public dnsViewZones: pulumi.Output<boolean | undefined>;

Whether the apikey can view the accounts zones.

property dnsZonesAllowByDefault

public dnsZonesAllowByDefault: pulumi.Output<boolean | undefined>;

If true, enable the dnsZonesAllow list, otherwise enable the dnsZonesDeny list.

property dnsZonesAllows

public dnsZonesAllows: pulumi.Output<string[] | undefined>;

List of zones that the apikey may access.

property dnsZonesDenies

public dnsZonesDenies: pulumi.Output<string[] | undefined>;

List of zones that the apikey may not access.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipWhitelistStrict

public ipWhitelistStrict: pulumi.Output<boolean | undefined>;

Sets exclusivity on this IP whitelist.

property ipWhitelists

public ipWhitelists: pulumi.Output<string[] | undefined>;

The IP addresses to whitelist for this key.

property ipamManageIpam

public ipamManageIpam: pulumi.Output<boolean | undefined>;

Whether the apikey can manage IPAM. Only relevant for the DDI product.

property ipamViewIpam

public ipamViewIpam: pulumi.Output<boolean | undefined>;

Whether the apikey can view IPAM. Only relevant for the DDI product.

property key

public key: pulumi.Output<string>;

The apikeys authentication token.

property monitoringManageJobs

public monitoringManageJobs: pulumi.Output<boolean | undefined>;

Whether the apikey can modify monitoring jobs.

property monitoringManageLists

public monitoringManageLists: pulumi.Output<boolean | undefined>;

Whether the apikey can modify notification lists.

property monitoringViewJobs

public monitoringViewJobs: pulumi.Output<boolean | undefined>;

Whether the apikey can view monitoring jobs.

property name

public name: pulumi.Output<string>;

The free form name of the apikey.

property securityManageActiveDirectory

public securityManageActiveDirectory: pulumi.Output<boolean | undefined>;

Whether the apikey can manage global active directory. Only relevant for the DDI product.

property securityManageGlobal2fa

public securityManageGlobal2fa: pulumi.Output<boolean | undefined>;

Whether the apikey can manage global two factor authentication.

property teams

public teams: pulumi.Output<string[] | undefined>;

The teams that the apikey belongs to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DataFeed

class DataFeed extends CustomResource

Provides a NS1 Data Feed resource. This can be used to create, modify, and delete data feeds.

NS1 Documentation

Datafeed Api Doc

constructor

new DataFeed(name: string, args: DataFeedArgs, opts?: pulumi.CustomResourceOptions)

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

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DataFeedState, opts?: pulumi.CustomResourceOptions): DataFeed

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DataFeed

Returns true if the given object is an instance of DataFeed. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property config

public config: pulumi.Output<{[key: string]: any} | undefined>;

The feeds configuration matching the specification in feedConfig from /data/sourcetypes.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The free form name of the data feed.

property sourceId

public sourceId: pulumi.Output<string>;

The data source id that this feed is connected to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DataSource

class DataSource extends CustomResource

Provides a NS1 Data Source resource. This can be used to create, modify, and delete data sources.

NS1 Documentation

Datasource Api Doc

constructor

new DataSource(name: string, args: DataSourceArgs, opts?: pulumi.CustomResourceOptions)

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

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DataSourceState, opts?: pulumi.CustomResourceOptions): DataSource

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DataSource

Returns true if the given object is an instance of DataSource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property config

public config: pulumi.Output<{[key: string]: any} | undefined>;

The data source configuration, determined by its type, matching the specification in config from /data/sourcetypes.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The free form name of the data source.

property sourcetype

public sourcetype: pulumi.Output<string>;

The data sources type, listed in API endpoint https://api.nsone.net/v1/data/sourcetypes.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource MonitoringJob

class MonitoringJob extends CustomResource

Provides a NS1 Monitoring Job resource. This can be used to create, modify, and delete monitoring jobs.

NS1 Documentation

MonitoringJob Api Doc

constructor

new MonitoringJob(name: string, args: MonitoringJobArgs, opts?: pulumi.CustomResourceOptions)

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

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MonitoringJobState, opts?: pulumi.CustomResourceOptions): MonitoringJob

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is MonitoringJob

Returns true if the given object is an instance of MonitoringJob. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property active

public active: pulumi.Output<boolean | undefined>;

Indicates if the job is active or temporarily disabled.

property config

public config: pulumi.Output<{[key: string]: any}>;

A configuration dictionary with keys and values depending on the jobs’ type.

property frequency

public frequency: pulumi.Output<number>;

The frequency, in seconds, at which to run the monitoring job in each region.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property jobType

public jobType: pulumi.Output<string>;

The type of monitoring job to be run. See NS1 API docs for supported values.

property name

public name: pulumi.Output<string>;

The free-form display name for the monitoring job.

property notes

public notes: pulumi.Output<string | undefined>;

Freeform notes to be included in any notifications about this job.

property notifyDelay

public notifyDelay: pulumi.Output<number | undefined>;

The time in seconds after a failure to wait before sending a notification.

property notifyFailback

public notifyFailback: pulumi.Output<boolean | undefined>;

If true, a notification is sent when a job returns to an “up” state.

property notifyList

public notifyList: pulumi.Output<string | undefined>;

The id of the notification list to send notifications to.

property notifyRegional

public notifyRegional: pulumi.Output<boolean | undefined>;

If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.

property notifyRepeat

public notifyRepeat: pulumi.Output<number | undefined>;

The time in seconds between repeat notifications of a failed job.

property policy

public policy: pulumi.Output<string | undefined>;

The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.

property rapidRecheck

public rapidRecheck: pulumi.Output<boolean | undefined>;

If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.

property regions

public regions: pulumi.Output<string[]>;

The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.

property rules

public rules: pulumi.Output<MonitoringJobRule[] | undefined>;

A list of rules for determining failure conditions. Job Rules are documented below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NotifyList

class NotifyList extends CustomResource

Provides a NS1 Notify List resource. This can be used to create, modify, and delete notify lists.

NS1 Documentation

NotifyList Api Doc

constructor

new NotifyList(name: string, args?: NotifyListArgs, opts?: pulumi.CustomResourceOptions)

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

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NotifyListState, opts?: pulumi.CustomResourceOptions): NotifyList

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NotifyList

Returns true if the given object is an instance of NotifyList. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The free-form display name for the notify list.

property notifications

public notifications: pulumi.Output<NotifyListNotification[] | undefined>;

A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Provider

class Provider extends ProviderResource

The provider type for the ns1 package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

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

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Record

class Record extends CustomResource

Provides a NS1 Record resource. This can be used to create, modify, and delete records.

NS1 Documentation

Record Api Doc

constructor

new Record(name: string, args: RecordArgs, opts?: pulumi.CustomResourceOptions)

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

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RecordState, opts?: pulumi.CustomResourceOptions): Record

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Record

Returns true if the given object is an instance of Record. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property answers

public answers: pulumi.Output<RecordAnswer[] | undefined>;

One or more NS1 answers for the records’ specified type. Answers are documented below.

property domain

public domain: pulumi.Output<string>;

The records’ domain. Cannot have leading or trailing dots - see the example above and FQDN formatting below.

property filters

public filters: pulumi.Output<RecordFilter[] | undefined>;

One or more NS1 filters for the record(order matters). Filters are documented below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property link

public link: pulumi.Output<string | undefined>;

The target record to link to. This means this record is a ‘linked’ record, and it inherits all properties from its target.

property meta

public meta: pulumi.Output<{[key: string]: any} | undefined>;

property regions

public regions: pulumi.Output<RecordRegion[] | undefined>;

One or more “regions” for the record. These are really just groupings based on metadata, and are called “Answer Groups” in the NS1 UI, but remain regions here for legacy reasons. Regions are documented below. Please note the ordering requirement!

property shortAnswers

public shortAnswers: pulumi.Output<string[] | undefined>;

property ttl

public ttl: pulumi.Output<number>;

The records’ time to live.

property type

public type: pulumi.Output<string>;

The records’ RR type.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property useClientSubnet

public useClientSubnet: pulumi.Output<boolean | undefined>;

Whether to use EDNS client subnet data when available(in filter chain). * meta - (Optional) meta is supported at the record level. Meta is documented below.

property zone

public zone: pulumi.Output<string>;

The zone the record belongs to. Cannot have leading or trailing dots (“.”) - see the example above and FQDN formatting below.

Resource Team

class Team extends CustomResource

Provides a NS1 Team resource. This can be used to create, modify, and delete teams. The credentials used must have the manageTeams permission set.

NS1 Documentation

Team Api Docs

constructor

new Team(name: string, args?: TeamArgs, opts?: pulumi.CustomResourceOptions)

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

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TeamState, opts?: pulumi.CustomResourceOptions): Team

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Team

Returns true if the given object is an instance of Team. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountManageAccountSettings

public accountManageAccountSettings: pulumi.Output<boolean | undefined>;

Whether the team can modify account settings.

property accountManageApikeys

public accountManageApikeys: pulumi.Output<boolean | undefined>;

Whether the team can modify account apikeys.

property accountManagePaymentMethods

public accountManagePaymentMethods: pulumi.Output<boolean | undefined>;

Whether the team can modify account payment methods.

property accountManagePlan

public accountManagePlan: pulumi.Output<boolean | undefined>;

Whether the team can modify the account plan.

property accountManageTeams

public accountManageTeams: pulumi.Output<boolean | undefined>;

Whether the team can modify other teams in the account.

property accountManageUsers

public accountManageUsers: pulumi.Output<boolean | undefined>;

Whether the team can modify account users.

property accountViewActivityLog

public accountViewActivityLog: pulumi.Output<boolean | undefined>;

Whether the team can view activity logs.

property accountViewInvoices

public accountViewInvoices: pulumi.Output<boolean | undefined>;

Whether the team can view invoices.

property dataManageDatafeeds

public dataManageDatafeeds: pulumi.Output<boolean | undefined>;

Whether the team can modify data feeds.

property dataManageDatasources

public dataManageDatasources: pulumi.Output<boolean | undefined>;

Whether the team can modify data sources.

property dataPushToDatafeeds

public dataPushToDatafeeds: pulumi.Output<boolean | undefined>;

Whether the team can publish to data feeds.

property dhcpManageDhcp

public dhcpManageDhcp: pulumi.Output<boolean | undefined>;

Whether the team can manage DHCP. Only relevant for the DDI product.

property dhcpViewDhcp

public dhcpViewDhcp: pulumi.Output<boolean | undefined>;

Whether the team can view DHCP. Only relevant for the DDI product.

property dnsManageZones

public dnsManageZones: pulumi.Output<boolean | undefined>;

Whether the team can modify the accounts zones.

property dnsViewZones

public dnsViewZones: pulumi.Output<boolean | undefined>;

Whether the team can view the accounts zones.

property dnsZonesAllowByDefault

public dnsZonesAllowByDefault: pulumi.Output<boolean | undefined>;

If true, enable the dnsZonesAllow list, otherwise enable the dnsZonesDeny list.

property dnsZonesAllows

public dnsZonesAllows: pulumi.Output<string[] | undefined>;

List of zones that the team may access.

property dnsZonesDenies

public dnsZonesDenies: pulumi.Output<string[] | undefined>;

List of zones that the team may not access.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipWhitelists

public ipWhitelists: pulumi.Output<TeamIpWhitelist[] | undefined>;

The IP addresses to whitelist for this key.

property ipamManageIpam

public ipamManageIpam: pulumi.Output<boolean | undefined>;

Whether the team can manage IPAM. Only relevant for the DDI product.

property ipamViewIpam

public ipamViewIpam: pulumi.Output<boolean | undefined>;

Whether the team can view IPAM. Only relevant for the DDI product.

property monitoringManageJobs

public monitoringManageJobs: pulumi.Output<boolean | undefined>;

Whether the team can modify monitoring jobs.

property monitoringManageLists

public monitoringManageLists: pulumi.Output<boolean | undefined>;

Whether the team can modify notification lists.

property monitoringViewJobs

public monitoringViewJobs: pulumi.Output<boolean | undefined>;

Whether the team can view monitoring jobs.

property name

public name: pulumi.Output<string>;

The free form name of the team.

property securityManageActiveDirectory

public securityManageActiveDirectory: pulumi.Output<boolean | undefined>;

Whether the team can manage global active directory. Only relevant for the DDI product.

property securityManageGlobal2fa

public securityManageGlobal2fa: pulumi.Output<boolean | undefined>;

Whether the team can manage global two factor authentication.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource User

class User extends CustomResource

constructor

new User(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions)

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

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is User

Returns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountManageAccountSettings

public accountManageAccountSettings: pulumi.Output<boolean | undefined>;

Whether the user can modify account settings.

property accountManageApikeys

public accountManageApikeys: pulumi.Output<boolean | undefined>;

Whether the user can modify account apikeys.

property accountManagePaymentMethods

public accountManagePaymentMethods: pulumi.Output<boolean | undefined>;

Whether the user can modify account payment methods.

property accountManagePlan

public accountManagePlan: pulumi.Output<boolean | undefined>;

Whether the user can modify the account plan.

property accountManageTeams

public accountManageTeams: pulumi.Output<boolean | undefined>;

Whether the user can modify other teams in the account.

property accountManageUsers

public accountManageUsers: pulumi.Output<boolean | undefined>;

Whether the user can modify account users.

property accountViewActivityLog

public accountViewActivityLog: pulumi.Output<boolean | undefined>;

Whether the user can view activity logs.

property accountViewInvoices

public accountViewInvoices: pulumi.Output<boolean | undefined>;

Whether the user can view invoices.

property dataManageDatafeeds

public dataManageDatafeeds: pulumi.Output<boolean | undefined>;

Whether the user can modify data feeds.

property dataManageDatasources

public dataManageDatasources: pulumi.Output<boolean | undefined>;

Whether the user can modify data sources.

property dataPushToDatafeeds

public dataPushToDatafeeds: pulumi.Output<boolean | undefined>;

Whether the user can publish to data feeds.

property dhcpManageDhcp

public dhcpManageDhcp: pulumi.Output<boolean | undefined>;

Whether the user can manage DHCP. Only relevant for the DDI product.

property dhcpViewDhcp

public dhcpViewDhcp: pulumi.Output<boolean | undefined>;

Whether the user can view DHCP. Only relevant for the DDI product.

property dnsManageZones

public dnsManageZones: pulumi.Output<boolean | undefined>;

Whether the user can modify the accounts zones.

property dnsViewZones

public dnsViewZones: pulumi.Output<boolean | undefined>;

Whether the user can view the accounts zones.

property dnsZonesAllowByDefault

public dnsZonesAllowByDefault: pulumi.Output<boolean | undefined>;

If true, enable the dnsZonesAllow list, otherwise enable the dnsZonesDeny list.

property dnsZonesAllows

public dnsZonesAllows: pulumi.Output<string[] | undefined>;

List of zones that the user may access.

property dnsZonesDenies

public dnsZonesDenies: pulumi.Output<string[] | undefined>;

List of zones that the user may not access.

property email

public email: pulumi.Output<string>;

The email address of the user.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipWhitelistStrict

public ipWhitelistStrict: pulumi.Output<boolean | undefined>;

Sets exclusivity on this IP whitelist.

property ipWhitelists

public ipWhitelists: pulumi.Output<string[] | undefined>;

The IP addresses to whitelist for this key.

property ipamManageIpam

public ipamManageIpam: pulumi.Output<boolean | undefined>;

Whether the user can manage IPAM. Only relevant for the DDI product.

property ipamViewIpam

public ipamViewIpam: pulumi.Output<boolean | undefined>;

property monitoringManageJobs

public monitoringManageJobs: pulumi.Output<boolean | undefined>;

Whether the user can modify monitoring jobs.

property monitoringManageLists

public monitoringManageLists: pulumi.Output<boolean | undefined>;

Whether the user can modify notification lists.

property monitoringViewJobs

public monitoringViewJobs: pulumi.Output<boolean | undefined>;

Whether the user can view monitoring jobs.

property name

public name: pulumi.Output<string>;

The free form name of the user.

property notify

public notify: pulumi.Output<{[key: string]: any} | undefined>;

Whether or not to notify the user of specified events. Only billing is available currently.

property securityManageActiveDirectory

public securityManageActiveDirectory: pulumi.Output<boolean | undefined>;

Whether the user can manage global active directory. Only relevant for the DDI product.

property securityManageGlobal2fa

public securityManageGlobal2fa: pulumi.Output<boolean | undefined>;

Whether the user can manage global two factor authentication.

property teams

public teams: pulumi.Output<string[] | undefined>;

The teams that the user belongs to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

The users login name.

Resource Zone

class Zone extends CustomResource

constructor

new Zone(name: string, args: ZoneArgs, opts?: pulumi.CustomResourceOptions)

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

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ZoneState, opts?: pulumi.CustomResourceOptions): Zone

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Zone

Returns true if the given object is an instance of Zone. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property additionalPrimaries

public additionalPrimaries: pulumi.Output<string[] | undefined>;

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

property autogenerateNsRecord

public autogenerateNsRecord: pulumi.Output<boolean | undefined>;

property dnsServers

public dnsServers: pulumi.Output<string>;

(Computed) Authoritative Name Servers.

property dnssec

public dnssec: pulumi.Output<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.

property expiry

public expiry: pulumi.Output<number>;

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

property hostmaster

public hostmaster: pulumi.Output<string>;

(Computed) The SOA Hostmaster.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property link

public link: pulumi.Output<string | undefined>;

The target zone(domain name) to link to.

property networks

public networks: pulumi.Output<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.

property nxTtl

public nxTtl: pulumi.Output<number>;

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

property primary

public primary: pulumi.Output<string | undefined>;

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

property refresh

public refresh: pulumi.Output<number>;

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

property retry

public retry: pulumi.Output<number>;

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

property secondaries

public secondaries: pulumi.Output<ZoneSecondary[] | undefined>;

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

property ttl

public ttl: pulumi.Output<number>;

The SOA TTL.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zone

public zone: pulumi.Output<string>;

The domain name of the zone.

Functions

Function getDNSSec

getDNSSec(args: GetDNSSecArgs, opts?: pulumi.InvokeOptions): Promise<GetDNSSecResult>

Provides DNSSEC details about a NS1 Zone.

Function getZone

getZone(args: GetZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetZoneResult>

Provides details about a NS1 Zone. Use this if you would simply like to read information from NS1 into your configurations. For read/write operations, you should use a resource.

Others

interface APIKeyArgs

interface APIKeyArgs

The set of arguments for constructing a APIKey resource.

property accountManageAccountSettings

accountManageAccountSettings?: pulumi.Input<boolean>;

Whether the apikey can modify account settings.

property accountManageApikeys

accountManageApikeys?: pulumi.Input<boolean>;

Whether the apikey can modify account apikeys.

property accountManagePaymentMethods

accountManagePaymentMethods?: pulumi.Input<boolean>;

Whether the apikey can modify account payment methods.

property accountManagePlan

accountManagePlan?: pulumi.Input<boolean>;

Whether the apikey can modify the account plan.

property accountManageTeams

accountManageTeams?: pulumi.Input<boolean>;

Whether the apikey can modify other teams in the account.

property accountManageUsers

accountManageUsers?: pulumi.Input<boolean>;

Whether the apikey can modify account users.

property accountViewActivityLog

accountViewActivityLog?: pulumi.Input<boolean>;

Whether the apikey can view activity logs.

property accountViewInvoices

accountViewInvoices?: pulumi.Input<boolean>;

Whether the apikey can view invoices.

property dataManageDatafeeds

dataManageDatafeeds?: pulumi.Input<boolean>;

Whether the apikey can modify data feeds.

property dataManageDatasources

dataManageDatasources?: pulumi.Input<boolean>;

Whether the apikey can modify data sources.

property dataPushToDatafeeds

dataPushToDatafeeds?: pulumi.Input<boolean>;

Whether the apikey can publish to data feeds.

property dhcpManageDhcp

dhcpManageDhcp?: pulumi.Input<boolean>;

Whether the apikey can manage DHCP. Only relevant for the DDI product.

property dhcpViewDhcp

dhcpViewDhcp?: pulumi.Input<boolean>;

Whether the apikey can view DHCP. Only relevant for the DDI product.

property dnsManageZones

dnsManageZones?: pulumi.Input<boolean>;

Whether the apikey can modify the accounts zones.

property dnsViewZones

dnsViewZones?: pulumi.Input<boolean>;

Whether the apikey can view the accounts zones.

property dnsZonesAllowByDefault

dnsZonesAllowByDefault?: pulumi.Input<boolean>;

If true, enable the dnsZonesAllow list, otherwise enable the dnsZonesDeny list.

property dnsZonesAllows

dnsZonesAllows?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the apikey may access.

property dnsZonesDenies

dnsZonesDenies?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the apikey may not access.

property ipWhitelistStrict

ipWhitelistStrict?: pulumi.Input<boolean>;

Sets exclusivity on this IP whitelist.

property ipWhitelists

ipWhitelists?: pulumi.Input<pulumi.Input<string>[]>;

The IP addresses to whitelist for this key.

property ipamManageIpam

ipamManageIpam?: pulumi.Input<boolean>;

Whether the apikey can manage IPAM. Only relevant for the DDI product.

property ipamViewIpam

ipamViewIpam?: pulumi.Input<boolean>;

Whether the apikey can view IPAM. Only relevant for the DDI product.

property monitoringManageJobs

monitoringManageJobs?: pulumi.Input<boolean>;

Whether the apikey can modify monitoring jobs.

property monitoringManageLists

monitoringManageLists?: pulumi.Input<boolean>;

Whether the apikey can modify notification lists.

property monitoringViewJobs

monitoringViewJobs?: pulumi.Input<boolean>;

Whether the apikey can view monitoring jobs.

property name

name?: pulumi.Input<string>;

The free form name of the apikey.

property securityManageActiveDirectory

securityManageActiveDirectory?: pulumi.Input<boolean>;

Whether the apikey can manage global active directory. Only relevant for the DDI product.

property securityManageGlobal2fa

securityManageGlobal2fa?: pulumi.Input<boolean>;

Whether the apikey can manage global two factor authentication.

property teams

teams?: pulumi.Input<pulumi.Input<string>[]>;

The teams that the apikey belongs to.

interface APIKeyState

interface APIKeyState

Input properties used for looking up and filtering APIKey resources.

property accountManageAccountSettings

accountManageAccountSettings?: pulumi.Input<boolean>;

Whether the apikey can modify account settings.

property accountManageApikeys

accountManageApikeys?: pulumi.Input<boolean>;

Whether the apikey can modify account apikeys.

property accountManagePaymentMethods

accountManagePaymentMethods?: pulumi.Input<boolean>;

Whether the apikey can modify account payment methods.

property accountManagePlan

accountManagePlan?: pulumi.Input<boolean>;

Whether the apikey can modify the account plan.

property accountManageTeams

accountManageTeams?: pulumi.Input<boolean>;

Whether the apikey can modify other teams in the account.

property accountManageUsers

accountManageUsers?: pulumi.Input<boolean>;

Whether the apikey can modify account users.

property accountViewActivityLog

accountViewActivityLog?: pulumi.Input<boolean>;

Whether the apikey can view activity logs.

property accountViewInvoices

accountViewInvoices?: pulumi.Input<boolean>;

Whether the apikey can view invoices.

property dataManageDatafeeds

dataManageDatafeeds?: pulumi.Input<boolean>;

Whether the apikey can modify data feeds.

property dataManageDatasources

dataManageDatasources?: pulumi.Input<boolean>;

Whether the apikey can modify data sources.

property dataPushToDatafeeds

dataPushToDatafeeds?: pulumi.Input<boolean>;

Whether the apikey can publish to data feeds.

property dhcpManageDhcp

dhcpManageDhcp?: pulumi.Input<boolean>;

Whether the apikey can manage DHCP. Only relevant for the DDI product.

property dhcpViewDhcp

dhcpViewDhcp?: pulumi.Input<boolean>;

Whether the apikey can view DHCP. Only relevant for the DDI product.

property dnsManageZones

dnsManageZones?: pulumi.Input<boolean>;

Whether the apikey can modify the accounts zones.

property dnsViewZones

dnsViewZones?: pulumi.Input<boolean>;

Whether the apikey can view the accounts zones.

property dnsZonesAllowByDefault

dnsZonesAllowByDefault?: pulumi.Input<boolean>;

If true, enable the dnsZonesAllow list, otherwise enable the dnsZonesDeny list.

property dnsZonesAllows

dnsZonesAllows?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the apikey may access.

property dnsZonesDenies

dnsZonesDenies?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the apikey may not access.

property ipWhitelistStrict

ipWhitelistStrict?: pulumi.Input<boolean>;

Sets exclusivity on this IP whitelist.

property ipWhitelists

ipWhitelists?: pulumi.Input<pulumi.Input<string>[]>;

The IP addresses to whitelist for this key.

property ipamManageIpam

ipamManageIpam?: pulumi.Input<boolean>;

Whether the apikey can manage IPAM. Only relevant for the DDI product.

property ipamViewIpam

ipamViewIpam?: pulumi.Input<boolean>;

Whether the apikey can view IPAM. Only relevant for the DDI product.

property key

key?: pulumi.Input<string>;

The apikeys authentication token.

property monitoringManageJobs

monitoringManageJobs?: pulumi.Input<boolean>;

Whether the apikey can modify monitoring jobs.

property monitoringManageLists

monitoringManageLists?: pulumi.Input<boolean>;

Whether the apikey can modify notification lists.

property monitoringViewJobs

monitoringViewJobs?: pulumi.Input<boolean>;

Whether the apikey can view monitoring jobs.

property name

name?: pulumi.Input<string>;

The free form name of the apikey.

property securityManageActiveDirectory

securityManageActiveDirectory?: pulumi.Input<boolean>;

Whether the apikey can manage global active directory. Only relevant for the DDI product.

property securityManageGlobal2fa

securityManageGlobal2fa?: pulumi.Input<boolean>;

Whether the apikey can manage global two factor authentication.

property teams

teams?: pulumi.Input<pulumi.Input<string>[]>;

The teams that the apikey belongs to.

interface DataFeedArgs

interface DataFeedArgs

The set of arguments for constructing a DataFeed resource.

property config

config?: pulumi.Input<{[key: string]: any}>;

The feeds configuration matching the specification in feedConfig from /data/sourcetypes.

property name

name?: pulumi.Input<string>;

The free form name of the data feed.

property sourceId

sourceId: pulumi.Input<string>;

The data source id that this feed is connected to.

interface DataFeedState

interface DataFeedState

Input properties used for looking up and filtering DataFeed resources.

property config

config?: pulumi.Input<{[key: string]: any}>;

The feeds configuration matching the specification in feedConfig from /data/sourcetypes.

property name

name?: pulumi.Input<string>;

The free form name of the data feed.

property sourceId

sourceId?: pulumi.Input<string>;

The data source id that this feed is connected to.

interface DataSourceArgs

interface DataSourceArgs

The set of arguments for constructing a DataSource resource.

property config

config?: pulumi.Input<{[key: string]: any}>;

The data source configuration, determined by its type, matching the specification in config from /data/sourcetypes.

property name

name?: pulumi.Input<string>;

The free form name of the data source.

property sourcetype

sourcetype: pulumi.Input<string>;

The data sources type, listed in API endpoint https://api.nsone.net/v1/data/sourcetypes.

interface DataSourceState

interface DataSourceState

Input properties used for looking up and filtering DataSource resources.

property config

config?: pulumi.Input<{[key: string]: any}>;

The data source configuration, determined by its type, matching the specification in config from /data/sourcetypes.

property name

name?: pulumi.Input<string>;

The free form name of the data source.

property sourcetype

sourcetype?: pulumi.Input<string>;

The data sources type, listed in API endpoint https://api.nsone.net/v1/data/sourcetypes.

interface GetDNSSecArgs

interface GetDNSSecArgs

A collection of arguments for invoking getDNSSec.

property zone

zone: string;

The name of the zone to get DNSSEC details for.

interface GetDNSSecResult

interface GetDNSSecResult

A collection of values returned by getDNSSec.

property delegation

delegation: GetDNSSecDelegation;

(Computed) - Delegation field is documented below.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property keys

keys: GetDNSSecKeys;

(Computed) - Keys field is documented below.

property zone

zone: string;

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface GetZoneArgs

interface GetZoneArgs

A collection of arguments for invoking getZone.

property additionalPrimaries

additionalPrimaries?: string[];

List of additional IPv4 addresses for the primary zone.

property zone

zone: string;

The domain name of the zone.

interface GetZoneResult

interface GetZoneResult

A collection of values returned by getZone.

property additionalPrimaries

additionalPrimaries?: string[];

List of additional IPv4 addresses for the primary zone.

property dnsServers

dnsServers: string;

Authoritative Name Servers.

property dnssec

dnssec: boolean;

Whether or not DNSSEC is enabled for the zone.

property expiry

expiry: number;

The SOA Expiry.

property hostmaster

hostmaster: string;

The SOA Hostmaster.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property link

link: string;

The linked target zone.

property networks

networks: number[];

List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network.

property nxTtl

nxTtl: number;

The SOA NX TTL.

property primary

primary: string;

The primary zones’ IPv4 address.

property refresh

refresh: number;

The SOA Refresh.

property retry

retry: number;

The SOA Retry.

property secondaries

secondaries: GetZoneSecondary[];

List of secondary servers. Secondaries is documented below.

property ttl

ttl: number;

The SOA TTL.

property zone

zone: string;

interface MonitoringJobArgs

interface MonitoringJobArgs

The set of arguments for constructing a MonitoringJob resource.

property active

active?: pulumi.Input<boolean>;

Indicates if the job is active or temporarily disabled.

property config

config: pulumi.Input<{[key: string]: any}>;

A configuration dictionary with keys and values depending on the jobs’ type.

property frequency

frequency: pulumi.Input<number>;

The frequency, in seconds, at which to run the monitoring job in each region.

property jobType

jobType: pulumi.Input<string>;

The type of monitoring job to be run. See NS1 API docs for supported values.

property name

name?: pulumi.Input<string>;

The free-form display name for the monitoring job.

property notes

notes?: pulumi.Input<string>;

Freeform notes to be included in any notifications about this job.

property notifyDelay

notifyDelay?: pulumi.Input<number>;

The time in seconds after a failure to wait before sending a notification.

property notifyFailback

notifyFailback?: pulumi.Input<boolean>;

If true, a notification is sent when a job returns to an “up” state.

property notifyList

notifyList?: pulumi.Input<string>;

The id of the notification list to send notifications to.

property notifyRegional

notifyRegional?: pulumi.Input<boolean>;

If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.

property notifyRepeat

notifyRepeat?: pulumi.Input<number>;

The time in seconds between repeat notifications of a failed job.

property policy

policy?: pulumi.Input<string>;

The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.

property rapidRecheck

rapidRecheck?: pulumi.Input<boolean>;

If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.

property regions

regions: pulumi.Input<pulumi.Input<string>[]>;

The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.

property rules

rules?: pulumi.Input<pulumi.Input<MonitoringJobRule>[]>;

A list of rules for determining failure conditions. Job Rules are documented below.

interface MonitoringJobState

interface MonitoringJobState

Input properties used for looking up and filtering MonitoringJob resources.

property active

active?: pulumi.Input<boolean>;

Indicates if the job is active or temporarily disabled.

property config

config?: pulumi.Input<{[key: string]: any}>;

A configuration dictionary with keys and values depending on the jobs’ type.

property frequency

frequency?: pulumi.Input<number>;

The frequency, in seconds, at which to run the monitoring job in each region.

property jobType

jobType?: pulumi.Input<string>;

The type of monitoring job to be run. See NS1 API docs for supported values.

property name

name?: pulumi.Input<string>;

The free-form display name for the monitoring job.

property notes

notes?: pulumi.Input<string>;

Freeform notes to be included in any notifications about this job.

property notifyDelay

notifyDelay?: pulumi.Input<number>;

The time in seconds after a failure to wait before sending a notification.

property notifyFailback

notifyFailback?: pulumi.Input<boolean>;

If true, a notification is sent when a job returns to an “up” state.

property notifyList

notifyList?: pulumi.Input<string>;

The id of the notification list to send notifications to.

property notifyRegional

notifyRegional?: pulumi.Input<boolean>;

If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.

property notifyRepeat

notifyRepeat?: pulumi.Input<number>;

The time in seconds between repeat notifications of a failed job.

property policy

policy?: pulumi.Input<string>;

The policy for determining the monitor’s global status based on the status of the job in all regions. See NS1 API docs for supported values.

property rapidRecheck

rapidRecheck?: pulumi.Input<boolean>;

If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.

property regions

regions?: pulumi.Input<pulumi.Input<string>[]>;

The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.

property rules

rules?: pulumi.Input<pulumi.Input<MonitoringJobRule>[]>;

A list of rules for determining failure conditions. Job Rules are documented below.

interface NotifyListArgs

interface NotifyListArgs

The set of arguments for constructing a NotifyList resource.

property name

name?: pulumi.Input<string>;

The free-form display name for the notify list.

property notifications

notifications?: pulumi.Input<pulumi.Input<NotifyListNotification>[]>;

A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.

interface NotifyListState

interface NotifyListState

Input properties used for looking up and filtering NotifyList resources.

property name

name?: pulumi.Input<string>;

The free-form display name for the notify list.

property notifications

notifications?: pulumi.Input<pulumi.Input<NotifyListNotification>[]>;

A list of notifiers. All notifiers in a notification list will receive notifications whenever an event is send to the list (e.g., when a monitoring job fails). Notifiers are documented below.

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property apikey

apikey?: pulumi.Input<string>;

The ns1 API key, this is required

property enableDdi

enableDdi?: pulumi.Input<boolean>;

property endpoint

endpoint?: pulumi.Input<string>;

property ignoreSsl

ignoreSsl?: pulumi.Input<boolean>;

property rateLimitParallelism

rateLimitParallelism?: pulumi.Input<number>;

interface RecordArgs

interface RecordArgs

The set of arguments for constructing a Record resource.

property answers

answers?: pulumi.Input<pulumi.Input<RecordAnswer>[]>;

One or more NS1 answers for the records’ specified type. Answers are documented below.

property domain

domain: pulumi.Input<string>;

The records’ domain. Cannot have leading or trailing dots - see the example above and FQDN formatting below.

property filters

filters?: pulumi.Input<pulumi.Input<RecordFilter>[]>;

One or more NS1 filters for the record(order matters). Filters are documented below.

property link

link?: pulumi.Input<string>;

The target record to link to. This means this record is a ‘linked’ record, and it inherits all properties from its target.

property meta

meta?: pulumi.Input<{[key: string]: any}>;

property regions

regions?: pulumi.Input<pulumi.Input<RecordRegion>[]>;

One or more “regions” for the record. These are really just groupings based on metadata, and are called “Answer Groups” in the NS1 UI, but remain regions here for legacy reasons. Regions are documented below. Please note the ordering requirement!

property shortAnswers

shortAnswers?: pulumi.Input<pulumi.Input<string>[]>;

property ttl

ttl?: pulumi.Input<number>;

The records’ time to live.

property type

type: pulumi.Input<string>;

The records’ RR type.

property useClientSubnet

useClientSubnet?: pulumi.Input<boolean>;

Whether to use EDNS client subnet data when available(in filter chain). * meta - (Optional) meta is supported at the record level. Meta is documented below.

property zone

zone: pulumi.Input<string>;

The zone the record belongs to. Cannot have leading or trailing dots (“.”) - see the example above and FQDN formatting below.

interface RecordState

interface RecordState

Input properties used for looking up and filtering Record resources.

property answers

answers?: pulumi.Input<pulumi.Input<RecordAnswer>[]>;

One or more NS1 answers for the records’ specified type. Answers are documented below.

property domain

domain?: pulumi.Input<string>;

The records’ domain. Cannot have leading or trailing dots - see the example above and FQDN formatting below.

property filters

filters?: pulumi.Input<pulumi.Input<RecordFilter>[]>;

One or more NS1 filters for the record(order matters). Filters are documented below.

property link

link?: pulumi.Input<string>;

The target record to link to. This means this record is a ‘linked’ record, and it inherits all properties from its target.

property meta

meta?: pulumi.Input<{[key: string]: any}>;

property regions

regions?: pulumi.Input<pulumi.Input<RecordRegion>[]>;

One or more “regions” for the record. These are really just groupings based on metadata, and are called “Answer Groups” in the NS1 UI, but remain regions here for legacy reasons. Regions are documented below. Please note the ordering requirement!

property shortAnswers

shortAnswers?: pulumi.Input<pulumi.Input<string>[]>;

property ttl

ttl?: pulumi.Input<number>;

The records’ time to live.

property type

type?: pulumi.Input<string>;

The records’ RR type.

property useClientSubnet

useClientSubnet?: pulumi.Input<boolean>;

Whether to use EDNS client subnet data when available(in filter chain). * meta - (Optional) meta is supported at the record level. Meta is documented below.

property zone

zone?: pulumi.Input<string>;

The zone the record belongs to. Cannot have leading or trailing dots (“.”) - see the example above and FQDN formatting below.

interface TeamArgs

interface TeamArgs

The set of arguments for constructing a Team resource.

property accountManageAccountSettings

accountManageAccountSettings?: pulumi.Input<boolean>;

Whether the team can modify account settings.

property accountManageApikeys

accountManageApikeys?: pulumi.Input<boolean>;

Whether the team can modify account apikeys.

property accountManagePaymentMethods

accountManagePaymentMethods?: pulumi.Input<boolean>;

Whether the team can modify account payment methods.

property accountManagePlan

accountManagePlan?: pulumi.Input<boolean>;

Whether the team can modify the account plan.

property accountManageTeams

accountManageTeams?: pulumi.Input<boolean>;

Whether the team can modify other teams in the account.

property accountManageUsers

accountManageUsers?: pulumi.Input<boolean>;

Whether the team can modify account users.

property accountViewActivityLog

accountViewActivityLog?: pulumi.Input<boolean>;

Whether the team can view activity logs.

property accountViewInvoices

accountViewInvoices?: pulumi.Input<boolean>;

Whether the team can view invoices.

property dataManageDatafeeds

dataManageDatafeeds?: pulumi.Input<boolean>;

Whether the team can modify data feeds.

property dataManageDatasources

dataManageDatasources?: pulumi.Input<boolean>;

Whether the team can modify data sources.

property dataPushToDatafeeds

dataPushToDatafeeds?: pulumi.Input<boolean>;

Whether the team can publish to data feeds.

property dhcpManageDhcp

dhcpManageDhcp?: pulumi.Input<boolean>;

Whether the team can manage DHCP. Only relevant for the DDI product.

property dhcpViewDhcp

dhcpViewDhcp?: pulumi.Input<boolean>;

Whether the team can view DHCP. Only relevant for the DDI product.

property dnsManageZones

dnsManageZones?: pulumi.Input<boolean>;

Whether the team can modify the accounts zones.

property dnsViewZones

dnsViewZones?: pulumi.Input<boolean>;

Whether the team can view the accounts zones.

property dnsZonesAllowByDefault

dnsZonesAllowByDefault?: pulumi.Input<boolean>;

If true, enable the dnsZonesAllow list, otherwise enable the dnsZonesDeny list.

property dnsZonesAllows

dnsZonesAllows?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the team may access.

property dnsZonesDenies

dnsZonesDenies?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the team may not access.

property ipWhitelists

ipWhitelists?: pulumi.Input<pulumi.Input<TeamIpWhitelist>[]>;

The IP addresses to whitelist for this key.

property ipamManageIpam

ipamManageIpam?: pulumi.Input<boolean>;

Whether the team can manage IPAM. Only relevant for the DDI product.

property ipamViewIpam

ipamViewIpam?: pulumi.Input<boolean>;

Whether the team can view IPAM. Only relevant for the DDI product.

property monitoringManageJobs

monitoringManageJobs?: pulumi.Input<boolean>;

Whether the team can modify monitoring jobs.

property monitoringManageLists

monitoringManageLists?: pulumi.Input<boolean>;

Whether the team can modify notification lists.

property monitoringViewJobs

monitoringViewJobs?: pulumi.Input<boolean>;

Whether the team can view monitoring jobs.

property name

name?: pulumi.Input<string>;

The free form name of the team.

property securityManageActiveDirectory

securityManageActiveDirectory?: pulumi.Input<boolean>;

Whether the team can manage global active directory. Only relevant for the DDI product.

property securityManageGlobal2fa

securityManageGlobal2fa?: pulumi.Input<boolean>;

Whether the team can manage global two factor authentication.

interface TeamState

interface TeamState

Input properties used for looking up and filtering Team resources.

property accountManageAccountSettings

accountManageAccountSettings?: pulumi.Input<boolean>;

Whether the team can modify account settings.

property accountManageApikeys

accountManageApikeys?: pulumi.Input<boolean>;

Whether the team can modify account apikeys.

property accountManagePaymentMethods

accountManagePaymentMethods?: pulumi.Input<boolean>;

Whether the team can modify account payment methods.

property accountManagePlan

accountManagePlan?: pulumi.Input<boolean>;

Whether the team can modify the account plan.

property accountManageTeams

accountManageTeams?: pulumi.Input<boolean>;

Whether the team can modify other teams in the account.

property accountManageUsers

accountManageUsers?: pulumi.Input<boolean>;

Whether the team can modify account users.

property accountViewActivityLog

accountViewActivityLog?: pulumi.Input<boolean>;

Whether the team can view activity logs.

property accountViewInvoices

accountViewInvoices?: pulumi.Input<boolean>;

Whether the team can view invoices.

property dataManageDatafeeds

dataManageDatafeeds?: pulumi.Input<boolean>;

Whether the team can modify data feeds.

property dataManageDatasources

dataManageDatasources?: pulumi.Input<boolean>;

Whether the team can modify data sources.

property dataPushToDatafeeds

dataPushToDatafeeds?: pulumi.Input<boolean>;

Whether the team can publish to data feeds.

property dhcpManageDhcp

dhcpManageDhcp?: pulumi.Input<boolean>;

Whether the team can manage DHCP. Only relevant for the DDI product.

property dhcpViewDhcp

dhcpViewDhcp?: pulumi.Input<boolean>;

Whether the team can view DHCP. Only relevant for the DDI product.

property dnsManageZones

dnsManageZones?: pulumi.Input<boolean>;

Whether the team can modify the accounts zones.

property dnsViewZones

dnsViewZones?: pulumi.Input<boolean>;

Whether the team can view the accounts zones.

property dnsZonesAllowByDefault

dnsZonesAllowByDefault?: pulumi.Input<boolean>;

If true, enable the dnsZonesAllow list, otherwise enable the dnsZonesDeny list.

property dnsZonesAllows

dnsZonesAllows?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the team may access.

property dnsZonesDenies

dnsZonesDenies?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the team may not access.

property ipWhitelists

ipWhitelists?: pulumi.Input<pulumi.Input<TeamIpWhitelist>[]>;

The IP addresses to whitelist for this key.

property ipamManageIpam

ipamManageIpam?: pulumi.Input<boolean>;

Whether the team can manage IPAM. Only relevant for the DDI product.

property ipamViewIpam

ipamViewIpam?: pulumi.Input<boolean>;

Whether the team can view IPAM. Only relevant for the DDI product.

property monitoringManageJobs

monitoringManageJobs?: pulumi.Input<boolean>;

Whether the team can modify monitoring jobs.

property monitoringManageLists

monitoringManageLists?: pulumi.Input<boolean>;

Whether the team can modify notification lists.

property monitoringViewJobs

monitoringViewJobs?: pulumi.Input<boolean>;

Whether the team can view monitoring jobs.

property name

name?: pulumi.Input<string>;

The free form name of the team.

property securityManageActiveDirectory

securityManageActiveDirectory?: pulumi.Input<boolean>;

Whether the team can manage global active directory. Only relevant for the DDI product.

property securityManageGlobal2fa

securityManageGlobal2fa?: pulumi.Input<boolean>;

Whether the team can manage global two factor authentication.

interface UserArgs

interface UserArgs

The set of arguments for constructing a User resource.

property accountManageAccountSettings

accountManageAccountSettings?: pulumi.Input<boolean>;

Whether the user can modify account settings.

property accountManageApikeys

accountManageApikeys?: pulumi.Input<boolean>;

Whether the user can modify account apikeys.

property accountManagePaymentMethods

accountManagePaymentMethods?: pulumi.Input<boolean>;

Whether the user can modify account payment methods.

property accountManagePlan

accountManagePlan?: pulumi.Input<boolean>;

Whether the user can modify the account plan.

property accountManageTeams

accountManageTeams?: pulumi.Input<boolean>;

Whether the user can modify other teams in the account.

property accountManageUsers

accountManageUsers?: pulumi.Input<boolean>;

Whether the user can modify account users.

property accountViewActivityLog

accountViewActivityLog?: pulumi.Input<boolean>;

Whether the user can view activity logs.

property accountViewInvoices

accountViewInvoices?: pulumi.Input<boolean>;

Whether the user can view invoices.

property dataManageDatafeeds

dataManageDatafeeds?: pulumi.Input<boolean>;

Whether the user can modify data feeds.

property dataManageDatasources

dataManageDatasources?: pulumi.Input<boolean>;

Whether the user can modify data sources.

property dataPushToDatafeeds

dataPushToDatafeeds?: pulumi.Input<boolean>;

Whether the user can publish to data feeds.

property dhcpManageDhcp

dhcpManageDhcp?: pulumi.Input<boolean>;

Whether the user can manage DHCP. Only relevant for the DDI product.

property dhcpViewDhcp

dhcpViewDhcp?: pulumi.Input<boolean>;

Whether the user can view DHCP. Only relevant for the DDI product.

property dnsManageZones

dnsManageZones?: pulumi.Input<boolean>;

Whether the user can modify the accounts zones.

property dnsViewZones

dnsViewZones?: pulumi.Input<boolean>;

Whether the user can view the accounts zones.

property dnsZonesAllowByDefault

dnsZonesAllowByDefault?: pulumi.Input<boolean>;

If true, enable the dnsZonesAllow list, otherwise enable the dnsZonesDeny list.

property dnsZonesAllows

dnsZonesAllows?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the user may access.

property dnsZonesDenies

dnsZonesDenies?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the user may not access.

property email

email: pulumi.Input<string>;

The email address of the user.

property ipWhitelistStrict

ipWhitelistStrict?: pulumi.Input<boolean>;

Sets exclusivity on this IP whitelist.

property ipWhitelists

ipWhitelists?: pulumi.Input<pulumi.Input<string>[]>;

The IP addresses to whitelist for this key.

property ipamManageIpam

ipamManageIpam?: pulumi.Input<boolean>;

Whether the user can manage IPAM. Only relevant for the DDI product.

property ipamViewIpam

ipamViewIpam?: pulumi.Input<boolean>;

property monitoringManageJobs

monitoringManageJobs?: pulumi.Input<boolean>;

Whether the user can modify monitoring jobs.

property monitoringManageLists

monitoringManageLists?: pulumi.Input<boolean>;

Whether the user can modify notification lists.

property monitoringViewJobs

monitoringViewJobs?: pulumi.Input<boolean>;

Whether the user can view monitoring jobs.

property name

name?: pulumi.Input<string>;

The free form name of the user.

property notify

notify?: pulumi.Input<{[key: string]: any}>;

Whether or not to notify the user of specified events. Only billing is available currently.

property securityManageActiveDirectory

securityManageActiveDirectory?: pulumi.Input<boolean>;

Whether the user can manage global active directory. Only relevant for the DDI product.

property securityManageGlobal2fa

securityManageGlobal2fa?: pulumi.Input<boolean>;

Whether the user can manage global two factor authentication.

property teams

teams?: pulumi.Input<pulumi.Input<string>[]>;

The teams that the user belongs to.

property username

username: pulumi.Input<string>;

The users login name.

interface UserState

interface UserState

Input properties used for looking up and filtering User resources.

property accountManageAccountSettings

accountManageAccountSettings?: pulumi.Input<boolean>;

Whether the user can modify account settings.

property accountManageApikeys

accountManageApikeys?: pulumi.Input<boolean>;

Whether the user can modify account apikeys.

property accountManagePaymentMethods

accountManagePaymentMethods?: pulumi.Input<boolean>;

Whether the user can modify account payment methods.

property accountManagePlan

accountManagePlan?: pulumi.Input<boolean>;

Whether the user can modify the account plan.

property accountManageTeams

accountManageTeams?: pulumi.Input<boolean>;

Whether the user can modify other teams in the account.

property accountManageUsers

accountManageUsers?: pulumi.Input<boolean>;

Whether the user can modify account users.

property accountViewActivityLog

accountViewActivityLog?: pulumi.Input<boolean>;

Whether the user can view activity logs.

property accountViewInvoices

accountViewInvoices?: pulumi.Input<boolean>;

Whether the user can view invoices.

property dataManageDatafeeds

dataManageDatafeeds?: pulumi.Input<boolean>;

Whether the user can modify data feeds.

property dataManageDatasources

dataManageDatasources?: pulumi.Input<boolean>;

Whether the user can modify data sources.

property dataPushToDatafeeds

dataPushToDatafeeds?: pulumi.Input<boolean>;

Whether the user can publish to data feeds.

property dhcpManageDhcp

dhcpManageDhcp?: pulumi.Input<boolean>;

Whether the user can manage DHCP. Only relevant for the DDI product.

property dhcpViewDhcp

dhcpViewDhcp?: pulumi.Input<boolean>;

Whether the user can view DHCP. Only relevant for the DDI product.

property dnsManageZones

dnsManageZones?: pulumi.Input<boolean>;

Whether the user can modify the accounts zones.

property dnsViewZones

dnsViewZones?: pulumi.Input<boolean>;

Whether the user can view the accounts zones.

property dnsZonesAllowByDefault

dnsZonesAllowByDefault?: pulumi.Input<boolean>;

If true, enable the dnsZonesAllow list, otherwise enable the dnsZonesDeny list.

property dnsZonesAllows

dnsZonesAllows?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the user may access.

property dnsZonesDenies

dnsZonesDenies?: pulumi.Input<pulumi.Input<string>[]>;

List of zones that the user may not access.

property email

email?: pulumi.Input<string>;

The email address of the user.

property ipWhitelistStrict

ipWhitelistStrict?: pulumi.Input<boolean>;

Sets exclusivity on this IP whitelist.

property ipWhitelists

ipWhitelists?: pulumi.Input<pulumi.Input<string>[]>;

The IP addresses to whitelist for this key.

property ipamManageIpam

ipamManageIpam?: pulumi.Input<boolean>;

Whether the user can manage IPAM. Only relevant for the DDI product.

property ipamViewIpam

ipamViewIpam?: pulumi.Input<boolean>;

property monitoringManageJobs

monitoringManageJobs?: pulumi.Input<boolean>;

Whether the user can modify monitoring jobs.

property monitoringManageLists

monitoringManageLists?: pulumi.Input<boolean>;

Whether the user can modify notification lists.

property monitoringViewJobs

monitoringViewJobs?: pulumi.Input<boolean>;

Whether the user can view monitoring jobs.

property name

name?: pulumi.Input<string>;

The free form name of the user.

property notify

notify?: pulumi.Input<{[key: string]: any}>;

Whether or not to notify the user of specified events. Only billing is available currently.

property securityManageActiveDirectory

securityManageActiveDirectory?: pulumi.Input<boolean>;

Whether the user can manage global active directory. Only relevant for the DDI product.

property securityManageGlobal2fa

securityManageGlobal2fa?: pulumi.Input<boolean>;

Whether the user can manage global two factor authentication.

property teams

teams?: pulumi.Input<pulumi.Input<string>[]>;

The teams that the user belongs to.

property username

username?: pulumi.Input<string>;

The users login name.

interface ZoneArgs

interface ZoneArgs

The set of arguments for constructing a Zone resource.

property additionalPrimaries

additionalPrimaries?: pulumi.Input<pulumi.Input<string>[]>;

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

property autogenerateNsRecord

autogenerateNsRecord?: pulumi.Input<boolean>;

property dnssec

dnssec?: pulumi.Input<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.

property expiry

expiry?: pulumi.Input<number>;

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

property link

link?: pulumi.Input<string>;

The target zone(domain name) to link to.

property networks

networks?: pulumi.Input<pulumi.Input<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.

property nxTtl

nxTtl?: pulumi.Input<number>;

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

property primary

primary?: pulumi.Input<string>;

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

property refresh

refresh?: pulumi.Input<number>;

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

property retry

retry?: pulumi.Input<number>;

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

property secondaries

secondaries?: pulumi.Input<pulumi.Input<ZoneSecondary>[]>;

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

property ttl

ttl?: pulumi.Input<number>;

The SOA TTL.

property zone

zone: pulumi.Input<string>;

The domain name of the zone.

interface ZoneState

interface ZoneState

Input properties used for looking up and filtering Zone resources.

property additionalPrimaries

additionalPrimaries?: pulumi.Input<pulumi.Input<string>[]>;

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

property autogenerateNsRecord

autogenerateNsRecord?: pulumi.Input<boolean>;

property dnsServers

dnsServers?: pulumi.Input<string>;

(Computed) Authoritative Name Servers.

property dnssec

dnssec?: pulumi.Input<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.

property expiry

expiry?: pulumi.Input<number>;

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

property hostmaster

hostmaster?: pulumi.Input<string>;

(Computed) The SOA Hostmaster.

property link

link?: pulumi.Input<string>;

The target zone(domain name) to link to.

property networks

networks?: pulumi.Input<pulumi.Input<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.

property nxTtl

nxTtl?: pulumi.Input<number>;

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

property primary

primary?: pulumi.Input<string>;

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

property refresh

refresh?: pulumi.Input<number>;

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

property retry

retry?: pulumi.Input<number>;

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

property secondaries

secondaries?: pulumi.Input<pulumi.Input<ZoneSecondary>[]>;

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

property ttl

ttl?: pulumi.Input<number>;

The SOA TTL.

property zone

zone?: pulumi.Input<string>;

The domain name of the zone.