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.

class pulumi_ns1.APIKey(resource_name, opts=None, account_manage_account_settings=None, account_manage_apikeys=None, account_manage_payment_methods=None, account_manage_plan=None, account_manage_teams=None, account_manage_users=None, account_view_activity_log=None, account_view_invoices=None, data_manage_datafeeds=None, data_manage_datasources=None, data_push_to_datafeeds=None, dhcp_manage_dhcp=None, dhcp_view_dhcp=None, dns_manage_zones=None, dns_view_zones=None, dns_zones_allow_by_default=None, dns_zones_allows=None, dns_zones_denies=None, ip_whitelist_strict=None, ip_whitelists=None, ipam_manage_ipam=None, ipam_view_ipam=None, monitoring_manage_jobs=None, monitoring_manage_lists=None, monitoring_view_jobs=None, name=None, security_manage_active_directory=None, security_manage_global2fa=None, teams=None, __props__=None, __name__=None, __opts__=None)¶

Create a APIKey resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] account_manage_account_settings: Whether the apikey can modify account settings. :param pulumi.Input[bool] account_manage_apikeys: Whether the apikey can modify account apikeys. :param pulumi.Input[bool] account_manage_payment_methods: Whether the apikey can modify account payment methods. :param pulumi.Input[bool] account_manage_plan: Whether the apikey can modify the account plan. :param pulumi.Input[bool] account_manage_teams: Whether the apikey can modify other teams in the account. :param pulumi.Input[bool] account_manage_users: Whether the apikey can modify account users. :param pulumi.Input[bool] account_view_activity_log: Whether the apikey can view activity logs. :param pulumi.Input[bool] account_view_invoices: Whether the apikey can view invoices. :param pulumi.Input[bool] data_manage_datafeeds: Whether the apikey can modify data feeds. :param pulumi.Input[bool] data_manage_datasources: Whether the apikey can modify data sources. :param pulumi.Input[bool] data_push_to_datafeeds: Whether the apikey can publish to data feeds. :param pulumi.Input[bool] dhcp_manage_dhcp: Whether the apikey can manage DHCP.

Only relevant for the DDI product.

Parameters

• dhcp_view_dhcp (pulumi.Input[bool]) – Whether the apikey can view DHCP. Only relevant for the DDI product.

• dns_manage_zones (pulumi.Input[bool]) – Whether the apikey can modify the accounts zones.

• dns_view_zones (pulumi.Input[bool]) – Whether the apikey can view the accounts zones.

• dns_zones_allow_by_default (pulumi.Input[bool]) – If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

• dns_zones_allows (pulumi.Input[list]) – List of zones that the apikey may access.

• dns_zones_denies (pulumi.Input[list]) – List of zones that the apikey may not access.

• ip_whitelist_strict (pulumi.Input[bool]) – Sets exclusivity on this IP whitelist.

• ip_whitelists (pulumi.Input[list]) – The IP addresses to whitelist for this key.

• ipam_manage_ipam (pulumi.Input[bool]) – Whether the apikey can manage IPAM. Only relevant for the DDI product.

• ipam_view_ipam (pulumi.Input[bool]) – Whether the apikey can view IPAM. Only relevant for the DDI product.

• monitoring_manage_jobs (pulumi.Input[bool]) – Whether the apikey can modify monitoring jobs.

• monitoring_manage_lists (pulumi.Input[bool]) – Whether the apikey can modify notification lists.

• monitoring_view_jobs (pulumi.Input[bool]) – Whether the apikey can view monitoring jobs.

• name (pulumi.Input[str]) – The free form name of the apikey.

• security_manage_active_directory (pulumi.Input[bool]) – Whether the apikey can manage global active directory. Only relevant for the DDI product.

• security_manage_global2fa (pulumi.Input[bool]) – Whether the apikey can manage global two factor authentication.

• teams (pulumi.Input[list]) – The teams that the apikey belongs to.

account_manage_account_settings: pulumi.Output[bool] = None¶

Whether the apikey can modify account settings.

account_manage_apikeys: pulumi.Output[bool] = None¶

Whether the apikey can modify account apikeys.

account_manage_payment_methods: pulumi.Output[bool] = None¶

Whether the apikey can modify account payment methods.

account_manage_plan: pulumi.Output[bool] = None¶

Whether the apikey can modify the account plan.

account_manage_teams: pulumi.Output[bool] = None¶

Whether the apikey can modify other teams in the account.

account_manage_users: pulumi.Output[bool] = None¶

Whether the apikey can modify account users.

account_view_activity_log: pulumi.Output[bool] = None¶

Whether the apikey can view activity logs.

account_view_invoices: pulumi.Output[bool] = None¶

Whether the apikey can view invoices.

data_manage_datafeeds: pulumi.Output[bool] = None¶

Whether the apikey can modify data feeds.

data_manage_datasources: pulumi.Output[bool] = None¶

Whether the apikey can modify data sources.

data_push_to_datafeeds: pulumi.Output[bool] = None¶

Whether the apikey can publish to data feeds.

dhcp_manage_dhcp: pulumi.Output[bool] = None¶

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

dhcp_view_dhcp: pulumi.Output[bool] = None¶

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

dns_manage_zones: pulumi.Output[bool] = None¶

Whether the apikey can modify the accounts zones.

dns_view_zones: pulumi.Output[bool] = None¶

Whether the apikey can view the accounts zones.

dns_zones_allow_by_default: pulumi.Output[bool] = None¶

If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

dns_zones_allows: pulumi.Output[list] = None¶

List of zones that the apikey may access.

dns_zones_denies: pulumi.Output[list] = None¶

List of zones that the apikey may not access.

ip_whitelist_strict: pulumi.Output[bool] = None¶

Sets exclusivity on this IP whitelist.

ip_whitelists: pulumi.Output[list] = None¶

The IP addresses to whitelist for this key.

ipam_manage_ipam: pulumi.Output[bool] = None¶

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

ipam_view_ipam: pulumi.Output[bool] = None¶

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

key: pulumi.Output[str] = None¶

The apikeys authentication token.

monitoring_manage_jobs: pulumi.Output[bool] = None¶

Whether the apikey can modify monitoring jobs.

monitoring_manage_lists: pulumi.Output[bool] = None¶

Whether the apikey can modify notification lists.

monitoring_view_jobs: pulumi.Output[bool] = None¶

Whether the apikey can view monitoring jobs.

name: pulumi.Output[str] = None¶

The free form name of the apikey.

security_manage_active_directory: pulumi.Output[bool] = None¶

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

security_manage_global2fa: pulumi.Output[bool] = None¶

Whether the apikey can manage global two factor authentication.

teams: pulumi.Output[list] = None¶

The teams that the apikey belongs to.

static get(resource_name, id, opts=None, account_manage_account_settings=None, account_manage_apikeys=None, account_manage_payment_methods=None, account_manage_plan=None, account_manage_teams=None, account_manage_users=None, account_view_activity_log=None, account_view_invoices=None, data_manage_datafeeds=None, data_manage_datasources=None, data_push_to_datafeeds=None, dhcp_manage_dhcp=None, dhcp_view_dhcp=None, dns_manage_zones=None, dns_view_zones=None, dns_zones_allow_by_default=None, dns_zones_allows=None, dns_zones_denies=None, ip_whitelist_strict=None, ip_whitelists=None, ipam_manage_ipam=None, ipam_view_ipam=None, key=None, monitoring_manage_jobs=None, monitoring_manage_lists=None, monitoring_view_jobs=None, name=None, security_manage_active_directory=None, security_manage_global2fa=None, teams=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_manage_account_settings (pulumi.Input[bool]) – Whether the apikey can modify account settings.

• account_manage_apikeys (pulumi.Input[bool]) – Whether the apikey can modify account apikeys.

• account_manage_payment_methods (pulumi.Input[bool]) – Whether the apikey can modify account payment methods.

• account_manage_plan (pulumi.Input[bool]) – Whether the apikey can modify the account plan.

• account_manage_teams (pulumi.Input[bool]) – Whether the apikey can modify other teams in the account.

• account_manage_users (pulumi.Input[bool]) – Whether the apikey can modify account users.

• account_view_activity_log (pulumi.Input[bool]) – Whether the apikey can view activity logs.

• account_view_invoices (pulumi.Input[bool]) – Whether the apikey can view invoices.

• data_manage_datafeeds (pulumi.Input[bool]) – Whether the apikey can modify data feeds.

• data_manage_datasources (pulumi.Input[bool]) – Whether the apikey can modify data sources.

• data_push_to_datafeeds (pulumi.Input[bool]) – Whether the apikey can publish to data feeds.

• dhcp_manage_dhcp (pulumi.Input[bool]) – Whether the apikey can manage DHCP. Only relevant for the DDI product.

• dhcp_view_dhcp (pulumi.Input[bool]) – Whether the apikey can view DHCP. Only relevant for the DDI product.

• dns_manage_zones (pulumi.Input[bool]) – Whether the apikey can modify the accounts zones.

• dns_view_zones (pulumi.Input[bool]) – Whether the apikey can view the accounts zones.

• dns_zones_allow_by_default (pulumi.Input[bool]) – If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

• dns_zones_allows (pulumi.Input[list]) – List of zones that the apikey may access.

• dns_zones_denies (pulumi.Input[list]) – List of zones that the apikey may not access.

• ip_whitelist_strict (pulumi.Input[bool]) – Sets exclusivity on this IP whitelist.

• ip_whitelists (pulumi.Input[list]) – The IP addresses to whitelist for this key.

• ipam_manage_ipam (pulumi.Input[bool]) – Whether the apikey can manage IPAM. Only relevant for the DDI product.

• ipam_view_ipam (pulumi.Input[bool]) – Whether the apikey can view IPAM. Only relevant for the DDI product.

• key (pulumi.Input[str]) – The apikeys authentication token.

• monitoring_manage_jobs (pulumi.Input[bool]) – Whether the apikey can modify monitoring jobs.

• monitoring_manage_lists (pulumi.Input[bool]) – Whether the apikey can modify notification lists.

• monitoring_view_jobs (pulumi.Input[bool]) – Whether the apikey can view monitoring jobs.

• name (pulumi.Input[str]) – The free form name of the apikey.

• security_manage_active_directory (pulumi.Input[bool]) – Whether the apikey can manage global active directory. Only relevant for the DDI product.

• security_manage_global2fa (pulumi.Input[bool]) – Whether the apikey can manage global two factor authentication.

• teams (pulumi.Input[list]) – The teams that the apikey belongs to.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_ns1.AwaitableGetDNSSecResult(delegation=None, id=None, keys=None, zone=None)¶

class pulumi_ns1.AwaitableGetZoneResult(additional_primaries=None, dns_servers=None, dnssec=None, expiry=None, hostmaster=None, id=None, link=None, networks=None, nx_ttl=None, primary=None, refresh=None, retry=None, secondaries=None, ttl=None, zone=None)¶

class pulumi_ns1.DataFeed(resource_name, opts=None, config=None, name=None, source_id=None, __props__=None, __name__=None, __opts__=None)¶

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

Datafeed Api Doc

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• config (pulumi.Input[dict]) – The feeds configuration matching the specification in feed_config from /data/sourcetypes.

• name (pulumi.Input[str]) – The free form name of the data feed.

• source_id (pulumi.Input[str]) – The data source id that this feed is connected to.

config: pulumi.Output[dict] = None¶

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

name: pulumi.Output[str] = None¶

The free form name of the data feed.

source_id: pulumi.Output[str] = None¶

The data source id that this feed is connected to.

static get(resource_name, id, opts=None, config=None, name=None, source_id=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• config (pulumi.Input[dict]) – The feeds configuration matching the specification in feed_config from /data/sourcetypes.

• name (pulumi.Input[str]) – The free form name of the data feed.

• source_id (pulumi.Input[str]) – The data source id that this feed is connected to.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_ns1.DataSource(resource_name, opts=None, config=None, name=None, sourcetype=None, __props__=None, __name__=None, __opts__=None)¶

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

Datasource Api Doc

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• config (pulumi.Input[dict]) – The data source configuration, determined by its type, matching the specification in config from /data/sourcetypes.

• name (pulumi.Input[str]) – The free form name of the data source.

• sourcetype (pulumi.Input[str]) – The data sources type, listed in API endpoint https://api.nsone.net/v1/data/sourcetypes.

config: pulumi.Output[dict] = None¶

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

name: pulumi.Output[str] = None¶

The free form name of the data source.

sourcetype: pulumi.Output[str] = None¶

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

static get(resource_name, id, opts=None, config=None, name=None, sourcetype=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• config (pulumi.Input[dict]) – The data source configuration, determined by its type, matching the specification in config from /data/sourcetypes.

• name (pulumi.Input[str]) – The free form name of the data source.

• sourcetype (pulumi.Input[str]) – The data sources type, listed in API endpoint https://api.nsone.net/v1/data/sourcetypes.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_ns1.GetDNSSecResult(delegation=None, id=None, keys=None, zone=None)¶

A collection of values returned by getDNSSec.

delegation = None¶

(Computed) - Delegation field is documented below.

id = None¶

The provider-assigned unique ID for this managed resource.

keys = None¶

(Computed) - Keys field is documented below.

class pulumi_ns1.GetZoneResult(additional_primaries=None, dns_servers=None, dnssec=None, expiry=None, hostmaster=None, id=None, link=None, networks=None, nx_ttl=None, primary=None, refresh=None, retry=None, secondaries=None, ttl=None, zone=None)¶

A collection of values returned by getZone.

additional_primaries = None¶

List of additional IPv4 addresses for the primary zone.

dns_servers = None¶

Authoritative Name Servers.

dnssec = None¶

Whether or not DNSSEC is enabled for the zone.

expiry = None¶

The SOA Expiry.

hostmaster = None¶

The SOA Hostmaster.

id = None¶

The provider-assigned unique ID for this managed resource.

link = None¶

The linked target zone.

networks = None¶

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

nx_ttl = None¶

The SOA NX TTL.

primary = None¶

The primary zones’ IPv4 address.

refresh = None¶

The SOA Refresh.

retry = None¶

The SOA Retry.

secondaries = None¶

List of secondary servers. Secondaries is documented below.

ttl = None¶

The SOA TTL.

class pulumi_ns1.MonitoringJob(resource_name, opts=None, active=None, config=None, frequency=None, job_type=None, name=None, notes=None, notify_delay=None, notify_failback=None, notify_list=None, notify_regional=None, notify_repeat=None, policy=None, rapid_recheck=None, regions=None, rules=None, __props__=None, __name__=None, __opts__=None)¶

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

MonitoringJob Api Doc

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• active (pulumi.Input[bool]) – Indicates if the job is active or temporarily disabled.

• config (pulumi.Input[dict]) – A configuration dictionary with keys and values depending on the jobs’ type.

• frequency (pulumi.Input[float]) – The frequency, in seconds, at which to run the monitoring job in each region.

• job_type (pulumi.Input[str]) – The type of monitoring job to be run. See NS1 API docs for supported values.

• name (pulumi.Input[str]) – The free-form display name for the monitoring job.

• notes (pulumi.Input[str]) – Freeform notes to be included in any notifications about this job.

• notify_delay (pulumi.Input[float]) – The time in seconds after a failure to wait before sending a notification.

• notify_failback (pulumi.Input[bool]) – If true, a notification is sent when a job returns to an “up” state.

• notify_list (pulumi.Input[str]) – The id of the notification list to send notifications to.

• notify_regional (pulumi.Input[bool]) – If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.

• notify_repeat (pulumi.Input[float]) – The time in seconds between repeat notifications of a failed job.

• policy (pulumi.Input[str]) – 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.

• rapid_recheck (pulumi.Input[bool]) – If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.

• regions (pulumi.Input[list]) – The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.

• rules (pulumi.Input[list]) – A list of rules for determining failure conditions. Job Rules are documented below.

The rules object supports the following:

• comparison (pulumi.Input[str]) - The comparison to perform on the the output.

• key (pulumi.Input[str]) - The output key.

• value (pulumi.Input[str]) - The value to compare to.

active: pulumi.Output[bool] = None¶

Indicates if the job is active or temporarily disabled.

config: pulumi.Output[dict] = None¶

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

frequency: pulumi.Output[float] = None¶

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

job_type: pulumi.Output[str] = None¶

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

name: pulumi.Output[str] = None¶

The free-form display name for the monitoring job.

notes: pulumi.Output[str] = None¶

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

notify_delay: pulumi.Output[float] = None¶

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

notify_failback: pulumi.Output[bool] = None¶

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

notify_list: pulumi.Output[str] = None¶

The id of the notification list to send notifications to.

notify_regional: pulumi.Output[bool] = None¶

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

notify_repeat: pulumi.Output[float] = None¶

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

policy: pulumi.Output[str] = None¶

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.

rapid_recheck: pulumi.Output[bool] = None¶

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

regions: pulumi.Output[list] = None¶

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

rules: pulumi.Output[list] = None¶

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

• comparison (str) - The comparison to perform on the the output.

• key (str) - The output key.

• value (str) - The value to compare to.

static get(resource_name, id, opts=None, active=None, config=None, frequency=None, job_type=None, name=None, notes=None, notify_delay=None, notify_failback=None, notify_list=None, notify_regional=None, notify_repeat=None, policy=None, rapid_recheck=None, regions=None, rules=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• active (pulumi.Input[bool]) – Indicates if the job is active or temporarily disabled.

• config (pulumi.Input[dict]) – A configuration dictionary with keys and values depending on the jobs’ type.

• frequency (pulumi.Input[float]) – The frequency, in seconds, at which to run the monitoring job in each region.

• job_type (pulumi.Input[str]) – The type of monitoring job to be run. See NS1 API docs for supported values.

• name (pulumi.Input[str]) – The free-form display name for the monitoring job.

• notes (pulumi.Input[str]) – Freeform notes to be included in any notifications about this job.

• notify_delay (pulumi.Input[float]) – The time in seconds after a failure to wait before sending a notification.

• notify_failback (pulumi.Input[bool]) – If true, a notification is sent when a job returns to an “up” state.

• notify_list (pulumi.Input[str]) – The id of the notification list to send notifications to.

• notify_regional (pulumi.Input[bool]) – If true, notifications are sent for any regional failure (and failback if desired), in addition to global state notifications.

• notify_repeat (pulumi.Input[float]) – The time in seconds between repeat notifications of a failed job.

• policy (pulumi.Input[str]) – 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.

• rapid_recheck (pulumi.Input[bool]) – If true, on any apparent state change, the job is quickly re-run after one second to confirm the state change before notification.

• regions (pulumi.Input[list]) – The list of region codes in which to run the monitoring job. See NS1 API docs for supported values.

• rules (pulumi.Input[list]) – A list of rules for determining failure conditions. Job Rules are documented below.

The rules object supports the following:

• comparison (pulumi.Input[str]) - The comparison to perform on the the output.

• key (pulumi.Input[str]) - The output key.

• value (pulumi.Input[str]) - The value to compare to.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_ns1.NotifyList(resource_name, opts=None, name=None, notifications=None, __props__=None, __name__=None, __opts__=None)¶

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

NotifyList Api Doc

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• name (pulumi.Input[str]) – The free-form display name for the notify list.

• notifications (pulumi.Input[list]) – 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.

The notifications object supports the following:

• config (pulumi.Input[dict]) - Configuration details for the given notifier type.

• type (pulumi.Input[str]) - The type of notifier. Available notifiers are indicated in /notifytypes endpoint.

name: pulumi.Output[str] = None¶

The free-form display name for the notify list.

notifications: pulumi.Output[list] = None¶

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.

• config (dict) - Configuration details for the given notifier type.

• type (str) - The type of notifier. Available notifiers are indicated in /notifytypes endpoint.

static get(resource_name, id, opts=None, name=None, notifications=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• name (pulumi.Input[str]) – The free-form display name for the notify list.

• notifications (pulumi.Input[list]) – 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.

The notifications object supports the following:

• config (pulumi.Input[dict]) - Configuration details for the given notifier type.

• type (pulumi.Input[str]) - The type of notifier. Available notifiers are indicated in /notifytypes endpoint.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_ns1.Provider(resource_name, opts=None, apikey=None, enable_ddi=None, endpoint=None, ignore_ssl=None, rate_limit_parallelism=None, __props__=None, __name__=None, __opts__=None)¶

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.

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• apikey (pulumi.Input[str]) – The ns1 API key, this is required

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_ns1.Record(resource_name, opts=None, answers=None, domain=None, filters=None, link=None, meta=None, regions=None, short_answers=None, ttl=None, type=None, use_client_subnet=None, zone=None, __props__=None, __name__=None, __opts__=None)¶

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

Record Api Doc

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• answers (pulumi.Input[list]) – One or more NS1 answers for the records’ specified type. Answers are documented below.

• domain (pulumi.Input[str]) – The records’ domain. Cannot have leading or trailing dots - see the example above and FQDN formatting below.

• filters (pulumi.Input[list]) – One or more NS1 filters for the record(order matters). Filters are documented below.

• link (pulumi.Input[str]) – The target record to link to. This means this record is a ‘linked’ record, and it inherits all properties from its target.

• regions (pulumi.Input[list]) – 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!

• ttl (pulumi.Input[float]) – The records’ time to live.

• type (pulumi.Input[str]) – The records’ RR type.

• use_client_subnet (pulumi.Input[bool]) – 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.

Parameters

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

The answers object supports the following:

• answer (pulumi.Input[str]) - Space delimited string of RDATA fields dependent on the record type.

• meta (pulumi.Input[dict])

• region (pulumi.Input[str]) - The region (Answer Group really) that this answer belongs to. This should be one of the names specified in regions. Only a single region per answer is currently supported. If you want an answer in multiple regions, duplicating the answer (including metadata) is the correct approach.

  • meta - (Optional) meta is supported at the answer level. Meta is documented below.

The filters object supports the following:

• config (pulumi.Input[dict]) - The filters’ configuration. Simple key/value pairs determined by the filter type.

• disabled (pulumi.Input[bool]) - Determines whether the filter is applied in the filter chain.

• filter (pulumi.Input[str]) - The type of filter.

The regions object supports the following:

• meta (pulumi.Input[dict])

• name (pulumi.Input[str]) - Name of the region (or Answer Group).

answers: pulumi.Output[list] = None¶

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

• answer (str) - Space delimited string of RDATA fields dependent on the record type.

• meta (dict)

• region (str) - The region (Answer Group really) that this answer belongs to. This should be one of the names specified in regions. Only a single region per answer is currently supported. If you want an answer in multiple regions, duplicating the answer (including metadata) is the correct approach.

  • meta - (Optional) meta is supported at the answer level. Meta is documented below.

domain: pulumi.Output[str] = None¶

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

filters: pulumi.Output[list] = None¶

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

• config (dict) - The filters’ configuration. Simple key/value pairs determined by the filter type.

• disabled (bool) - Determines whether the filter is applied in the filter chain.

• filter (str) - The type of filter.

link: pulumi.Output[str] = None¶

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

regions: pulumi.Output[list] = None¶

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!

• meta (dict)

• name (str) - Name of the region (or Answer Group).

ttl: pulumi.Output[float] = None¶

The records’ time to live.

type: pulumi.Output[str] = None¶

The records’ RR type.

use_client_subnet: pulumi.Output[bool] = None¶

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.

zone: pulumi.Output[str] = None¶

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

static get(resource_name, id, opts=None, answers=None, domain=None, filters=None, link=None, meta=None, regions=None, short_answers=None, ttl=None, type=None, use_client_subnet=None, zone=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• answers (pulumi.Input[list]) – One or more NS1 answers for the records’ specified type. Answers are documented below.

• domain (pulumi.Input[str]) – The records’ domain. Cannot have leading or trailing dots - see the example above and FQDN formatting below.

• filters (pulumi.Input[list]) – One or more NS1 filters for the record(order matters). Filters are documented below.

• link (pulumi.Input[str]) – The target record to link to. This means this record is a ‘linked’ record, and it inherits all properties from its target.

• regions (pulumi.Input[list]) – 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!

• ttl (pulumi.Input[float]) – The records’ time to live.

• type (pulumi.Input[str]) – The records’ RR type.

• use_client_subnet (pulumi.Input[bool]) – 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.

Parameters

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

The answers object supports the following:

• answer (pulumi.Input[str]) - Space delimited string of RDATA fields dependent on the record type.

• meta (pulumi.Input[dict])

• region (pulumi.Input[str]) - The region (Answer Group really) that this answer belongs to. This should be one of the names specified in regions. Only a single region per answer is currently supported. If you want an answer in multiple regions, duplicating the answer (including metadata) is the correct approach.

  • meta - (Optional) meta is supported at the answer level. Meta is documented below.

The filters object supports the following:

• config (pulumi.Input[dict]) - The filters’ configuration. Simple key/value pairs determined by the filter type.

• disabled (pulumi.Input[bool]) - Determines whether the filter is applied in the filter chain.

• filter (pulumi.Input[str]) - The type of filter.

The regions object supports the following:

• meta (pulumi.Input[dict])

• name (pulumi.Input[str]) - Name of the region (or Answer Group).

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_ns1.Team(resource_name, opts=None, account_manage_account_settings=None, account_manage_apikeys=None, account_manage_payment_methods=None, account_manage_plan=None, account_manage_teams=None, account_manage_users=None, account_view_activity_log=None, account_view_invoices=None, data_manage_datafeeds=None, data_manage_datasources=None, data_push_to_datafeeds=None, dhcp_manage_dhcp=None, dhcp_view_dhcp=None, dns_manage_zones=None, dns_view_zones=None, dns_zones_allow_by_default=None, dns_zones_allows=None, dns_zones_denies=None, ip_whitelists=None, ipam_manage_ipam=None, ipam_view_ipam=None, monitoring_manage_jobs=None, monitoring_manage_lists=None, monitoring_view_jobs=None, name=None, security_manage_active_directory=None, security_manage_global2fa=None, __props__=None, __name__=None, __opts__=None)¶

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

Team Api Docs

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_manage_account_settings (pulumi.Input[bool]) – Whether the team can modify account settings.

• account_manage_apikeys (pulumi.Input[bool]) – Whether the team can modify account apikeys.

• account_manage_payment_methods (pulumi.Input[bool]) – Whether the team can modify account payment methods.

• account_manage_plan (pulumi.Input[bool]) – Whether the team can modify the account plan.

• account_manage_teams (pulumi.Input[bool]) – Whether the team can modify other teams in the account.

• account_manage_users (pulumi.Input[bool]) – Whether the team can modify account users.

• account_view_activity_log (pulumi.Input[bool]) – Whether the team can view activity logs.

• account_view_invoices (pulumi.Input[bool]) – Whether the team can view invoices.

• data_manage_datafeeds (pulumi.Input[bool]) – Whether the team can modify data feeds.

• data_manage_datasources (pulumi.Input[bool]) – Whether the team can modify data sources.

• data_push_to_datafeeds (pulumi.Input[bool]) – Whether the team can publish to data feeds.

• dhcp_manage_dhcp (pulumi.Input[bool]) – Whether the team can manage DHCP. Only relevant for the DDI product.

• dhcp_view_dhcp (pulumi.Input[bool]) – Whether the team can view DHCP. Only relevant for the DDI product.

• dns_manage_zones (pulumi.Input[bool]) – Whether the team can modify the accounts zones.

• dns_view_zones (pulumi.Input[bool]) – Whether the team can view the accounts zones.

• dns_zones_allow_by_default (pulumi.Input[bool]) – If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

• dns_zones_allows (pulumi.Input[list]) – List of zones that the team may access.

• dns_zones_denies (pulumi.Input[list]) – List of zones that the team may not access.

• ip_whitelists (pulumi.Input[list]) – The IP addresses to whitelist for this key.

• ipam_manage_ipam (pulumi.Input[bool]) – Whether the team can manage IPAM. Only relevant for the DDI product.

• ipam_view_ipam (pulumi.Input[bool]) – Whether the team can view IPAM. Only relevant for the DDI product.

• monitoring_manage_jobs (pulumi.Input[bool]) – Whether the team can modify monitoring jobs.

• monitoring_manage_lists (pulumi.Input[bool]) – Whether the team can modify notification lists.

• monitoring_view_jobs (pulumi.Input[bool]) – Whether the team can view monitoring jobs.

• name (pulumi.Input[str]) – The free form name of the team.

• security_manage_active_directory (pulumi.Input[bool]) – Whether the team can manage global active directory. Only relevant for the DDI product.

• security_manage_global2fa (pulumi.Input[bool]) – Whether the team can manage global two factor authentication.

The ip_whitelists object supports the following:

• name (pulumi.Input[str]) - The free form name of the team.

• values (pulumi.Input[list])

account_manage_account_settings: pulumi.Output[bool] = None¶

Whether the team can modify account settings.

account_manage_apikeys: pulumi.Output[bool] = None¶

Whether the team can modify account apikeys.

account_manage_payment_methods: pulumi.Output[bool] = None¶

Whether the team can modify account payment methods.

account_manage_plan: pulumi.Output[bool] = None¶

Whether the team can modify the account plan.

account_manage_teams: pulumi.Output[bool] = None¶

Whether the team can modify other teams in the account.

account_manage_users: pulumi.Output[bool] = None¶

Whether the team can modify account users.

account_view_activity_log: pulumi.Output[bool] = None¶

Whether the team can view activity logs.

account_view_invoices: pulumi.Output[bool] = None¶

Whether the team can view invoices.

data_manage_datafeeds: pulumi.Output[bool] = None¶

Whether the team can modify data feeds.

data_manage_datasources: pulumi.Output[bool] = None¶

Whether the team can modify data sources.

data_push_to_datafeeds: pulumi.Output[bool] = None¶

Whether the team can publish to data feeds.

dhcp_manage_dhcp: pulumi.Output[bool] = None¶

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

dhcp_view_dhcp: pulumi.Output[bool] = None¶

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

dns_manage_zones: pulumi.Output[bool] = None¶

Whether the team can modify the accounts zones.

dns_view_zones: pulumi.Output[bool] = None¶

Whether the team can view the accounts zones.

dns_zones_allow_by_default: pulumi.Output[bool] = None¶

If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

dns_zones_allows: pulumi.Output[list] = None¶

List of zones that the team may access.

dns_zones_denies: pulumi.Output[list] = None¶

List of zones that the team may not access.

ip_whitelists: pulumi.Output[list] = None¶

The IP addresses to whitelist for this key.

• name (str) - The free form name of the team.

• values (list)

ipam_manage_ipam: pulumi.Output[bool] = None¶

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

ipam_view_ipam: pulumi.Output[bool] = None¶

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

monitoring_manage_jobs: pulumi.Output[bool] = None¶

Whether the team can modify monitoring jobs.

monitoring_manage_lists: pulumi.Output[bool] = None¶

Whether the team can modify notification lists.

monitoring_view_jobs: pulumi.Output[bool] = None¶

Whether the team can view monitoring jobs.

name: pulumi.Output[str] = None¶

The free form name of the team.

security_manage_active_directory: pulumi.Output[bool] = None¶

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

security_manage_global2fa: pulumi.Output[bool] = None¶

Whether the team can manage global two factor authentication.

static get(resource_name, id, opts=None, account_manage_account_settings=None, account_manage_apikeys=None, account_manage_payment_methods=None, account_manage_plan=None, account_manage_teams=None, account_manage_users=None, account_view_activity_log=None, account_view_invoices=None, data_manage_datafeeds=None, data_manage_datasources=None, data_push_to_datafeeds=None, dhcp_manage_dhcp=None, dhcp_view_dhcp=None, dns_manage_zones=None, dns_view_zones=None, dns_zones_allow_by_default=None, dns_zones_allows=None, dns_zones_denies=None, ip_whitelists=None, ipam_manage_ipam=None, ipam_view_ipam=None, monitoring_manage_jobs=None, monitoring_manage_lists=None, monitoring_view_jobs=None, name=None, security_manage_active_directory=None, security_manage_global2fa=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_manage_account_settings (pulumi.Input[bool]) – Whether the team can modify account settings.

• account_manage_apikeys (pulumi.Input[bool]) – Whether the team can modify account apikeys.

• account_manage_payment_methods (pulumi.Input[bool]) – Whether the team can modify account payment methods.

• account_manage_plan (pulumi.Input[bool]) – Whether the team can modify the account plan.

• account_manage_teams (pulumi.Input[bool]) – Whether the team can modify other teams in the account.

• account_manage_users (pulumi.Input[bool]) – Whether the team can modify account users.

• account_view_activity_log (pulumi.Input[bool]) – Whether the team can view activity logs.

• account_view_invoices (pulumi.Input[bool]) – Whether the team can view invoices.

• data_manage_datafeeds (pulumi.Input[bool]) – Whether the team can modify data feeds.

• data_manage_datasources (pulumi.Input[bool]) – Whether the team can modify data sources.

• data_push_to_datafeeds (pulumi.Input[bool]) – Whether the team can publish to data feeds.

• dhcp_manage_dhcp (pulumi.Input[bool]) – Whether the team can manage DHCP. Only relevant for the DDI product.

• dhcp_view_dhcp (pulumi.Input[bool]) – Whether the team can view DHCP. Only relevant for the DDI product.

• dns_manage_zones (pulumi.Input[bool]) – Whether the team can modify the accounts zones.

• dns_view_zones (pulumi.Input[bool]) – Whether the team can view the accounts zones.

• dns_zones_allow_by_default (pulumi.Input[bool]) – If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

• dns_zones_allows (pulumi.Input[list]) – List of zones that the team may access.

• dns_zones_denies (pulumi.Input[list]) – List of zones that the team may not access.

• ip_whitelists (pulumi.Input[list]) – The IP addresses to whitelist for this key.

• ipam_manage_ipam (pulumi.Input[bool]) – Whether the team can manage IPAM. Only relevant for the DDI product.

• ipam_view_ipam (pulumi.Input[bool]) – Whether the team can view IPAM. Only relevant for the DDI product.

• monitoring_manage_jobs (pulumi.Input[bool]) – Whether the team can modify monitoring jobs.

• monitoring_manage_lists (pulumi.Input[bool]) – Whether the team can modify notification lists.

• monitoring_view_jobs (pulumi.Input[bool]) – Whether the team can view monitoring jobs.

• name (pulumi.Input[str]) – The free form name of the team.

• security_manage_active_directory (pulumi.Input[bool]) – Whether the team can manage global active directory. Only relevant for the DDI product.

• security_manage_global2fa (pulumi.Input[bool]) – Whether the team can manage global two factor authentication.

The ip_whitelists object supports the following:

• name (pulumi.Input[str]) - The free form name of the team.

• values (pulumi.Input[list])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_ns1.User(resource_name, opts=None, account_manage_account_settings=None, account_manage_apikeys=None, account_manage_payment_methods=None, account_manage_plan=None, account_manage_teams=None, account_manage_users=None, account_view_activity_log=None, account_view_invoices=None, data_manage_datafeeds=None, data_manage_datasources=None, data_push_to_datafeeds=None, dhcp_manage_dhcp=None, dhcp_view_dhcp=None, dns_manage_zones=None, dns_view_zones=None, dns_zones_allow_by_default=None, dns_zones_allows=None, dns_zones_denies=None, email=None, ip_whitelist_strict=None, ip_whitelists=None, ipam_manage_ipam=None, ipam_view_ipam=None, monitoring_manage_jobs=None, monitoring_manage_lists=None, monitoring_view_jobs=None, name=None, notify=None, security_manage_active_directory=None, security_manage_global2fa=None, teams=None, username=None, __props__=None, __name__=None, __opts__=None)¶

Create a User resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] account_manage_account_settings: Whether the user can modify account settings. :param pulumi.Input[bool] account_manage_apikeys: Whether the user can modify account apikeys. :param pulumi.Input[bool] account_manage_payment_methods: Whether the user can modify account payment methods. :param pulumi.Input[bool] account_manage_plan: Whether the user can modify the account plan. :param pulumi.Input[bool] account_manage_teams: Whether the user can modify other teams in the account. :param pulumi.Input[bool] account_manage_users: Whether the user can modify account users. :param pulumi.Input[bool] account_view_activity_log: Whether the user can view activity logs. :param pulumi.Input[bool] account_view_invoices: Whether the user can view invoices. :param pulumi.Input[bool] data_manage_datafeeds: Whether the user can modify data feeds. :param pulumi.Input[bool] data_manage_datasources: Whether the user can modify data sources. :param pulumi.Input[bool] data_push_to_datafeeds: Whether the user can publish to data feeds. :param pulumi.Input[bool] dhcp_manage_dhcp: Whether the user can manage DHCP.

Only relevant for the DDI product.

Parameters

• dhcp_view_dhcp (pulumi.Input[bool]) – Whether the user can view DHCP. Only relevant for the DDI product.

• dns_manage_zones (pulumi.Input[bool]) – Whether the user can modify the accounts zones.

• dns_view_zones (pulumi.Input[bool]) – Whether the user can view the accounts zones.

• dns_zones_allow_by_default (pulumi.Input[bool]) – If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

• dns_zones_allows (pulumi.Input[list]) – List of zones that the user may access.

• dns_zones_denies (pulumi.Input[list]) – List of zones that the user may not access.

• email (pulumi.Input[str]) – The email address of the user.

• ip_whitelist_strict (pulumi.Input[bool]) – Sets exclusivity on this IP whitelist.

• ip_whitelists (pulumi.Input[list]) – The IP addresses to whitelist for this key.

• ipam_manage_ipam (pulumi.Input[bool]) – Whether the user can manage IPAM. Only relevant for the DDI product.

• monitoring_manage_jobs (pulumi.Input[bool]) – Whether the user can modify monitoring jobs.

• monitoring_manage_lists (pulumi.Input[bool]) – Whether the user can modify notification lists.

• monitoring_view_jobs (pulumi.Input[bool]) – Whether the user can view monitoring jobs.

• name (pulumi.Input[str]) – The free form name of the user.

• notify (pulumi.Input[dict]) – Whether or not to notify the user of specified events. Only billing is available currently.

• security_manage_active_directory (pulumi.Input[bool]) – Whether the user can manage global active directory. Only relevant for the DDI product.

• security_manage_global2fa (pulumi.Input[bool]) – Whether the user can manage global two factor authentication.

• teams (pulumi.Input[list]) – The teams that the user belongs to.

• username (pulumi.Input[str]) – The users login name.

account_manage_account_settings: pulumi.Output[bool] = None¶

Whether the user can modify account settings.

account_manage_apikeys: pulumi.Output[bool] = None¶

Whether the user can modify account apikeys.

account_manage_payment_methods: pulumi.Output[bool] = None¶

Whether the user can modify account payment methods.

account_manage_plan: pulumi.Output[bool] = None¶

Whether the user can modify the account plan.

account_manage_teams: pulumi.Output[bool] = None¶

Whether the user can modify other teams in the account.

account_manage_users: pulumi.Output[bool] = None¶

Whether the user can modify account users.

account_view_activity_log: pulumi.Output[bool] = None¶

Whether the user can view activity logs.

account_view_invoices: pulumi.Output[bool] = None¶

Whether the user can view invoices.

data_manage_datafeeds: pulumi.Output[bool] = None¶

Whether the user can modify data feeds.

data_manage_datasources: pulumi.Output[bool] = None¶

Whether the user can modify data sources.

data_push_to_datafeeds: pulumi.Output[bool] = None¶

Whether the user can publish to data feeds.

dhcp_manage_dhcp: pulumi.Output[bool] = None¶

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

dhcp_view_dhcp: pulumi.Output[bool] = None¶

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

dns_manage_zones: pulumi.Output[bool] = None¶

Whether the user can modify the accounts zones.

dns_view_zones: pulumi.Output[bool] = None¶

Whether the user can view the accounts zones.

dns_zones_allow_by_default: pulumi.Output[bool] = None¶

If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

dns_zones_allows: pulumi.Output[list] = None¶

List of zones that the user may access.

dns_zones_denies: pulumi.Output[list] = None¶

List of zones that the user may not access.

email: pulumi.Output[str] = None¶

The email address of the user.

ip_whitelist_strict: pulumi.Output[bool] = None¶

Sets exclusivity on this IP whitelist.

ip_whitelists: pulumi.Output[list] = None¶

The IP addresses to whitelist for this key.

ipam_manage_ipam: pulumi.Output[bool] = None¶

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

monitoring_manage_jobs: pulumi.Output[bool] = None¶

Whether the user can modify monitoring jobs.

monitoring_manage_lists: pulumi.Output[bool] = None¶

Whether the user can modify notification lists.

monitoring_view_jobs: pulumi.Output[bool] = None¶

Whether the user can view monitoring jobs.

name: pulumi.Output[str] = None¶

The free form name of the user.

notify: pulumi.Output[dict] = None¶

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

security_manage_active_directory: pulumi.Output[bool] = None¶

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

security_manage_global2fa: pulumi.Output[bool] = None¶

Whether the user can manage global two factor authentication.

teams: pulumi.Output[list] = None¶

The teams that the user belongs to.

username: pulumi.Output[str] = None¶

The users login name.

static get(resource_name, id, opts=None, account_manage_account_settings=None, account_manage_apikeys=None, account_manage_payment_methods=None, account_manage_plan=None, account_manage_teams=None, account_manage_users=None, account_view_activity_log=None, account_view_invoices=None, data_manage_datafeeds=None, data_manage_datasources=None, data_push_to_datafeeds=None, dhcp_manage_dhcp=None, dhcp_view_dhcp=None, dns_manage_zones=None, dns_view_zones=None, dns_zones_allow_by_default=None, dns_zones_allows=None, dns_zones_denies=None, email=None, ip_whitelist_strict=None, ip_whitelists=None, ipam_manage_ipam=None, ipam_view_ipam=None, monitoring_manage_jobs=None, monitoring_manage_lists=None, monitoring_view_jobs=None, name=None, notify=None, security_manage_active_directory=None, security_manage_global2fa=None, teams=None, username=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• account_manage_account_settings (pulumi.Input[bool]) – Whether the user can modify account settings.

• account_manage_apikeys (pulumi.Input[bool]) – Whether the user can modify account apikeys.

• account_manage_payment_methods (pulumi.Input[bool]) – Whether the user can modify account payment methods.

• account_manage_plan (pulumi.Input[bool]) – Whether the user can modify the account plan.

• account_manage_teams (pulumi.Input[bool]) – Whether the user can modify other teams in the account.

• account_manage_users (pulumi.Input[bool]) – Whether the user can modify account users.

• account_view_activity_log (pulumi.Input[bool]) – Whether the user can view activity logs.

• account_view_invoices (pulumi.Input[bool]) – Whether the user can view invoices.

• data_manage_datafeeds (pulumi.Input[bool]) – Whether the user can modify data feeds.

• data_manage_datasources (pulumi.Input[bool]) – Whether the user can modify data sources.

• data_push_to_datafeeds (pulumi.Input[bool]) – Whether the user can publish to data feeds.

• dhcp_manage_dhcp (pulumi.Input[bool]) – Whether the user can manage DHCP. Only relevant for the DDI product.

• dhcp_view_dhcp (pulumi.Input[bool]) – Whether the user can view DHCP. Only relevant for the DDI product.

• dns_manage_zones (pulumi.Input[bool]) – Whether the user can modify the accounts zones.

• dns_view_zones (pulumi.Input[bool]) – Whether the user can view the accounts zones.

• dns_zones_allow_by_default (pulumi.Input[bool]) – If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

• dns_zones_allows (pulumi.Input[list]) – List of zones that the user may access.

• dns_zones_denies (pulumi.Input[list]) – List of zones that the user may not access.

• email (pulumi.Input[str]) – The email address of the user.

• ip_whitelist_strict (pulumi.Input[bool]) – Sets exclusivity on this IP whitelist.

• ip_whitelists (pulumi.Input[list]) – The IP addresses to whitelist for this key.

• ipam_manage_ipam (pulumi.Input[bool]) – Whether the user can manage IPAM. Only relevant for the DDI product.

• monitoring_manage_jobs (pulumi.Input[bool]) – Whether the user can modify monitoring jobs.

• monitoring_manage_lists (pulumi.Input[bool]) – Whether the user can modify notification lists.

• monitoring_view_jobs (pulumi.Input[bool]) – Whether the user can view monitoring jobs.

• name (pulumi.Input[str]) – The free form name of the user.

• notify (pulumi.Input[dict]) – Whether or not to notify the user of specified events. Only billing is available currently.

• security_manage_active_directory (pulumi.Input[bool]) – Whether the user can manage global active directory. Only relevant for the DDI product.

• security_manage_global2fa (pulumi.Input[bool]) – Whether the user can manage global two factor authentication.

• teams (pulumi.Input[list]) – The teams that the user belongs to.

• username (pulumi.Input[str]) – The users login name.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_ns1.Zone(resource_name, opts=None, additional_primaries=None, autogenerate_ns_record=None, dnssec=None, expiry=None, link=None, networks=None, nx_ttl=None, primary=None, refresh=None, retry=None, secondaries=None, ttl=None, zone=None, __props__=None, __name__=None, __opts__=None)¶

Create a Zone resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[list] additional_primaries: List of additional IPv4 addresses for the primary

zone. Conflicts with secondaries.

Parameters

• dnssec (pulumi.Input[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 (pulumi.Input[float]) – The SOA Expiry. Conflicts with primary and additional_primaries (default must be accepted).

• link (pulumi.Input[str]) – The target zone(domain name) to link to.

• networks (pulumi.Input[list]) –

  • List of network IDs (int) for which the zone

  should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.

• nx_ttl (pulumi.Input[float]) – The SOA NX TTL. Conflicts with primary and additional_primaries (default must be accepted).

• primary (pulumi.Input[str]) – The primary zones’ IPv4 address. This makes the zone a secondary. Conflicts with secondaries.

• refresh (pulumi.Input[float]) – The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).

• retry (pulumi.Input[float]) – The SOA Retry. Conflicts with primary and additional_primaries (default must be accepted).

• secondaries (pulumi.Input[list]) – List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.

• ttl (pulumi.Input[float]) – The SOA TTL.

• zone (pulumi.Input[str]) – The domain name of the zone.

The secondaries object supports the following:

• ip (pulumi.Input[str]) - IPv4 address of the secondary server.

• networks (pulumi.Input[list]) - - 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 (pulumi.Input[bool]) - Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.

• port (pulumi.Input[float]) - Port of the the secondary server. Default 53.

additional_primaries: pulumi.Output[list] = None¶

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

dns_servers: pulumi.Output[str] = None¶

(Computed) Authoritative Name Servers.

dnssec: pulumi.Output[bool] = None¶

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: pulumi.Output[float] = None¶

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

hostmaster: pulumi.Output[str] = None¶

(Computed) The SOA Hostmaster.

link: pulumi.Output[str] = None¶

The target zone(domain name) to link to.

networks: pulumi.Output[list] = None¶

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

nx_ttl: pulumi.Output[float] = None¶

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

primary: pulumi.Output[str] = None¶

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

refresh: pulumi.Output[float] = None¶

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

retry: pulumi.Output[float] = None¶

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

secondaries: pulumi.Output[list] = None¶

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

• ip (str) - IPv4 address of the secondary server.

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

• notify (bool) - Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.

• port (float) - Port of the the secondary server. Default 53.

ttl: pulumi.Output[float] = None¶

The SOA TTL.

zone: pulumi.Output[str] = None¶

The domain name of the zone.

static get(resource_name, id, opts=None, additional_primaries=None, autogenerate_ns_record=None, dns_servers=None, dnssec=None, expiry=None, hostmaster=None, link=None, networks=None, nx_ttl=None, primary=None, refresh=None, retry=None, secondaries=None, ttl=None, zone=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• additional_primaries (pulumi.Input[list]) – List of additional IPv4 addresses for the primary zone. Conflicts with secondaries.

• dns_servers (pulumi.Input[str]) – (Computed) Authoritative Name Servers.

• dnssec (pulumi.Input[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 (pulumi.Input[float]) – The SOA Expiry. Conflicts with primary and additional_primaries (default must be accepted).

• hostmaster (pulumi.Input[str]) – (Computed) The SOA Hostmaster.

• link (pulumi.Input[str]) – The target zone(domain name) to link to.

• networks (pulumi.Input[list]) –

  • List of network IDs (int) for which the zone

  should be made available. Default is network 0, the primary NSONE Global Network. Normally, you should not have to worry about this.

• nx_ttl (pulumi.Input[float]) – The SOA NX TTL. Conflicts with primary and additional_primaries (default must be accepted).

• primary (pulumi.Input[str]) – The primary zones’ IPv4 address. This makes the zone a secondary. Conflicts with secondaries.

• refresh (pulumi.Input[float]) – The SOA Refresh. Conflicts with primary and additional_primaries (default must be accepted).

• retry (pulumi.Input[float]) – The SOA Retry. Conflicts with primary and additional_primaries (default must be accepted).

• secondaries (pulumi.Input[list]) – List of secondary servers. This makes the zone a primary. Conflicts with primary and additional_primaries. Secondaries is documented below.

• ttl (pulumi.Input[float]) – The SOA TTL.

• zone (pulumi.Input[str]) – The domain name of the zone.

The secondaries object supports the following:

• ip (pulumi.Input[str]) - IPv4 address of the secondary server.

• networks (pulumi.Input[list]) - - 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 (pulumi.Input[bool]) - Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.

• port (pulumi.Input[float]) - Port of the the secondary server. Default 53.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_ns1.get_dns_sec(zone=None, opts=None)¶

Provides DNSSEC details about a NS1 Zone.

Parameters

zone (str) – The name of the zone to get DNSSEC details for.

pulumi_ns1.get_zone(additional_primaries=None, zone=None, opts=None)¶

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.

Parameters

• additional_primaries (list) – List of additional IPv4 addresses for the primary zone.

• zone (str) – The domain name of the zone.