pulumi-dnsimple 3.5.0a1709211875__py3-none-any.whl → 4.3.0a1736832784__py3-none-any.whl

pulumi_dnsimple/domain.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 
 __all__ = ['DomainArgs', 'Domain']
@@ -18,6 +23,8 @@ class DomainArgs:
         """
         The set of arguments for constructing a Domain resource.
         :param pulumi.Input[str] name: The domain name to be created
+               
+               # Attributes Reference
         """
         pulumi.set(__self__, "name", name)
 
@@ -26,6 +33,8 @@ class DomainArgs:
     def name(self) -> pulumi.Input[str]:
         """
         The domain name to be created
+
+        # Attributes Reference
         """
         return pulumi.get(self, "name")
 
@@ -46,7 +55,15 @@ class _DomainState:
                  unicode_name: Optional[pulumi.Input[str]] = None):
         """
         Input properties used for looking up and filtering Domain resources.
+        :param pulumi.Input[int] account_id: The account ID for the domain.
+        :param pulumi.Input[bool] auto_renew: Whether the domain is set to auto-renew.
         :param pulumi.Input[str] name: The domain name to be created
+               
+               # Attributes Reference
+        :param pulumi.Input[bool] private_whois: Whether the domain has WhoIs privacy enabled.
+        :param pulumi.Input[int] registrant_id: The ID of the registrant (contact) for the domain.
+        :param pulumi.Input[str] state: The state of the domain.
+        :param pulumi.Input[str] unicode_name: The domain name in Unicode format.
         """
         if account_id is not None:
             pulumi.set(__self__, "account_id", account_id)
@@ -66,6 +83,9 @@ class _DomainState:
     @property
     @pulumi.getter(name="accountId")
     def account_id(self) -> Optional[pulumi.Input[int]]:
+        """
+        The account ID for the domain.
+        """
         return pulumi.get(self, "account_id")
 
     @account_id.setter
@@ -75,6 +95,9 @@ class _DomainState:
     @property
     @pulumi.getter(name="autoRenew")
     def auto_renew(self) -> Optional[pulumi.Input[bool]]:
+        """
+        Whether the domain is set to auto-renew.
+        """
         return pulumi.get(self, "auto_renew")
 
     @auto_renew.setter
@@ -86,6 +109,8 @@ class _DomainState:
     def name(self) -> Optional[pulumi.Input[str]]:
         """
         The domain name to be created
+
+        # Attributes Reference
         """
         return pulumi.get(self, "name")
 
@@ -96,6 +121,9 @@ class _DomainState:
     @property
     @pulumi.getter(name="privateWhois")
     def private_whois(self) -> Optional[pulumi.Input[bool]]:
+        """
+        Whether the domain has WhoIs privacy enabled.
+        """
         return pulumi.get(self, "private_whois")
 
     @private_whois.setter
@@ -105,6 +133,9 @@ class _DomainState:
     @property
     @pulumi.getter(name="registrantId")
     def registrant_id(self) -> Optional[pulumi.Input[int]]:
+        """
+        The ID of the registrant (contact) for the domain.
+        """
         return pulumi.get(self, "registrant_id")
 
     @registrant_id.setter
@@ -114,6 +145,9 @@ class _DomainState:
     @property
     @pulumi.getter
     def state(self) -> Optional[pulumi.Input[str]]:
+        """
+        The state of the domain.
+        """
         return pulumi.get(self, "state")
 
     @state.setter
@@ -123,6 +157,9 @@ class _DomainState:
     @property
     @pulumi.getter(name="unicodeName")
     def unicode_name(self) -> Optional[pulumi.Input[str]]:
+        """
+        The domain name in Unicode format.
+        """
         return pulumi.get(self, "unicode_name")
 
     @unicode_name.setter
@@ -147,72 +184,78 @@ class Domain(pulumi.CustomResource):
         import pulumi_dnsimple as dnsimple
 
         # Create a domain
-        foobar = dnsimple.Domain("foobar", name=var["dnsimple"]["domain"])
+        foobar = dnsimple.Domain("foobar", name=dnsimple["domain"])
         ```
 
         ## Import
 
         DNSimple domains can be imported using their numeric record ID.
 
+        bash
+
         ```sh
         $ pulumi import dnsimple:index/domain:Domain resource_name 5678
         ```
 
-         The record ID can be found within [DNSimple Domains API](https://developer.dnsimple.com/v2/domains/#listDomains). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
-
-         $ curl -u 'EMAIL:PASSWORD' https://api.dnsimple.com/v2/1234/domains?name_like=example.com | jq
-
-         {
-
-         "data": [
-
-         {
-
-         "id": 5678,
-
-         "account_id": 1234,
-
-         "registrant_id": null,
-
-         "name": "example.com",
-
-         "unicode_name": "example.com",
-
-         "state": "hosted",
-
-         "auto_renew": false,
-
-         "private_whois": false,
-
-         "expires_on": null,
-
-         "expires_at": null,
-
-         "created_at": "2021-10-01T00:00:00Z",
-
-         "updated_at": "2021-10-01T00:00:00Z"
-
-         }
-
-         ],
-
-         "pagination": {
-
-         "current_page": 1,
-
-         "per_page": 30,
-
-         "total_entries": 1,
-
-         "total_pages": 1
-
-         }
-
-         }
+        The record ID can be found within [DNSimple Domains API](https://developer.dnsimple.com/v2/domains/#listDomains). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
+
+        bash
+
+        curl -u 'EMAIL:PASSWORD' https://api.dnsimple.com/v2/1234/domains?name_like=example.com | jq
+
+        {
+
+          "data": [
+
+            {
+            
+              "id": 5678,
+            
+              "account_id": 1234,
+            
+              "registrant_id": null,
+            
+              "name": "example.com",
+            
+              "unicode_name": "example.com",
+            
+              "state": "hosted",
+            
+              "auto_renew": false,
+            
+              "private_whois": false,
+            
+              "expires_on": null,
+            
+              "expires_at": null,
+            
+              "created_at": "2021-10-01T00:00:00Z",
+            
+              "updated_at": "2021-10-01T00:00:00Z"
+            
+            }
+
+          ],
+
+          "pagination": {
+
+            "current_page": 1,
+            
+            "per_page": 30,
+            
+            "total_entries": 1,
+            
+            "total_pages": 1
+
+          }
+
+        }
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] name: The domain name to be created
+               
+               # Attributes Reference
         """
         ...
     @overload
@@ -230,68 +273,72 @@ class Domain(pulumi.CustomResource):
         import pulumi_dnsimple as dnsimple
 
         # Create a domain
-        foobar = dnsimple.Domain("foobar", name=var["dnsimple"]["domain"])
+        foobar = dnsimple.Domain("foobar", name=dnsimple["domain"])
         ```
 
         ## Import
 
         DNSimple domains can be imported using their numeric record ID.
 
+        bash
+
         ```sh
         $ pulumi import dnsimple:index/domain:Domain resource_name 5678
         ```
 
-         The record ID can be found within [DNSimple Domains API](https://developer.dnsimple.com/v2/domains/#listDomains). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
-
-         $ curl -u 'EMAIL:PASSWORD' https://api.dnsimple.com/v2/1234/domains?name_like=example.com | jq
-
-         {
-
-         "data": [
-
-         {
-
-         "id": 5678,
-
-         "account_id": 1234,
-
-         "registrant_id": null,
-
-         "name": "example.com",
-
-         "unicode_name": "example.com",
-
-         "state": "hosted",
-
-         "auto_renew": false,
-
-         "private_whois": false,
-
-         "expires_on": null,
-
-         "expires_at": null,
-
-         "created_at": "2021-10-01T00:00:00Z",
-
-         "updated_at": "2021-10-01T00:00:00Z"
-
-         }
-
-         ],
-
-         "pagination": {
-
-         "current_page": 1,
-
-         "per_page": 30,
-
-         "total_entries": 1,
-
-         "total_pages": 1
-
-         }
-
-         }
+        The record ID can be found within [DNSimple Domains API](https://developer.dnsimple.com/v2/domains/#listDomains). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
+
+        bash
+
+        curl -u 'EMAIL:PASSWORD' https://api.dnsimple.com/v2/1234/domains?name_like=example.com | jq
+
+        {
+
+          "data": [
+
+            {
+            
+              "id": 5678,
+            
+              "account_id": 1234,
+            
+              "registrant_id": null,
+            
+              "name": "example.com",
+            
+              "unicode_name": "example.com",
+            
+              "state": "hosted",
+            
+              "auto_renew": false,
+            
+              "private_whois": false,
+            
+              "expires_on": null,
+            
+              "expires_at": null,
+            
+              "created_at": "2021-10-01T00:00:00Z",
+            
+              "updated_at": "2021-10-01T00:00:00Z"
+            
+            }
+
+          ],
+
+          "pagination": {
+
+            "current_page": 1,
+            
+            "per_page": 30,
+            
+            "total_entries": 1,
+            
+            "total_pages": 1
+
+          }
+
+        }
 
         :param str resource_name: The name of the resource.
         :param DomainArgs args: The arguments to use to populate this resource's properties.
@@ -351,7 +398,15 @@ class Domain(pulumi.CustomResource):
         :param str resource_name: The unique name of the resulting resource.
         :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
         :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[int] account_id: The account ID for the domain.
+        :param pulumi.Input[bool] auto_renew: Whether the domain is set to auto-renew.
         :param pulumi.Input[str] name: The domain name to be created
+               
+               # Attributes Reference
+        :param pulumi.Input[bool] private_whois: Whether the domain has WhoIs privacy enabled.
+        :param pulumi.Input[int] registrant_id: The ID of the registrant (contact) for the domain.
+        :param pulumi.Input[str] state: The state of the domain.
+        :param pulumi.Input[str] unicode_name: The domain name in Unicode format.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -369,11 +424,17 @@ class Domain(pulumi.CustomResource):
     @property
     @pulumi.getter(name="accountId")
     def account_id(self) -> pulumi.Output[int]:
+        """
+        The account ID for the domain.
+        """
         return pulumi.get(self, "account_id")
 
     @property
     @pulumi.getter(name="autoRenew")
     def auto_renew(self) -> pulumi.Output[bool]:
+        """
+        Whether the domain is set to auto-renew.
+        """
         return pulumi.get(self, "auto_renew")
 
     @property
@@ -381,26 +442,40 @@ class Domain(pulumi.CustomResource):
     def name(self) -> pulumi.Output[str]:
         """
         The domain name to be created
+
+        # Attributes Reference
         """
         return pulumi.get(self, "name")
 
     @property
     @pulumi.getter(name="privateWhois")
     def private_whois(self) -> pulumi.Output[bool]:
+        """
+        Whether the domain has WhoIs privacy enabled.
+        """
         return pulumi.get(self, "private_whois")
 
     @property
     @pulumi.getter(name="registrantId")
     def registrant_id(self) -> pulumi.Output[int]:
+        """
+        The ID of the registrant (contact) for the domain.
+        """
         return pulumi.get(self, "registrant_id")
 
     @property
     @pulumi.getter
     def state(self) -> pulumi.Output[str]:
+        """
+        The state of the domain.
+        """
         return pulumi.get(self, "state")
 
     @property
     @pulumi.getter(name="unicodeName")
     def unicode_name(self) -> pulumi.Output[str]:
+        """
+        The domain name in Unicode format.
+        """
         return pulumi.get(self, "unicode_name")