pulumi-ns1 3.2.1__py3-none-any.whl → 3.3.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
pulumi_ns1/__init__.py CHANGED
@@ -22,6 +22,8 @@ from .notify_list import *
22
22
  from .provider import *
23
23
  from .pulsar_job import *
24
24
  from .record import *
25
+ from .redirect import *
26
+ from .redirect_certificate import *
25
27
  from .subnet import *
26
28
  from .team import *
27
29
  from .tsigkey import *
@@ -128,6 +130,22 @@ _utilities.register(
128
130
  "ns1:index/record:Record": "Record"
129
131
  }
130
132
  },
133
+ {
134
+ "pkg": "ns1",
135
+ "mod": "index/redirect",
136
+ "fqn": "pulumi_ns1",
137
+ "classes": {
138
+ "ns1:index/redirect:Redirect": "Redirect"
139
+ }
140
+ },
141
+ {
142
+ "pkg": "ns1",
143
+ "mod": "index/redirectCertificate",
144
+ "fqn": "pulumi_ns1",
145
+ "classes": {
146
+ "ns1:index/redirectCertificate:RedirectCertificate": "RedirectCertificate"
147
+ }
148
+ },
131
149
  {
132
150
  "pkg": "ns1",
133
151
  "mod": "index/subnet",
@@ -105,17 +105,17 @@ class AccountWhitelist(pulumi.CustomResource):
105
105
 
106
106
  ## Example Usage
107
107
 
108
- <!--Start PulumiCodeChooser -->
109
108
  ```python
110
109
  import pulumi
111
110
  import pulumi_ns1 as ns1
112
111
 
113
- example = ns1.AccountWhitelist("example", values=[
114
- "1.1.1.1",
115
- "2.2.2.2",
116
- ])
112
+ example = ns1.AccountWhitelist("example",
113
+ name="Example Whitelist",
114
+ values=[
115
+ "1.1.1.1",
116
+ "2.2.2.2",
117
+ ])
117
118
  ```
118
- <!--End PulumiCodeChooser -->
119
119
 
120
120
  > You current source IP must be present in one of the whitelists to prevent locking yourself out.
121
121
 
@@ -147,17 +147,17 @@ class AccountWhitelist(pulumi.CustomResource):
147
147
 
148
148
  ## Example Usage
149
149
 
150
- <!--Start PulumiCodeChooser -->
151
150
  ```python
152
151
  import pulumi
153
152
  import pulumi_ns1 as ns1
154
153
 
155
- example = ns1.AccountWhitelist("example", values=[
156
- "1.1.1.1",
157
- "2.2.2.2",
158
- ])
154
+ example = ns1.AccountWhitelist("example",
155
+ name="Example Whitelist",
156
+ values=[
157
+ "1.1.1.1",
158
+ "2.2.2.2",
159
+ ])
159
160
  ```
160
- <!--End PulumiCodeChooser -->
161
161
 
162
162
  > You current source IP must be present in one of the whitelists to prevent locking yourself out.
163
163
 
pulumi_ns1/api_key.py CHANGED
@@ -1144,14 +1144,14 @@ class APIKey(pulumi.CustomResource):
1144
1144
 
1145
1145
  ## Example Usage
1146
1146
 
1147
- <!--Start PulumiCodeChooser -->
1148
1147
  ```python
1149
1148
  import pulumi
1150
1149
  import pulumi_ns1 as ns1
1151
1150
 
1152
- example_team = ns1.Team("exampleTeam")
1153
- example_api_key = ns1.APIKey("exampleAPIKey",
1154
- teams=[example_team.id],
1151
+ example = ns1.Team("example", name="Example team")
1152
+ example_api_key = ns1.APIKey("example",
1153
+ name="Example key",
1154
+ teams=[example.id],
1155
1155
  ip_whitelists=[
1156
1156
  "1.1.1.1",
1157
1157
  "2.2.2.2",
@@ -1159,7 +1159,6 @@ class APIKey(pulumi.CustomResource):
1159
1159
  dns_view_zones=False,
1160
1160
  account_manage_users=False)
1161
1161
  ```
1162
- <!--End PulumiCodeChooser -->
1163
1162
 
1164
1163
  ## Permissions
1165
1164
 
@@ -1241,14 +1240,14 @@ class APIKey(pulumi.CustomResource):
1241
1240
 
1242
1241
  ## Example Usage
1243
1242
 
1244
- <!--Start PulumiCodeChooser -->
1245
1243
  ```python
1246
1244
  import pulumi
1247
1245
  import pulumi_ns1 as ns1
1248
1246
 
1249
- example_team = ns1.Team("exampleTeam")
1250
- example_api_key = ns1.APIKey("exampleAPIKey",
1251
- teams=[example_team.id],
1247
+ example = ns1.Team("example", name="Example team")
1248
+ example_api_key = ns1.APIKey("example",
1249
+ name="Example key",
1250
+ teams=[example.id],
1252
1251
  ip_whitelists=[
1253
1252
  "1.1.1.1",
1254
1253
  "2.2.2.2",
@@ -1256,7 +1255,6 @@ class APIKey(pulumi.CustomResource):
1256
1255
  dns_view_zones=False,
1257
1256
  account_manage_users=False)
1258
1257
  ```
1259
- <!--End PulumiCodeChooser -->
1260
1258
 
1261
1259
  ## Permissions
1262
1260
 
pulumi_ns1/application.py CHANGED
@@ -215,28 +215,6 @@ class Application(pulumi.CustomResource):
215
215
  """
216
216
  Provides a NS1 Pulsar application resource. This can be used to create, modify, and delete applications.
217
217
 
218
- ## Example Usage
219
-
220
- <!--Start PulumiCodeChooser -->
221
- ```python
222
- import pulumi
223
- import pulumi_ns1 as ns1
224
-
225
- # Create a new pulsar application with default config
226
- ns1_app = ns1.Application("ns1App", default_config=ns1.ApplicationDefaultConfigArgs(
227
- http=True,
228
- https=False,
229
- job_timeout_millis=100,
230
- request_timeout_millis=100,
231
- static_values=True,
232
- ))
233
- ```
234
- <!--End PulumiCodeChooser -->
235
-
236
- ## NS1 Documentation
237
-
238
- [Application Api Docs](https://ns1.com/api#get-list-pulsar-applications)
239
-
240
218
  ## Import
241
219
 
242
220
  ```sh
@@ -269,28 +247,6 @@ class Application(pulumi.CustomResource):
269
247
  """
270
248
  Provides a NS1 Pulsar application resource. This can be used to create, modify, and delete applications.
271
249
 
272
- ## Example Usage
273
-
274
- <!--Start PulumiCodeChooser -->
275
- ```python
276
- import pulumi
277
- import pulumi_ns1 as ns1
278
-
279
- # Create a new pulsar application with default config
280
- ns1_app = ns1.Application("ns1App", default_config=ns1.ApplicationDefaultConfigArgs(
281
- http=True,
282
- https=False,
283
- job_timeout_millis=100,
284
- request_timeout_millis=100,
285
- static_values=True,
286
- ))
287
- ```
288
- <!--End PulumiCodeChooser -->
289
-
290
- ## NS1 Documentation
291
-
292
- [Application Api Docs](https://ns1.com/api#get-list-pulsar-applications)
293
-
294
250
  ## Import
295
251
 
296
252
  ```sh
pulumi_ns1/data_feed.py CHANGED
@@ -140,30 +140,35 @@ class DataFeed(pulumi.CustomResource):
140
140
 
141
141
  ## Example Usage
142
142
 
143
- <!--Start PulumiCodeChooser -->
144
143
  ```python
145
144
  import pulumi
146
145
  import pulumi_ns1 as ns1
147
146
 
148
- example = ns1.DataSource("example", sourcetype="nsone_v1")
149
- example_monitoring = ns1.DataSource("exampleMonitoring", sourcetype="nsone_monitoring")
150
- uswest_feed = ns1.DataFeed("uswestFeed",
147
+ example = ns1.DataSource("example",
148
+ name="example",
149
+ sourcetype="nsone_v1")
150
+ example_monitoring = ns1.DataSource("example_monitoring",
151
+ name="example_monitoring",
152
+ sourcetype="nsone_monitoring")
153
+ uswest_feed = ns1.DataFeed("uswest_feed",
154
+ name="uswest_feed",
151
155
  source_id=example.id,
152
156
  config={
153
157
  "label": "uswest",
154
158
  })
155
- useast_feed = ns1.DataFeed("useastFeed",
159
+ useast_feed = ns1.DataFeed("useast_feed",
160
+ name="useast_feed",
156
161
  source_id=example.id,
157
162
  config={
158
163
  "label": "useast",
159
164
  })
160
- useast_monitor_feed = ns1.DataFeed("useastMonitorFeed",
165
+ useast_monitor_feed = ns1.DataFeed("useast_monitor_feed",
166
+ name="useast_monitor_feed",
161
167
  source_id=example_monitoring.id,
162
168
  config={
163
- "jobid": ns1_monitoringjob["example_job"]["id"],
169
+ "jobid": example_job["id"],
164
170
  })
165
171
  ```
166
- <!--End PulumiCodeChooser -->
167
172
 
168
173
  ## NS1 Documentation
169
174
 
@@ -193,30 +198,35 @@ class DataFeed(pulumi.CustomResource):
193
198
 
194
199
  ## Example Usage
195
200
 
196
- <!--Start PulumiCodeChooser -->
197
201
  ```python
198
202
  import pulumi
199
203
  import pulumi_ns1 as ns1
200
204
 
201
- example = ns1.DataSource("example", sourcetype="nsone_v1")
202
- example_monitoring = ns1.DataSource("exampleMonitoring", sourcetype="nsone_monitoring")
203
- uswest_feed = ns1.DataFeed("uswestFeed",
205
+ example = ns1.DataSource("example",
206
+ name="example",
207
+ sourcetype="nsone_v1")
208
+ example_monitoring = ns1.DataSource("example_monitoring",
209
+ name="example_monitoring",
210
+ sourcetype="nsone_monitoring")
211
+ uswest_feed = ns1.DataFeed("uswest_feed",
212
+ name="uswest_feed",
204
213
  source_id=example.id,
205
214
  config={
206
215
  "label": "uswest",
207
216
  })
208
- useast_feed = ns1.DataFeed("useastFeed",
217
+ useast_feed = ns1.DataFeed("useast_feed",
218
+ name="useast_feed",
209
219
  source_id=example.id,
210
220
  config={
211
221
  "label": "useast",
212
222
  })
213
- useast_monitor_feed = ns1.DataFeed("useastMonitorFeed",
223
+ useast_monitor_feed = ns1.DataFeed("useast_monitor_feed",
224
+ name="useast_monitor_feed",
214
225
  source_id=example_monitoring.id,
215
226
  config={
216
- "jobid": ns1_monitoringjob["example_job"]["id"],
227
+ "jobid": example_job["id"],
217
228
  })
218
229
  ```
219
- <!--End PulumiCodeChooser -->
220
230
 
221
231
  ## NS1 Documentation
222
232
 
pulumi_ns1/data_source.py CHANGED
@@ -140,14 +140,14 @@ class DataSource(pulumi.CustomResource):
140
140
 
141
141
  ## Example Usage
142
142
 
143
- <!--Start PulumiCodeChooser -->
144
143
  ```python
145
144
  import pulumi
146
145
  import pulumi_ns1 as ns1
147
146
 
148
- example = ns1.DataSource("example", sourcetype="nsone_v1")
147
+ example = ns1.DataSource("example",
148
+ name="example",
149
+ sourcetype="nsone_v1")
149
150
  ```
150
- <!--End PulumiCodeChooser -->
151
151
 
152
152
  ## NS1 Documentation
153
153
 
@@ -177,14 +177,14 @@ class DataSource(pulumi.CustomResource):
177
177
 
178
178
  ## Example Usage
179
179
 
180
- <!--Start PulumiCodeChooser -->
181
180
  ```python
182
181
  import pulumi
183
182
  import pulumi_ns1 as ns1
184
183
 
185
- example = ns1.DataSource("example", sourcetype="nsone_v1")
184
+ example = ns1.DataSource("example",
185
+ name="example",
186
+ sourcetype="nsone_v1")
186
187
  ```
187
- <!--End PulumiCodeChooser -->
188
188
 
189
189
  ## NS1 Documentation
190
190
 
pulumi_ns1/get_dns_sec.py CHANGED
@@ -86,18 +86,16 @@ def get_dns_sec(zone: Optional[str] = None,
86
86
 
87
87
  ## Example Usage
88
88
 
89
- <!--Start PulumiCodeChooser -->
90
89
  ```python
91
90
  import pulumi
92
91
  import pulumi_ns1 as ns1
93
92
 
94
93
  # Get DNSSEC details about a NS1 Zone.
95
- example_zone = ns1.Zone("exampleZone",
96
- dnssec=True,
97
- zone="terraform.example.io")
98
- example_dns_sec = ns1.get_dns_sec_output(zone=example_zone.zone)
94
+ example_zone = ns1.Zone("example",
95
+ zone="terraform.example.io",
96
+ dnssec=True)
97
+ example = ns1.get_dns_sec_output(zone=example_zone.zone)
99
98
  ```
100
- <!--End PulumiCodeChooser -->
101
99
 
102
100
 
103
101
  :param str zone: The name of the zone to get DNSSEC details for.
@@ -122,18 +120,16 @@ def get_dns_sec_output(zone: Optional[pulumi.Input[str]] = None,
122
120
 
123
121
  ## Example Usage
124
122
 
125
- <!--Start PulumiCodeChooser -->
126
123
  ```python
127
124
  import pulumi
128
125
  import pulumi_ns1 as ns1
129
126
 
130
127
  # Get DNSSEC details about a NS1 Zone.
131
- example_zone = ns1.Zone("exampleZone",
132
- dnssec=True,
133
- zone="terraform.example.io")
134
- example_dns_sec = ns1.get_dns_sec_output(zone=example_zone.zone)
128
+ example_zone = ns1.Zone("example",
129
+ zone="terraform.example.io",
130
+ dnssec=True)
131
+ example = ns1.get_dns_sec_output(zone=example_zone.zone)
135
132
  ```
136
- <!--End PulumiCodeChooser -->
137
133
 
138
134
 
139
135
  :param str zone: The name of the zone to get DNSSEC details for.
@@ -66,14 +66,13 @@ def get_monitoring_regions(regions: Optional[Sequence[pulumi.InputType['GetMonit
66
66
 
67
67
  ## Example Usage
68
68
 
69
- <!--Start PulumiCodeChooser -->
70
69
  ```python
71
70
  import pulumi
72
71
  import pulumi_ns1 as ns1
73
72
 
73
+ # Get details of all available monitoring regions.
74
74
  example = ns1.get_monitoring_regions()
75
75
  ```
76
- <!--End PulumiCodeChooser -->
77
76
 
78
77
 
79
78
  :param Sequence[pulumi.InputType['GetMonitoringRegionsRegionArgs']] regions: A set of the available monitoring regions. Regions is
@@ -97,14 +96,13 @@ def get_monitoring_regions_output(regions: Optional[pulumi.Input[Optional[Sequen
97
96
 
98
97
  ## Example Usage
99
98
 
100
- <!--Start PulumiCodeChooser -->
101
99
  ```python
102
100
  import pulumi
103
101
  import pulumi_ns1 as ns1
104
102
 
103
+ # Get details of all available monitoring regions.
105
104
  example = ns1.get_monitoring_regions()
106
105
  ```
107
- <!--End PulumiCodeChooser -->
108
106
 
109
107
 
110
108
  :param Sequence[pulumi.InputType['GetMonitoringRegionsRegionArgs']] regions: A set of the available monitoring regions. Regions is
@@ -66,14 +66,13 @@ def get_networks(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetNet
66
66
 
67
67
  ## Example Usage
68
68
 
69
- <!--Start PulumiCodeChooser -->
70
69
  ```python
71
70
  import pulumi
72
71
  import pulumi_ns1 as ns1
73
72
 
73
+ # Get details about NS1 Networks.
74
74
  example = ns1.get_networks()
75
75
  ```
76
- <!--End PulumiCodeChooser -->
77
76
  """
78
77
  __args__ = dict()
79
78
  opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
@@ -93,13 +92,12 @@ def get_networks_output(opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.O
93
92
 
94
93
  ## Example Usage
95
94
 
96
- <!--Start PulumiCodeChooser -->
97
95
  ```python
98
96
  import pulumi
99
97
  import pulumi_ns1 as ns1
100
98
 
99
+ # Get details about NS1 Networks.
101
100
  example = ns1.get_networks()
102
101
  ```
103
- <!--End PulumiCodeChooser -->
104
102
  """
105
103
  ...
pulumi_ns1/get_record.py CHANGED
@@ -194,16 +194,15 @@ def get_record(domain: Optional[str] = None,
194
194
 
195
195
  ## Example Usage
196
196
 
197
- <!--Start PulumiCodeChooser -->
198
197
  ```python
199
198
  import pulumi
200
199
  import pulumi_ns1 as ns1
201
200
 
202
- example = ns1.get_record(domain="terraform.example.io",
203
- type="A",
204
- zone="example.io")
201
+ # Get details about a NS1 Record.
202
+ example = ns1.get_record(zone="example.io",
203
+ domain="terraform.example.io",
204
+ type="A")
205
205
  ```
206
- <!--End PulumiCodeChooser -->
207
206
 
208
207
 
209
208
  :param str domain: The records' domain.
@@ -246,16 +245,15 @@ def get_record_output(domain: Optional[pulumi.Input[str]] = None,
246
245
 
247
246
  ## Example Usage
248
247
 
249
- <!--Start PulumiCodeChooser -->
250
248
  ```python
251
249
  import pulumi
252
250
  import pulumi_ns1 as ns1
253
251
 
254
- example = ns1.get_record(domain="terraform.example.io",
255
- type="A",
256
- zone="example.io")
252
+ # Get details about a NS1 Record.
253
+ example = ns1.get_record(zone="example.io",
254
+ domain="terraform.example.io",
255
+ type="A")
257
256
  ```
258
- <!--End PulumiCodeChooser -->
259
257
 
260
258
 
261
259
  :param str domain: The records' domain.
pulumi_ns1/get_zone.py CHANGED
@@ -252,14 +252,13 @@ def get_zone(additional_ports: Optional[Sequence[int]] = None,
252
252
 
253
253
  ## Example Usage
254
254
 
255
- <!--Start PulumiCodeChooser -->
256
255
  ```python
257
256
  import pulumi
258
257
  import pulumi_ns1 as ns1
259
258
 
259
+ # Get details about a NS1 Zone.
260
260
  example = ns1.get_zone(zone="terraform.example.io")
261
261
  ```
262
- <!--End PulumiCodeChooser -->
263
262
 
264
263
 
265
264
  :param Sequence[str] additional_primaries: List of additional IPv4 addresses for the primary
@@ -308,14 +307,13 @@ def get_zone_output(additional_ports: Optional[pulumi.Input[Optional[Sequence[in
308
307
 
309
308
  ## Example Usage
310
309
 
311
- <!--Start PulumiCodeChooser -->
312
310
  ```python
313
311
  import pulumi
314
312
  import pulumi_ns1 as ns1
315
313
 
314
+ # Get details about a NS1 Zone.
316
315
  example = ns1.get_zone(zone="terraform.example.io")
317
316
  ```
318
- <!--End PulumiCodeChooser -->
319
317
 
320
318
 
321
319
  :param Sequence[str] additional_primaries: List of additional IPv4 addresses for the primary
@@ -564,36 +564,35 @@ class MonitoringJob(pulumi.CustomResource):
564
564
 
565
565
  ## Example Usage
566
566
 
567
- <!--Start PulumiCodeChooser -->
568
567
  ```python
569
568
  import pulumi
570
569
  import pulumi_ns1 as ns1
571
570
 
572
- uswest_monitor = ns1.MonitoringJob("uswestMonitor",
571
+ uswest_monitor = ns1.MonitoringJob("uswest_monitor",
572
+ name="uswest",
573
573
  active=True,
574
- config={
575
- "host": "example-elb-uswest.aws.amazon.com",
576
- "port": 443,
577
- "send": "HEAD / HTTP/1.0\\\\r\\\\n\\\\r\\\\n",
578
- "ssl": 1,
579
- },
580
- frequency=60,
581
- job_type="tcp",
582
- mute=True,
583
- policy="quorum",
584
- rapid_recheck=True,
585
574
  regions=[
586
575
  "lga",
587
576
  "sjc",
588
577
  "sin",
589
578
  ],
579
+ job_type="tcp",
580
+ frequency=60,
581
+ rapid_recheck=True,
582
+ policy="quorum",
583
+ mute=True,
584
+ config={
585
+ "ssl": 1,
586
+ "send": "HEAD / HTTP/1.0\\\\r\\\\n\\\\r\\\\n",
587
+ "port": 443,
588
+ "host": "example-elb-uswest.aws.amazon.com",
589
+ },
590
590
  rules=[ns1.MonitoringJobRuleArgs(
591
+ value="200 OK",
591
592
  comparison="contains",
592
593
  key="output",
593
- value="200 OK",
594
594
  )])
595
595
  ```
596
- <!--End PulumiCodeChooser -->
597
596
 
598
597
  ## NS1 Documentation
599
598
 
@@ -636,36 +635,35 @@ class MonitoringJob(pulumi.CustomResource):
636
635
 
637
636
  ## Example Usage
638
637
 
639
- <!--Start PulumiCodeChooser -->
640
638
  ```python
641
639
  import pulumi
642
640
  import pulumi_ns1 as ns1
643
641
 
644
- uswest_monitor = ns1.MonitoringJob("uswestMonitor",
642
+ uswest_monitor = ns1.MonitoringJob("uswest_monitor",
643
+ name="uswest",
645
644
  active=True,
646
- config={
647
- "host": "example-elb-uswest.aws.amazon.com",
648
- "port": 443,
649
- "send": "HEAD / HTTP/1.0\\\\r\\\\n\\\\r\\\\n",
650
- "ssl": 1,
651
- },
652
- frequency=60,
653
- job_type="tcp",
654
- mute=True,
655
- policy="quorum",
656
- rapid_recheck=True,
657
645
  regions=[
658
646
  "lga",
659
647
  "sjc",
660
648
  "sin",
661
649
  ],
650
+ job_type="tcp",
651
+ frequency=60,
652
+ rapid_recheck=True,
653
+ policy="quorum",
654
+ mute=True,
655
+ config={
656
+ "ssl": 1,
657
+ "send": "HEAD / HTTP/1.0\\\\r\\\\n\\\\r\\\\n",
658
+ "port": 443,
659
+ "host": "example-elb-uswest.aws.amazon.com",
660
+ },
662
661
  rules=[ns1.MonitoringJobRuleArgs(
662
+ value="200 OK",
663
663
  comparison="contains",
664
664
  key="output",
665
- value="200 OK",
666
665
  )])
667
666
  ```
668
- <!--End PulumiCodeChooser -->
669
667
 
670
668
  ## NS1 Documentation
671
669