pulumi-ns1 3.0.0a1679049361__tar.gz → 3.0.2__tar.gz

{pulumi_ns1-3.0.0a1679049361 → pulumi_ns1-3.0.2}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.1
 Name: pulumi_ns1
-Version: 3.0.0a1679049361
+Version: 3.0.2
 Summary: A Pulumi package for creating and managing ns1 cloud resources.
 Home-page: https://pulumi.io
 License: Apache-2.0
 Project-URL: Repository, https://github.com/pulumi/pulumi-ns1
 Keywords: pulumi ns1
 Platform: UNKNOWN
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 
 [![Actions Status](https://github.com/pulumi/pulumi-ns1/workflows/master/badge.svg)](https://github.com/pulumi/pulumi-ns1/actions)

{pulumi_ns1-3.0.0a1679049361 → pulumi_ns1-3.0.2}/pulumi_ns1/_inputs.py

@@ -481,6 +481,26 @@ class RecordAnswerArgs:
                  region: Optional[pulumi.Input[str]] = None):
         """
         :param pulumi.Input[str] answer: Space delimited string of RDATA fields dependent on the record type.
+               
+               A:
+               
+               answer = "1.2.3.4"
+               
+               CNAME:
+               
+               answer = "www.example.com"
+               
+               MX:
+               
+               answer = "5 mail.example.com"
+               
+               SRV:
+               
+               answer = "10 0 2380 node-1.example.com"
+               
+               SPF:
+               
+               answer = "v=DKIM1; k=rsa; p=XXXXXXXX"
         :param pulumi.Input[str] region: 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
@@ -501,6 +521,26 @@ class RecordAnswerArgs:
     def answer(self) -> Optional[pulumi.Input[str]]:
         """
         Space delimited string of RDATA fields dependent on the record type.
+
+        A:
+
+        answer = "1.2.3.4"
+
+        CNAME:
+
+        answer = "www.example.com"
+
+        MX:
+
+        answer = "5 mail.example.com"
+
+        SRV:
+
+        answer = "10 0 2380 node-1.example.com"
+
+        SPF:
+
+        answer = "v=DKIM1; k=rsa; p=XXXXXXXX"
         """
         return pulumi.get(self, "answer")
 

{pulumi_ns1-3.0.0a1679049361 → pulumi_ns1-3.0.2}/pulumi_ns1/api_key.py

@@ -1134,6 +1134,41 @@ class APIKey(pulumi.CustomResource):
                  teams: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
         """
+        Provides a NS1 Api Key resource. This can be used to create, modify, and delete api keys.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_ns1 as ns1
+
+        example_team = ns1.Team("exampleTeam")
+        example_api_key = ns1.APIKey("exampleAPIKey",
+            teams=[example_team.id],
+            ip_whitelists=[
+                "1.1.1.1",
+                "2.2.2.2",
+            ],
+            dns_view_zones=False,
+            account_manage_users=False)
+        ```
+        ## Permissions
+
+        An API key will inherit permissions from the teams it is assigned to.
+        If a key is assigned to a team and also has individual permissions set on the key, the individual permissions
+        will be overridden by the inherited team permissions.
+        In a future release, setting permissions on a key that is part of a team will be explicitly disabled.
+
+        When a key is removed from all teams completely, it will inherit whatever permissions it had previously.
+        If a key is removed from all it's teams, it will probably be necessary to run `pulumi up` a second time
+        to update the keys permissions from it's old team permissions to new key-specific permissions.
+
+        See [the NS1 API docs](https://ns1.com/api#getget-all-account-users) for an overview of permission semantics or for [more details](https://help.ns1.com/hc/en-us/articles/360024409034-Managing-user-permissions) about the individual permission flags.
+
+        ## NS1 Documentation
+
+        [ApiKeys Api Doc](https://ns1.com/api#api-key)
+
         ## Import
 
         ```sh
@@ -1193,6 +1228,41 @@ class APIKey(pulumi.CustomResource):
                  args: Optional[APIKeyArgs] = None,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        Provides a NS1 Api Key resource. This can be used to create, modify, and delete api keys.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_ns1 as ns1
+
+        example_team = ns1.Team("exampleTeam")
+        example_api_key = ns1.APIKey("exampleAPIKey",
+            teams=[example_team.id],
+            ip_whitelists=[
+                "1.1.1.1",
+                "2.2.2.2",
+            ],
+            dns_view_zones=False,
+            account_manage_users=False)
+        ```
+        ## Permissions
+
+        An API key will inherit permissions from the teams it is assigned to.
+        If a key is assigned to a team and also has individual permissions set on the key, the individual permissions
+        will be overridden by the inherited team permissions.
+        In a future release, setting permissions on a key that is part of a team will be explicitly disabled.
+
+        When a key is removed from all teams completely, it will inherit whatever permissions it had previously.
+        If a key is removed from all it's teams, it will probably be necessary to run `pulumi up` a second time
+        to update the keys permissions from it's old team permissions to new key-specific permissions.
+
+        See [the NS1 API docs](https://ns1.com/api#getget-all-account-users) for an overview of permission semantics or for [more details](https://help.ns1.com/hc/en-us/articles/360024409034-Managing-user-permissions) about the individual permission flags.
+
+        ## NS1 Documentation
+
+        [ApiKeys Api Doc](https://ns1.com/api#api-key)
+
         ## Import
 
         ```sh

{pulumi_ns1-3.0.0a1679049361 → pulumi_ns1-3.0.2}/pulumi_ns1/outputs.py

@@ -463,6 +463,26 @@ class RecordAnswer(dict):
                  region: Optional[str] = None):
         """
         :param str answer: Space delimited string of RDATA fields dependent on the record type.
+               
+               A:
+               
+               answer = "1.2.3.4"
+               
+               CNAME:
+               
+               answer = "www.example.com"
+               
+               MX:
+               
+               answer = "5 mail.example.com"
+               
+               SRV:
+               
+               answer = "10 0 2380 node-1.example.com"
+               
+               SPF:
+               
+               answer = "v=DKIM1; k=rsa; p=XXXXXXXX"
         :param str region: 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
@@ -483,6 +503,26 @@ class RecordAnswer(dict):
     def answer(self) -> Optional[str]:
         """
         Space delimited string of RDATA fields dependent on the record type.
+
+        A:
+
+        answer = "1.2.3.4"
+
+        CNAME:
+
+        answer = "www.example.com"
+
+        MX:
+
+        answer = "5 mail.example.com"
+
+        SRV:
+
+        answer = "10 0 2380 node-1.example.com"
+
+        SPF:
+
+        answer = "v=DKIM1; k=rsa; p=XXXXXXXX"
         """
         return pulumi.get(self, "answer")
 

{pulumi_ns1-3.0.0a1679049361 → pulumi_ns1-3.0.2}/pulumi_ns1/user.py

@@ -1187,6 +1187,50 @@ class User(pulumi.CustomResource):
                  username: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
+        Provides a NS1 User resource. Creating a user sends an invitation email to the
+        user's email address. This can be used to create, modify, and delete users.
+        The credentials used must have the `manage_users` permission set.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_ns1 as ns1
+
+        example_team = ns1.Team("exampleTeam",
+            ip_whitelists=[
+                "1.1.1.1",
+                "2.2.2.2",
+            ],
+            dns_view_zones=False,
+            account_manage_users=False)
+        example_user = ns1.User("exampleUser",
+            username="example_user",
+            email="user@example.com",
+            teams=[example_team.id],
+            notify={
+                "billing": False,
+            })
+        ```
+        ## Permissions
+
+        A user will inherit permissions from the teams they are assigned to.
+        If a user is assigned to a team and also has individual permissions set on the user, the individual permissions
+        will be overridden by the inherited team permissions.
+        In a future release, setting permissions on a user that is part of a team will be explicitly disabled.
+
+        When a user is removed from all teams completely, they will inherit whatever permissions they had previously.
+        If a user is removed from all their teams, it will probably be necessary to run `pulumi up` a second time
+        to update the users permissions from their old team permissions to new user-specific permissions.
+
+        See [this NS1 Help Center article](https://help.ns1.com/hc/en-us/articles/360024409034-Managing-user-permissions) for an overview of user permission settings.
+
+        ## NS1 Documentation
+
+        [User Api Docs](https://ns1.com/api#user)
+
+        [Managing user permissions](https://help.ns1.com/hc/en-us/articles/360024409034-Managing-user-permissions)
+
         ## Import
 
         ```sh
@@ -1239,6 +1283,50 @@ class User(pulumi.CustomResource):
                  args: UserArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        Provides a NS1 User resource. Creating a user sends an invitation email to the
+        user's email address. This can be used to create, modify, and delete users.
+        The credentials used must have the `manage_users` permission set.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_ns1 as ns1
+
+        example_team = ns1.Team("exampleTeam",
+            ip_whitelists=[
+                "1.1.1.1",
+                "2.2.2.2",
+            ],
+            dns_view_zones=False,
+            account_manage_users=False)
+        example_user = ns1.User("exampleUser",
+            username="example_user",
+            email="user@example.com",
+            teams=[example_team.id],
+            notify={
+                "billing": False,
+            })
+        ```
+        ## Permissions
+
+        A user will inherit permissions from the teams they are assigned to.
+        If a user is assigned to a team and also has individual permissions set on the user, the individual permissions
+        will be overridden by the inherited team permissions.
+        In a future release, setting permissions on a user that is part of a team will be explicitly disabled.
+
+        When a user is removed from all teams completely, they will inherit whatever permissions they had previously.
+        If a user is removed from all their teams, it will probably be necessary to run `pulumi up` a second time
+        to update the users permissions from their old team permissions to new user-specific permissions.
+
+        See [this NS1 Help Center article](https://help.ns1.com/hc/en-us/articles/360024409034-Managing-user-permissions) for an overview of user permission settings.
+
+        ## NS1 Documentation
+
+        [User Api Docs](https://ns1.com/api#user)
+
+        [Managing user permissions](https://help.ns1.com/hc/en-us/articles/360024409034-Managing-user-permissions)
+
         ## Import
 
         ```sh

{pulumi_ns1-3.0.0a1679049361 → pulumi_ns1-3.0.2}/pulumi_ns1.egg-info/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.1
 Name: pulumi-ns1
-Version: 3.0.0a1679049361
+Version: 3.0.2
 Summary: A Pulumi package for creating and managing ns1 cloud resources.
 Home-page: https://pulumi.io
 License: Apache-2.0
 Project-URL: Repository, https://github.com/pulumi/pulumi-ns1
 Keywords: pulumi ns1
 Platform: UNKNOWN
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 
 [![Actions Status](https://github.com/pulumi/pulumi-ns1/workflows/master/badge.svg)](https://github.com/pulumi/pulumi-ns1/actions)

{pulumi_ns1-3.0.0a1679049361 → pulumi_ns1-3.0.2}/setup.py

@@ -8,8 +8,8 @@ from setuptools.command.install import install
 from subprocess import check_call
 
 
-VERSION = "3.0.0a1679049361"
-PLUGIN_VERSION = "3.0.0-alpha.1679049361+d66d8780"
+VERSION = "3.0.2"
+PLUGIN_VERSION = "3.0.2"
 
 class InstallPluginCommand(install):
     def run(self):
@@ -38,6 +38,7 @@ def readme():
 
 
 setup(name='pulumi_ns1',
+      python_requires='>=3.7',
       version=VERSION,
       description="A Pulumi package for creating and managing ns1 cloud resources.",
       long_description=readme(),