pulumi-dnsimple 3.5.0a1710156168__py3-none-any.whl → 4.3.0a1736849266__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
@@ -142,27 +179,29 @@ class Domain(pulumi.CustomResource):
 
         ## Example Usage
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_dnsimple as dnsimple
 
         # Create a domain
-        foobar = dnsimple.Domain("foobar", name=var["dnsimple"]["domain"])
+        foobar = dnsimple.Domain("foobar", name=dnsimple["domain"])
         ```
-        <!--End PulumiCodeChooser -->
 
         ## 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
+        bash
+
+        curl -u 'EMAIL:PASSWORD' https://api.dnsimple.com/v2/1234/domains?name_like=example.com | jq
 
         {
 
@@ -215,6 +254,8 @@ class Domain(pulumi.CustomResource):
         :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
@@ -227,27 +268,29 @@ class Domain(pulumi.CustomResource):
 
         ## Example Usage
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_dnsimple as dnsimple
 
         # Create a domain
-        foobar = dnsimple.Domain("foobar", name=var["dnsimple"]["domain"])
+        foobar = dnsimple.Domain("foobar", name=dnsimple["domain"])
         ```
-        <!--End PulumiCodeChooser -->
 
         ## 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
+        bash
+
+        curl -u 'EMAIL:PASSWORD' https://api.dnsimple.com/v2/1234/domains?name_like=example.com | jq
 
         {
 
@@ -355,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))
 
@@ -373,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
@@ -385,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")
 

pulumi_dnsimple/domain_delegation.py

@@ -0,0 +1,263 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+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__ = ['DomainDelegationArgs', 'DomainDelegation']
+
+@pulumi.input_type
+class DomainDelegationArgs:
+    def __init__(__self__, *,
+                 domain: pulumi.Input[str],
+                 name_servers: pulumi.Input[Sequence[pulumi.Input[str]]]):
+        """
+        The set of arguments for constructing a DomainDelegation resource.
+        :param pulumi.Input[str] domain: The domain name.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] name_servers: The list of name servers to delegate to.
+               
+               # Attributes Reference
+        """
+        pulumi.set(__self__, "domain", domain)
+        pulumi.set(__self__, "name_servers", name_servers)
+
+    @property
+    @pulumi.getter
+    def domain(self) -> pulumi.Input[str]:
+        """
+        The domain name.
+        """
+        return pulumi.get(self, "domain")
+
+    @domain.setter
+    def domain(self, value: pulumi.Input[str]):
+        pulumi.set(self, "domain", value)
+
+    @property
+    @pulumi.getter(name="nameServers")
+    def name_servers(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
+        """
+        The list of name servers to delegate to.
+
+        # Attributes Reference
+        """
+        return pulumi.get(self, "name_servers")
+
+    @name_servers.setter
+    def name_servers(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
+        pulumi.set(self, "name_servers", value)
+
+
+@pulumi.input_type
+class _DomainDelegationState:
+    def __init__(__self__, *,
+                 domain: Optional[pulumi.Input[str]] = None,
+                 name_servers: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
+        """
+        Input properties used for looking up and filtering DomainDelegation resources.
+        :param pulumi.Input[str] domain: The domain name.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] name_servers: The list of name servers to delegate to.
+               
+               # Attributes Reference
+        """
+        if domain is not None:
+            pulumi.set(__self__, "domain", domain)
+        if name_servers is not None:
+            pulumi.set(__self__, "name_servers", name_servers)
+
+    @property
+    @pulumi.getter
+    def domain(self) -> Optional[pulumi.Input[str]]:
+        """
+        The domain name.
+        """
+        return pulumi.get(self, "domain")
+
+    @domain.setter
+    def domain(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "domain", value)
+
+    @property
+    @pulumi.getter(name="nameServers")
+    def name_servers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
+        """
+        The list of name servers to delegate to.
+
+        # Attributes Reference
+        """
+        return pulumi.get(self, "name_servers")
+
+    @name_servers.setter
+    def name_servers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
+        pulumi.set(self, "name_servers", value)
+
+
+class DomainDelegation(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 domain: Optional[pulumi.Input[str]] = None,
+                 name_servers: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 __props__=None):
+        """
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_dnsimple as dnsimple
+
+        # Create a domain delegation
+        foobar = dnsimple.DomainDelegation("foobar",
+            domain=dnsimple["domain"],
+            name_servers=[
+                "ns1.example.org",
+                "ns2.example.com",
+            ])
+        ```
+
+        ## Import
+
+        DNSimple domain delegations can be imported using the domain name.
+
+        **Importing domain delegation for example.com**
+
+        bash
+
+        ```sh
+        $ pulumi import dnsimple:index/domainDelegation:DomainDelegation resource_name example.com
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] domain: The domain name.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] name_servers: The list of name servers to delegate to.
+               
+               # Attributes Reference
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: DomainDelegationArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_dnsimple as dnsimple
+
+        # Create a domain delegation
+        foobar = dnsimple.DomainDelegation("foobar",
+            domain=dnsimple["domain"],
+            name_servers=[
+                "ns1.example.org",
+                "ns2.example.com",
+            ])
+        ```
+
+        ## Import
+
+        DNSimple domain delegations can be imported using the domain name.
+
+        **Importing domain delegation for example.com**
+
+        bash
+
+        ```sh
+        $ pulumi import dnsimple:index/domainDelegation:DomainDelegation resource_name example.com
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param DomainDelegationArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(DomainDelegationArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 domain: Optional[pulumi.Input[str]] = None,
+                 name_servers: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = DomainDelegationArgs.__new__(DomainDelegationArgs)
+
+            if domain is None and not opts.urn:
+                raise TypeError("Missing required property 'domain'")
+            __props__.__dict__["domain"] = domain
+            if name_servers is None and not opts.urn:
+                raise TypeError("Missing required property 'name_servers'")
+            __props__.__dict__["name_servers"] = name_servers
+        super(DomainDelegation, __self__).__init__(
+            'dnsimple:index/domainDelegation:DomainDelegation',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            domain: Optional[pulumi.Input[str]] = None,
+            name_servers: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None) -> 'DomainDelegation':
+        """
+        Get an existing DomainDelegation resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :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[str] domain: The domain name.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] name_servers: The list of name servers to delegate to.
+               
+               # Attributes Reference
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _DomainDelegationState.__new__(_DomainDelegationState)
+
+        __props__.__dict__["domain"] = domain
+        __props__.__dict__["name_servers"] = name_servers
+        return DomainDelegation(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter
+    def domain(self) -> pulumi.Output[str]:
+        """
+        The domain name.
+        """
+        return pulumi.get(self, "domain")
+
+    @property
+    @pulumi.getter(name="nameServers")
+    def name_servers(self) -> pulumi.Output[Sequence[str]]:
+        """
+        The list of name servers to delegate to.
+
+        # Attributes Reference
+        """
+        return pulumi.get(self, "name_servers")
+