Module types/output

This page documents the language specification for the ns1 package. If you're looking for help working with the inputs, outputs, or functions of ns1 resources in a Pulumi program, please see the resource documentation for examples and API reference.

APIs

APIs

interface GetDNSSecDelegation

interface GetDNSSecDelegation

property dnskeys

dnskeys: GetDNSSecDelegationDnskey[];

(Computed) List of Keys. Key is documented below.

property ds

ds: GetDNSSecDelegationD[];

(Computed) List of Keys. Key is documented below.

property ttl

ttl: number;

(Computed) TTL for the Keys (int).

interface GetDNSSecDelegationD

interface GetDNSSecDelegationD

property algorithm

algorithm: string;

(Computed) Algorithm of the key.

property flags

flags: string;

(Computed) Flags for the key.

property protocol

protocol: string;

(Computed) Protocol of the key.

property publicKey

publicKey: string;

(Computed) Public key for the key.

interface GetDNSSecDelegationDnskey

interface GetDNSSecDelegationDnskey

property algorithm

algorithm: string;

(Computed) Algorithm of the key.

property flags

flags: string;

(Computed) Flags for the key.

property protocol

protocol: string;

(Computed) Protocol of the key.

property publicKey

publicKey: string;

(Computed) Public key for the key.

interface GetDNSSecKeys

interface GetDNSSecKeys

property dnskeys

dnskeys: GetDNSSecKeysDnskey[];

(Computed) List of Keys. Key is documented below.

property ttl

ttl: number;

(Computed) TTL for the Keys (int).

interface GetDNSSecKeysDnskey

interface GetDNSSecKeysDnskey

property algorithm

algorithm: string;

(Computed) Algorithm of the key.

property flags

flags: string;

(Computed) Flags for the key.

property protocol

protocol: string;

(Computed) Protocol of the key.

property publicKey

publicKey: string;

(Computed) Public key for the key.

interface GetZoneSecondary

interface GetZoneSecondary

property ip

ip: string;

IPv4 address of the secondary server.

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 notify

notify: boolean;

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

property port

port: number;

Port of the the secondary server. Default 53.

interface MonitoringJobRule

interface MonitoringJobRule

property comparison

comparison: string;

The comparison to perform on the the output.

property key

key: string;

The output key.

property value

value: string;

The value to compare to.

interface NotifyListNotification

interface NotifyListNotification

property config

config: {[key: string]: any};

Configuration details for the given notifier type.

property type

type: string;

The type of notifier. Available notifiers are indicated in /notifytypes endpoint.

interface RecordAnswer

interface RecordAnswer

property answer

answer?: undefined | string;

Space delimited string of RDATA fields dependent on the record type.

property meta

meta?: undefined | {[key: string]: any};

property region

region?: undefined | string;

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.

interface RecordFilter

interface RecordFilter

property config

config?: undefined | {[key: string]: any};

The filters’ configuration. Simple key/value pairs determined by the filter type.

property disabled

disabled?: undefined | false | true;

Determines whether the filter is applied in the filter chain.

property filter

filter: string;

The type of filter.

interface RecordRegion

interface RecordRegion

property meta

meta?: undefined | {[key: string]: any};

property name

name: string;

Name of the region (or Answer Group).

interface TeamIpWhitelist

interface TeamIpWhitelist

property name

name: string;

The free form name of the team.

property values

values: string[];

interface ZoneSecondary

interface ZoneSecondary

property ip

ip: string;

IPv4 address of the secondary server.

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. Normally, you should not have to worry about this.

property notify

notify: boolean;

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

property port

port: number;

Port of the the secondary server. Default 53.