pulumi-ns1 3.2.0a1698198143__py3-none-any.whl → 3.2.0a1698202392__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.
@@ -131,6 +131,19 @@ class AccountWhitelist(pulumi.CustomResource):
131
131
 
132
132
  This can be used to create, modify, and delete Global IP Whitelists.
133
133
 
134
+ ## Example Usage
135
+
136
+ ```python
137
+ import pulumi
138
+ import pulumi_ns1 as ns1
139
+
140
+ example = ns1.AccountWhitelist("example", values=[
141
+ "1.1.1.1",
142
+ "2.2.2.2",
143
+ ])
144
+ ```
145
+
146
+ > You current source IP must be present in one of the whitelists to prevent locking yourself out.
134
147
  ## NS1 Documentation
135
148
 
136
149
  [Global IP Whitelist Doc](https://ns1.com/api?docId=2282)
@@ -157,6 +170,19 @@ class AccountWhitelist(pulumi.CustomResource):
157
170
 
158
171
  This can be used to create, modify, and delete Global IP Whitelists.
159
172
 
173
+ ## Example Usage
174
+
175
+ ```python
176
+ import pulumi
177
+ import pulumi_ns1 as ns1
178
+
179
+ example = ns1.AccountWhitelist("example", values=[
180
+ "1.1.1.1",
181
+ "2.2.2.2",
182
+ ])
183
+ ```
184
+
185
+ > You current source IP must be present in one of the whitelists to prevent locking yourself out.
160
186
  ## NS1 Documentation
161
187
 
162
188
  [Global IP Whitelist Doc](https://ns1.com/api?docId=2282)
pulumi_ns1/api_key.py CHANGED
@@ -1410,6 +1410,22 @@ class APIKey(pulumi.CustomResource):
1410
1410
  """
1411
1411
  Provides a NS1 Api Key resource. This can be used to create, modify, and delete api keys.
1412
1412
 
1413
+ ## Example Usage
1414
+
1415
+ ```python
1416
+ import pulumi
1417
+ import pulumi_ns1 as ns1
1418
+
1419
+ example_team = ns1.Team("exampleTeam")
1420
+ example_api_key = ns1.APIKey("exampleAPIKey",
1421
+ teams=[example_team.id],
1422
+ ip_whitelists=[
1423
+ "1.1.1.1",
1424
+ "2.2.2.2",
1425
+ ],
1426
+ dns_view_zones=False,
1427
+ account_manage_users=False)
1428
+ ```
1413
1429
  ## Permissions
1414
1430
 
1415
1431
  An API key will inherit permissions from the teams it is assigned to.
@@ -1488,6 +1504,22 @@ class APIKey(pulumi.CustomResource):
1488
1504
  """
1489
1505
  Provides a NS1 Api Key resource. This can be used to create, modify, and delete api keys.
1490
1506
 
1507
+ ## Example Usage
1508
+
1509
+ ```python
1510
+ import pulumi
1511
+ import pulumi_ns1 as ns1
1512
+
1513
+ example_team = ns1.Team("exampleTeam")
1514
+ example_api_key = ns1.APIKey("exampleAPIKey",
1515
+ teams=[example_team.id],
1516
+ ip_whitelists=[
1517
+ "1.1.1.1",
1518
+ "2.2.2.2",
1519
+ ],
1520
+ dns_view_zones=False,
1521
+ account_manage_users=False)
1522
+ ```
1491
1523
  ## Permissions
1492
1524
 
1493
1525
  An API key will inherit permissions from the teams it is assigned to.
pulumi_ns1/application.py CHANGED
@@ -265,6 +265,21 @@ class Application(pulumi.CustomResource):
265
265
  """
266
266
  Provides a NS1 Pulsar application resource. This can be used to create, modify, and delete applications.
267
267
 
268
+ ## Example Usage
269
+
270
+ ```python
271
+ import pulumi
272
+ import pulumi_ns1 as ns1
273
+
274
+ # Create a new pulsar application with default config
275
+ ns1_app = ns1.Application("ns1App", default_config=ns1.ApplicationDefaultConfigArgs(
276
+ http=True,
277
+ https=False,
278
+ job_timeout_millis=100,
279
+ request_timeout_millis=100,
280
+ static_values=True,
281
+ ))
282
+ ```
268
283
  ## NS1 Documentation
269
284
 
270
285
  [Application Api Docs](https://ns1.com/api#get-list-pulsar-applications)
@@ -301,6 +316,21 @@ class Application(pulumi.CustomResource):
301
316
  """
302
317
  Provides a NS1 Pulsar application resource. This can be used to create, modify, and delete applications.
303
318
 
319
+ ## Example Usage
320
+
321
+ ```python
322
+ import pulumi
323
+ import pulumi_ns1 as ns1
324
+
325
+ # Create a new pulsar application with default config
326
+ ns1_app = ns1.Application("ns1App", default_config=ns1.ApplicationDefaultConfigArgs(
327
+ http=True,
328
+ https=False,
329
+ job_timeout_millis=100,
330
+ request_timeout_millis=100,
331
+ static_values=True,
332
+ ))
333
+ ```
304
334
  ## NS1 Documentation
305
335
 
306
336
  [Application Api Docs](https://ns1.com/api#get-list-pulsar-applications)
pulumi_ns1/data_feed.py CHANGED
@@ -174,6 +174,30 @@ class DataFeed(pulumi.CustomResource):
174
174
  """
175
175
  Provides a NS1 Data Feed resource. This can be used to create, modify, and delete data feeds.
176
176
 
177
+ ## Example Usage
178
+
179
+ ```python
180
+ import pulumi
181
+ import pulumi_ns1 as ns1
182
+
183
+ example = ns1.DataSource("example", sourcetype="nsone_v1")
184
+ example_monitoring = ns1.DataSource("exampleMonitoring", sourcetype="nsone_monitoring")
185
+ uswest_feed = ns1.DataFeed("uswestFeed",
186
+ source_id=example.id,
187
+ config={
188
+ "label": "uswest",
189
+ })
190
+ useast_feed = ns1.DataFeed("useastFeed",
191
+ source_id=example.id,
192
+ config={
193
+ "label": "useast",
194
+ })
195
+ useast_monitor_feed = ns1.DataFeed("useastMonitorFeed",
196
+ source_id=example_monitoring.id,
197
+ config={
198
+ "jobid": ns1_monitoringjob["example_job"]["id"],
199
+ })
200
+ ```
177
201
  ## NS1 Documentation
178
202
 
179
203
  [Datafeed Api Doc](https://ns1.com/api#data-feeds)
@@ -200,6 +224,30 @@ class DataFeed(pulumi.CustomResource):
200
224
  """
201
225
  Provides a NS1 Data Feed resource. This can be used to create, modify, and delete data feeds.
202
226
 
227
+ ## Example Usage
228
+
229
+ ```python
230
+ import pulumi
231
+ import pulumi_ns1 as ns1
232
+
233
+ example = ns1.DataSource("example", sourcetype="nsone_v1")
234
+ example_monitoring = ns1.DataSource("exampleMonitoring", sourcetype="nsone_monitoring")
235
+ uswest_feed = ns1.DataFeed("uswestFeed",
236
+ source_id=example.id,
237
+ config={
238
+ "label": "uswest",
239
+ })
240
+ useast_feed = ns1.DataFeed("useastFeed",
241
+ source_id=example.id,
242
+ config={
243
+ "label": "useast",
244
+ })
245
+ useast_monitor_feed = ns1.DataFeed("useastMonitorFeed",
246
+ source_id=example_monitoring.id,
247
+ config={
248
+ "jobid": ns1_monitoringjob["example_job"]["id"],
249
+ })
250
+ ```
203
251
  ## NS1 Documentation
204
252
 
205
253
  [Datafeed Api Doc](https://ns1.com/api#data-feeds)
pulumi_ns1/data_source.py CHANGED
@@ -170,6 +170,14 @@ class DataSource(pulumi.CustomResource):
170
170
  """
171
171
  Provides a NS1 Data Source resource. This can be used to create, modify, and delete data sources.
172
172
 
173
+ ## Example Usage
174
+
175
+ ```python
176
+ import pulumi
177
+ import pulumi_ns1 as ns1
178
+
179
+ example = ns1.DataSource("example", sourcetype="nsone_v1")
180
+ ```
173
181
  ## NS1 Documentation
174
182
 
175
183
  [Datasource Api Doc](https://ns1.com/api#data-sources)
@@ -196,6 +204,14 @@ class DataSource(pulumi.CustomResource):
196
204
  """
197
205
  Provides a NS1 Data Source resource. This can be used to create, modify, and delete data sources.
198
206
 
207
+ ## Example Usage
208
+
209
+ ```python
210
+ import pulumi
211
+ import pulumi_ns1 as ns1
212
+
213
+ example = ns1.DataSource("example", sourcetype="nsone_v1")
214
+ ```
199
215
  ## NS1 Documentation
200
216
 
201
217
  [Datasource Api Doc](https://ns1.com/api#data-sources)
pulumi_ns1/get_dns_sec.py CHANGED
@@ -84,6 +84,19 @@ def get_dns_sec(zone: Optional[str] = None,
84
84
  """
85
85
  Provides DNSSEC details about a NS1 Zone.
86
86
 
87
+ ## Example Usage
88
+
89
+ ```python
90
+ import pulumi
91
+ import pulumi_ns1 as ns1
92
+
93
+ # Get DNSSEC details about a NS1 Zone.
94
+ example_zone = ns1.Zone("exampleZone",
95
+ dnssec=True,
96
+ zone="terraform.example.io")
97
+ example_dns_sec = ns1.get_dns_sec_output(zone=example_zone.zone)
98
+ ```
99
+
87
100
 
88
101
  :param str zone: The name of the zone to get DNSSEC details for.
89
102
  """
@@ -105,6 +118,19 @@ def get_dns_sec_output(zone: Optional[pulumi.Input[str]] = None,
105
118
  """
106
119
  Provides DNSSEC details about a NS1 Zone.
107
120
 
121
+ ## Example Usage
122
+
123
+ ```python
124
+ import pulumi
125
+ import pulumi_ns1 as ns1
126
+
127
+ # Get DNSSEC details about a NS1 Zone.
128
+ example_zone = ns1.Zone("exampleZone",
129
+ dnssec=True,
130
+ zone="terraform.example.io")
131
+ example_dns_sec = ns1.get_dns_sec_output(zone=example_zone.zone)
132
+ ```
133
+
108
134
 
109
135
  :param str zone: The name of the zone to get DNSSEC details for.
110
136
  """
@@ -63,6 +63,15 @@ def get_networks(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetNet
63
63
  Provides details about NS1 Networks. Use this if you would simply like to read
64
64
  information from NS1 into your configurations. For read/write operations, you
65
65
  should use a resource.
66
+
67
+ ## Example Usage
68
+
69
+ ```python
70
+ import pulumi
71
+ import pulumi_ns1 as ns1
72
+
73
+ example = ns1.get_networks()
74
+ ```
66
75
  """
67
76
  __args__ = dict()
68
77
  opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
@@ -79,5 +88,14 @@ def get_networks_output(opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.O
79
88
  Provides details about NS1 Networks. Use this if you would simply like to read
80
89
  information from NS1 into your configurations. For read/write operations, you
81
90
  should use a resource.
91
+
92
+ ## Example Usage
93
+
94
+ ```python
95
+ import pulumi
96
+ import pulumi_ns1 as ns1
97
+
98
+ example = ns1.get_networks()
99
+ ```
82
100
  """
83
101
  ...
pulumi_ns1/get_record.py CHANGED
@@ -192,6 +192,17 @@ def get_record(domain: Optional[str] = None,
192
192
  information from NS1 into your configurations. For read/write operations, you
193
193
  should use a resource.
194
194
 
195
+ ## Example Usage
196
+
197
+ ```python
198
+ import pulumi
199
+ import pulumi_ns1 as ns1
200
+
201
+ example = ns1.get_record(domain="terraform.example.io",
202
+ type="A",
203
+ zone="example.io")
204
+ ```
205
+
195
206
 
196
207
  :param str domain: The records' domain.
197
208
  :param str type: The records' RR type.
@@ -231,6 +242,17 @@ def get_record_output(domain: Optional[pulumi.Input[str]] = None,
231
242
  information from NS1 into your configurations. For read/write operations, you
232
243
  should use a resource.
233
244
 
245
+ ## Example Usage
246
+
247
+ ```python
248
+ import pulumi
249
+ import pulumi_ns1 as ns1
250
+
251
+ example = ns1.get_record(domain="terraform.example.io",
252
+ type="A",
253
+ zone="example.io")
254
+ ```
255
+
234
256
 
235
257
  :param str domain: The records' domain.
236
258
  :param str type: The records' RR type.
pulumi_ns1/get_zone.py CHANGED
@@ -250,6 +250,15 @@ def get_zone(additional_ports: Optional[Sequence[int]] = None,
250
250
  information from NS1 into your configurations. For read/write operations, you
251
251
  should use a resource.
252
252
 
253
+ ## Example Usage
254
+
255
+ ```python
256
+ import pulumi
257
+ import pulumi_ns1 as ns1
258
+
259
+ example = ns1.get_zone(zone="terraform.example.io")
260
+ ```
261
+
253
262
 
254
263
  :param Sequence[str] additional_primaries: List of additional IPv4 addresses for the primary
255
264
  zone.
@@ -295,6 +304,15 @@ def get_zone_output(additional_ports: Optional[pulumi.Input[Optional[Sequence[in
295
304
  information from NS1 into your configurations. For read/write operations, you
296
305
  should use a resource.
297
306
 
307
+ ## Example Usage
308
+
309
+ ```python
310
+ import pulumi
311
+ import pulumi_ns1 as ns1
312
+
313
+ example = ns1.get_zone(zone="terraform.example.io")
314
+ ```
315
+
298
316
 
299
317
  :param Sequence[str] additional_primaries: List of additional IPv4 addresses for the primary
300
318
  zone.
@@ -680,6 +680,36 @@ class MonitoringJob(pulumi.CustomResource):
680
680
  """
681
681
  Provides a NS1 Monitoring Job resource. This can be used to create, modify, and delete monitoring jobs.
682
682
 
683
+ ## Example Usage
684
+
685
+ ```python
686
+ import pulumi
687
+ import pulumi_ns1 as ns1
688
+
689
+ uswest_monitor = ns1.MonitoringJob("uswestMonitor",
690
+ active=True,
691
+ config={
692
+ "host": "example-elb-uswest.aws.amazon.com",
693
+ "port": 443,
694
+ "send": "HEAD / HTTP/1.0\\\\r\\\\n\\\\r\\\\n",
695
+ "ssl": 1,
696
+ },
697
+ frequency=60,
698
+ job_type="tcp",
699
+ mute=True,
700
+ policy="quorum",
701
+ rapid_recheck=True,
702
+ regions=[
703
+ "lga",
704
+ "sjc",
705
+ "sin",
706
+ ],
707
+ rules=[ns1.MonitoringJobRuleArgs(
708
+ comparison="contains",
709
+ key="output",
710
+ value="200 OK",
711
+ )])
712
+ ```
683
713
  ## NS1 Documentation
684
714
 
685
715
  [MonitoringJob Api Doc](https://ns1.com/api#monitoring-jobs)
@@ -719,6 +749,36 @@ class MonitoringJob(pulumi.CustomResource):
719
749
  """
720
750
  Provides a NS1 Monitoring Job resource. This can be used to create, modify, and delete monitoring jobs.
721
751
 
752
+ ## Example Usage
753
+
754
+ ```python
755
+ import pulumi
756
+ import pulumi_ns1 as ns1
757
+
758
+ uswest_monitor = ns1.MonitoringJob("uswestMonitor",
759
+ active=True,
760
+ config={
761
+ "host": "example-elb-uswest.aws.amazon.com",
762
+ "port": 443,
763
+ "send": "HEAD / HTTP/1.0\\\\r\\\\n\\\\r\\\\n",
764
+ "ssl": 1,
765
+ },
766
+ frequency=60,
767
+ job_type="tcp",
768
+ mute=True,
769
+ policy="quorum",
770
+ rapid_recheck=True,
771
+ regions=[
772
+ "lga",
773
+ "sjc",
774
+ "sin",
775
+ ],
776
+ rules=[ns1.MonitoringJobRuleArgs(
777
+ comparison="contains",
778
+ key="output",
779
+ value="200 OK",
780
+ )])
781
+ ```
722
782
  ## NS1 Documentation
723
783
 
724
784
  [MonitoringJob Api Doc](https://ns1.com/api#monitoring-jobs)
pulumi_ns1/notify_list.py CHANGED
@@ -130,6 +130,27 @@ class NotifyList(pulumi.CustomResource):
130
130
  """
131
131
  Provides a NS1 Notify List resource. This can be used to create, modify, and delete notify lists.
132
132
 
133
+ ## Example Usage
134
+
135
+ ```python
136
+ import pulumi
137
+ import pulumi_ns1 as ns1
138
+
139
+ nl = ns1.NotifyList("nl", notifications=[
140
+ ns1.NotifyListNotificationArgs(
141
+ config={
142
+ "url": "http://www.mywebhook.com",
143
+ },
144
+ type="webhook",
145
+ ),
146
+ ns1.NotifyListNotificationArgs(
147
+ config={
148
+ "email": "test@test.com",
149
+ },
150
+ type="email",
151
+ ),
152
+ ])
153
+ ```
133
154
  ## NS1 Documentation
134
155
 
135
156
  [NotifyList Api Doc](https://ns1.com/api#notification-lists)
@@ -154,6 +175,27 @@ class NotifyList(pulumi.CustomResource):
154
175
  """
155
176
  Provides a NS1 Notify List resource. This can be used to create, modify, and delete notify lists.
156
177
 
178
+ ## Example Usage
179
+
180
+ ```python
181
+ import pulumi
182
+ import pulumi_ns1 as ns1
183
+
184
+ nl = ns1.NotifyList("nl", notifications=[
185
+ ns1.NotifyListNotificationArgs(
186
+ config={
187
+ "url": "http://www.mywebhook.com",
188
+ },
189
+ type="webhook",
190
+ ),
191
+ ns1.NotifyListNotificationArgs(
192
+ config={
193
+ "email": "test@test.com",
194
+ },
195
+ type="email",
196
+ ),
197
+ ])
198
+ ```
157
199
  ## NS1 Documentation
158
200
 
159
201
  [NotifyList Api Doc](https://ns1.com/api#notification-lists)
pulumi_ns1/team.py CHANGED
@@ -1315,6 +1315,46 @@ class Team(pulumi.CustomResource):
1315
1315
  Provides a NS1 Team resource. This can be used to create, modify, and delete
1316
1316
  teams. The credentials used must have the `manage_teams` permission set.
1317
1317
 
1318
+ ## Example Usage
1319
+
1320
+ ```python
1321
+ import pulumi
1322
+ import pulumi_ns1 as ns1
1323
+
1324
+ # Create a new NS1 Team
1325
+ example = ns1.Team("example",
1326
+ account_manage_users=False,
1327
+ dns_view_zones=False,
1328
+ ip_whitelists=[
1329
+ ns1.TeamIpWhitelistArgs(
1330
+ name="whitelist-1",
1331
+ values=[
1332
+ "1.1.1.1",
1333
+ "2.2.2.2",
1334
+ ],
1335
+ ),
1336
+ ns1.TeamIpWhitelistArgs(
1337
+ name="whitelist-2",
1338
+ values=[
1339
+ "3.3.3.3",
1340
+ "4.4.4.4",
1341
+ ],
1342
+ ),
1343
+ ])
1344
+ # Another team
1345
+ example2 = ns1.Team("example2",
1346
+ data_manage_datasources=True,
1347
+ dns_records_allows=[ns1.TeamDnsRecordsAllowArgs(
1348
+ domain="terraform.example.io",
1349
+ include_subdomains=False,
1350
+ type="A",
1351
+ zone="example.io",
1352
+ )],
1353
+ dns_view_zones=True,
1354
+ dns_zones_allows=["mytest.zone"],
1355
+ dns_zones_allow_by_default=True,
1356
+ dns_zones_denies=["myother.zone"])
1357
+ ```
1318
1358
  ## NS1 Documentation
1319
1359
 
1320
1360
  [Team Api Docs](https://ns1.com/api#team)
@@ -1373,6 +1413,46 @@ class Team(pulumi.CustomResource):
1373
1413
  Provides a NS1 Team resource. This can be used to create, modify, and delete
1374
1414
  teams. The credentials used must have the `manage_teams` permission set.
1375
1415
 
1416
+ ## Example Usage
1417
+
1418
+ ```python
1419
+ import pulumi
1420
+ import pulumi_ns1 as ns1
1421
+
1422
+ # Create a new NS1 Team
1423
+ example = ns1.Team("example",
1424
+ account_manage_users=False,
1425
+ dns_view_zones=False,
1426
+ ip_whitelists=[
1427
+ ns1.TeamIpWhitelistArgs(
1428
+ name="whitelist-1",
1429
+ values=[
1430
+ "1.1.1.1",
1431
+ "2.2.2.2",
1432
+ ],
1433
+ ),
1434
+ ns1.TeamIpWhitelistArgs(
1435
+ name="whitelist-2",
1436
+ values=[
1437
+ "3.3.3.3",
1438
+ "4.4.4.4",
1439
+ ],
1440
+ ),
1441
+ ])
1442
+ # Another team
1443
+ example2 = ns1.Team("example2",
1444
+ data_manage_datasources=True,
1445
+ dns_records_allows=[ns1.TeamDnsRecordsAllowArgs(
1446
+ domain="terraform.example.io",
1447
+ include_subdomains=False,
1448
+ type="A",
1449
+ zone="example.io",
1450
+ )],
1451
+ dns_view_zones=True,
1452
+ dns_zones_allows=["mytest.zone"],
1453
+ dns_zones_allow_by_default=True,
1454
+ dns_zones_denies=["myother.zone"])
1455
+ ```
1376
1456
  ## NS1 Documentation
1377
1457
 
1378
1458
  [Team Api Docs](https://ns1.com/api#team)
pulumi_ns1/tsigkey.py CHANGED
@@ -167,6 +167,16 @@ class Tsigkey(pulumi.CustomResource):
167
167
  """
168
168
  Provides a NS1 TSIG Key resource. This can be used to create, modify, and delete TSIG keys.
169
169
 
170
+ ## Example Usage
171
+
172
+ ```python
173
+ import pulumi
174
+ import pulumi_ns1 as ns1
175
+
176
+ example = ns1.Tsigkey("example",
177
+ algorithm="hmac-sha256",
178
+ secret="Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLA==")
179
+ ```
170
180
  ## NS1 Documentation
171
181
 
172
182
  [TSIG Keys Api Doc](https://ns1.com/api/#tsig)
@@ -192,6 +202,16 @@ class Tsigkey(pulumi.CustomResource):
192
202
  """
193
203
  Provides a NS1 TSIG Key resource. This can be used to create, modify, and delete TSIG keys.
194
204
 
205
+ ## Example Usage
206
+
207
+ ```python
208
+ import pulumi
209
+ import pulumi_ns1 as ns1
210
+
211
+ example = ns1.Tsigkey("example",
212
+ algorithm="hmac-sha256",
213
+ secret="Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLA==")
214
+ ```
195
215
  ## NS1 Documentation
196
216
 
197
217
  [TSIG Keys Api Doc](https://ns1.com/api/#tsig)
pulumi_ns1/user.py CHANGED
@@ -1479,6 +1479,27 @@ class User(pulumi.CustomResource):
1479
1479
  user's email address. This can be used to create, modify, and delete users.
1480
1480
  The credentials used must have the `manage_users` permission set.
1481
1481
 
1482
+ ## Example Usage
1483
+
1484
+ ```python
1485
+ import pulumi
1486
+ import pulumi_ns1 as ns1
1487
+
1488
+ example_team = ns1.Team("exampleTeam",
1489
+ ip_whitelists=[
1490
+ "1.1.1.1",
1491
+ "2.2.2.2",
1492
+ ],
1493
+ dns_view_zones=False,
1494
+ account_manage_users=False)
1495
+ example_user = ns1.User("exampleUser",
1496
+ username="example_user",
1497
+ email="user@example.com",
1498
+ teams=[example_team.id],
1499
+ notify={
1500
+ "billing": False,
1501
+ })
1502
+ ```
1482
1503
  ## Permissions
1483
1504
 
1484
1505
  A user will inherit permissions from the teams they are assigned to.
@@ -1554,6 +1575,27 @@ class User(pulumi.CustomResource):
1554
1575
  user's email address. This can be used to create, modify, and delete users.
1555
1576
  The credentials used must have the `manage_users` permission set.
1556
1577
 
1578
+ ## Example Usage
1579
+
1580
+ ```python
1581
+ import pulumi
1582
+ import pulumi_ns1 as ns1
1583
+
1584
+ example_team = ns1.Team("exampleTeam",
1585
+ ip_whitelists=[
1586
+ "1.1.1.1",
1587
+ "2.2.2.2",
1588
+ ],
1589
+ dns_view_zones=False,
1590
+ account_manage_users=False)
1591
+ example_user = ns1.User("exampleUser",
1592
+ username="example_user",
1593
+ email="user@example.com",
1594
+ teams=[example_team.id],
1595
+ notify={
1596
+ "billing": False,
1597
+ })
1598
+ ```
1557
1599
  ## Permissions
1558
1600
 
1559
1601
  A user will inherit permissions from the teams they are assigned to.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: pulumi-ns1
3
- Version: 3.2.0a1698198143
3
+ Version: 3.2.0a1698202392
4
4
  Summary: A Pulumi package for creating and managing ns1 cloud resources.
5
5
  License: Apache-2.0
6
6
  Project-URL: Homepage, https://pulumi.io
@@ -0,0 +1,32 @@
1
+ pulumi_ns1/__init__.py,sha256=8lpy_p-jVCOp2UOPbcTMwi58R1KEpXU-oZWj8L1LEdY,3244
2
+ pulumi_ns1/_inputs.py,sha256=W8v8BctBMjaumBkJtRcQAvVyxugPgyYjrMkouTfN3cQ,46398
3
+ pulumi_ns1/_utilities.py,sha256=gEJgwmfYYqdEGeUJsGQtt67DByZiBW4wytye4oezFWY,8705
4
+ pulumi_ns1/account_whitelist.py,sha256=WLa_C6GEkYrAAFhZ3p2Rbe1cH1E9DkzRYTfs6qVlKqM,10094
5
+ pulumi_ns1/api_key.py,sha256=4nH6RXvI8_Im0-w-e8a3Ri1LontSijfWR0FKfKK65tg,104106
6
+ pulumi_ns1/application.py,sha256=Qlp9dM2qw5s7fM0nEcEba7004xvoGewG7ao8pk-mOlo,20314
7
+ pulumi_ns1/data_feed.py,sha256=WDyVElvT9COkMUg9qOVyPKoEkyI5ZMVibjrzHwPwo2Q,13806
8
+ pulumi_ns1/data_source.py,sha256=yZIyatXUE0gAJYzUgzh7O9Ic3tHLSfgq39Izu7S7Kpk,12322
9
+ pulumi_ns1/dnsview.py,sha256=TW0TOQJPJ-pyrpOod3f5qe-IJk5uXINc7wFKUaswirI,16245
10
+ pulumi_ns1/get_dns_sec.py,sha256=85-0aHUyb6eM9_Pcp4FiYp_N3lajU8bLFNxg0khIiAE,4101
11
+ pulumi_ns1/get_networks.py,sha256=H5F3leftZNkabR4qHrPua0pyBSYxN0TifuEzHc8yef4,2966
12
+ pulumi_ns1/get_record.py,sha256=as_n_pw6QGyhh7URpQPTuNjd7ir4JvrHfgMtH0UzsoM,8817
13
+ pulumi_ns1/get_zone.py,sha256=VQemi8A161c6aw29jdtrRPghOCKhXxSL8eWzjWQqVKA,11258
14
+ pulumi_ns1/monitoring_job.py,sha256=ltpAPR4mVcAE9Am2mpo0SVJxPXYPe0KXZ_B-K4pEXBA,51067
15
+ pulumi_ns1/notify_list.py,sha256=Z9WJeJaNrZohSZ367LKhoUyI4SqJXV258Xu83ghs0-c,12025
16
+ pulumi_ns1/outputs.py,sha256=A3EeWUByA4qzy7YfbUFeogDsdYYjXX83_SvxkYX00eI,61402
17
+ pulumi_ns1/provider.py,sha256=R_9FSVcyis-mrowxGLQvw4qZ5v6IsqkM5v8r3V8eNv0,12193
18
+ pulumi_ns1/pulsar_job.py,sha256=-kUJ8BhmHcK8xAx2vp6kA9wncgww7H7ucIBEYEWOObc,20504
19
+ pulumi_ns1/pulumi-plugin.json,sha256=U1IwjH61SXsxMo8_PRJwqdmvSF-6MsDFM_LRS0M9Pow,40
20
+ pulumi_ns1/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
21
+ pulumi_ns1/record.py,sha256=CB84LCadXd3kOKJoNm9D6Cp0T08UdZhhyjdv4YGyd6U,41295
22
+ pulumi_ns1/subnet.py,sha256=MOVz_MdCmru1EWt0Pzs5EOpmQtE8AHL8byLcpbnJCiQ,23229
23
+ pulumi_ns1/team.py,sha256=HV3CbPQPd4hCZ1MREtsW9TVniL9-IRCt2Nczi1j5VIY,97772
24
+ pulumi_ns1/tsigkey.py,sha256=lddHSP3-vs8_s1ljQ8H1atn7HsPchs-vMh7gr-H-bsM,11309
25
+ pulumi_ns1/user.py,sha256=cN3HluOL448oiHnMPBlYcv16rdHNnRssSP4EzXL_oX0,106600
26
+ pulumi_ns1/zone.py,sha256=Oo2EsxpxSk2OmbrL7O7Eg6Lt6LCIE7dDyOSpz0zDbCE,48254
27
+ pulumi_ns1/config/__init__.py,sha256=cfY0smRZD3fDVc93ZIAxEl_IM2pynmXB52n3Ahzi030,285
28
+ pulumi_ns1/config/vars.py,sha256=jUHXTUgyrU_kiOzQNvb7QrLkhkhK9ZBln9SPGKN2Kms,1684
29
+ pulumi_ns1-3.2.0a1698202392.dist-info/METADATA,sha256=YcbSS-XiiyZg7YBSwpIthkOXhGXH59TQNVlqQQMLa5I,3047
30
+ pulumi_ns1-3.2.0a1698202392.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
31
+ pulumi_ns1-3.2.0a1698202392.dist-info/top_level.txt,sha256=Sndx9N4MHnSbjpwVT-_JZ8NZ7JzudJUIUQkU2-9GH9U,11
32
+ pulumi_ns1-3.2.0a1698202392.dist-info/RECORD,,
@@ -1,32 +0,0 @@
1
- pulumi_ns1/__init__.py,sha256=8lpy_p-jVCOp2UOPbcTMwi58R1KEpXU-oZWj8L1LEdY,3244
2
- pulumi_ns1/_inputs.py,sha256=W8v8BctBMjaumBkJtRcQAvVyxugPgyYjrMkouTfN3cQ,46398
3
- pulumi_ns1/_utilities.py,sha256=gEJgwmfYYqdEGeUJsGQtt67DByZiBW4wytye4oezFWY,8705
4
- pulumi_ns1/account_whitelist.py,sha256=eQwBLZfOaxOwSBN0P1WTR4bsJ6FhL9-4I2dseMROtOQ,9424
5
- pulumi_ns1/api_key.py,sha256=CMhUhKr9a4kA65gpskOUTS_IGi02K2IEt3hj6lzL6-8,103264
6
- pulumi_ns1/application.py,sha256=UE10aGDVWtpFFVIO-IL7AO9ywEjGk2DDs5eb6L2fesM,19446
7
- pulumi_ns1/data_feed.py,sha256=aBxvi-9y6XvI-mH8nH9VL11ivw6L0Utqi2R2NwWvbZw,12220
8
- pulumi_ns1/data_source.py,sha256=Fk4lI6os01J2AH612FovlXAFxePxFhgMSvZVOEHxN5w,11964
9
- pulumi_ns1/dnsview.py,sha256=TW0TOQJPJ-pyrpOod3f5qe-IJk5uXINc7wFKUaswirI,16245
10
- pulumi_ns1/get_dns_sec.py,sha256=nTjo6U-9NZHSuyhxjmOGop3oXd06UsZDfUV-WZjdKx4,3489
11
- pulumi_ns1/get_networks.py,sha256=MGfKvRhW84T62eUld6FGMVNZLEwYL_kEwFIORUSSoCM,2714
12
- pulumi_ns1/get_record.py,sha256=gnvY8CXmiNd6mt-3iZTFfzV23Pj18axHscZbiHbDIa4,8421
13
- pulumi_ns1/get_zone.py,sha256=uHVv9zuwiNBi9r6uC5kjAlfvDzKpewXjvRf_k3N5TQw,10960
14
- pulumi_ns1/monitoring_job.py,sha256=u7123O9O9RcsgzcF-wzTqdiXGihMaJ-adDkumoWF2QY,49429
15
- pulumi_ns1/notify_list.py,sha256=9-RlixLnz65TToEwifUYVRHMpQM--e5aqFdt6_Ao0gQ,10941
16
- pulumi_ns1/outputs.py,sha256=A3EeWUByA4qzy7YfbUFeogDsdYYjXX83_SvxkYX00eI,61402
17
- pulumi_ns1/provider.py,sha256=R_9FSVcyis-mrowxGLQvw4qZ5v6IsqkM5v8r3V8eNv0,12193
18
- pulumi_ns1/pulsar_job.py,sha256=-kUJ8BhmHcK8xAx2vp6kA9wncgww7H7ucIBEYEWOObc,20504
19
- pulumi_ns1/pulumi-plugin.json,sha256=U1IwjH61SXsxMo8_PRJwqdmvSF-6MsDFM_LRS0M9Pow,40
20
- pulumi_ns1/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
21
- pulumi_ns1/record.py,sha256=CB84LCadXd3kOKJoNm9D6Cp0T08UdZhhyjdv4YGyd6U,41295
22
- pulumi_ns1/subnet.py,sha256=MOVz_MdCmru1EWt0Pzs5EOpmQtE8AHL8byLcpbnJCiQ,23229
23
- pulumi_ns1/team.py,sha256=0wNuVt3AqGBSqJ_c4X6XSLKL4F6uhNxvFXNwER7sZnE,95280
24
- pulumi_ns1/tsigkey.py,sha256=RD4aNpKj29FRMi2T-nKgnzWzcqPkB5DmliUbhyP8zTo,10707
25
- pulumi_ns1/user.py,sha256=rju1hd6Iovki-X9r5GB928prupHE-bPHXgwmYIXz_eg,105482
26
- pulumi_ns1/zone.py,sha256=Oo2EsxpxSk2OmbrL7O7Eg6Lt6LCIE7dDyOSpz0zDbCE,48254
27
- pulumi_ns1/config/__init__.py,sha256=cfY0smRZD3fDVc93ZIAxEl_IM2pynmXB52n3Ahzi030,285
28
- pulumi_ns1/config/vars.py,sha256=jUHXTUgyrU_kiOzQNvb7QrLkhkhK9ZBln9SPGKN2Kms,1684
29
- pulumi_ns1-3.2.0a1698198143.dist-info/METADATA,sha256=5VEoG_c5F3Us8PbbjUS-FfMP9iEIYkUrQNUC3R1gAT0,3047
30
- pulumi_ns1-3.2.0a1698198143.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
31
- pulumi_ns1-3.2.0a1698198143.dist-info/top_level.txt,sha256=Sndx9N4MHnSbjpwVT-_JZ8NZ7JzudJUIUQkU2-9GH9U,11
32
- pulumi_ns1-3.2.0a1698198143.dist-info/RECORD,,