pulumi-dnsimple 3.4.2__tar.gz → 3.5.0__tar.gz

{pulumi_dnsimple-3.4.2 → pulumi_dnsimple-3.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pulumi_dnsimple
-Version: 3.4.2
+Version: 3.5.0
 Summary: A Pulumi package for creating and managing dnsimple cloud resources.
 License: Apache-2.0
 Project-URL: Homepage, https://pulumi.io

{pulumi_dnsimple-3.4.2 → pulumi_dnsimple-3.5.0}/pulumi_dnsimple/__init__.py

@@ -5,13 +5,13 @@
 from . import _utilities
 import typing
 # Export this package's modules as members:
+from ._enums import *
 from .domain import *
 from .email_forward import *
 from .get_certificate import *
 from .get_zone import *
 from .lets_encrypt_certificate import *
 from .provider import *
-from .record import *
 from .zone_record import *
 
 # Make subpackages available:
@@ -48,14 +48,6 @@ _utilities.register(
    "dnsimple:index/letsEncryptCertificate:LetsEncryptCertificate": "LetsEncryptCertificate"
   }
  },
- {
-  "pkg": "dnsimple",
-  "mod": "index/record",
-  "fqn": "pulumi_dnsimple",
-  "classes": {
-   "dnsimple:index/record:Record": "Record"
-  }
- },
  {
   "pkg": "dnsimple",
   "mod": "index/zoneRecord",

pulumi_dnsimple-3.5.0/pulumi_dnsimple/_enums.py

@@ -0,0 +1,31 @@
+# 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! ***
+
+from enum import Enum
+
+__all__ = [
+    'RecordTypes',
+]
+
+
+class RecordTypes(str, Enum):
+    """
+    DNS Record types.
+    """
+    A = "A"
+    AAAA = "AAAA"
+    ALIAS = "ALIAS"
+    CAA = "CAA"
+    CNAME = "CNAME"
+    HINFO = "HINFO"
+    MX = "MX"
+    NAPTR = "NAPTR"
+    NS = "NS"
+    POOL = "POOL"
+    PTR = "PTR"
+    SPF = "SPF"
+    SRV = "SRV"
+    SSHFP = "SSHFP"
+    TXT = "TXT"
+    URL = "URL"

{pulumi_dnsimple-3.4.2 → pulumi_dnsimple-3.5.0}/pulumi_dnsimple/_utilities.py

@@ -4,6 +4,7 @@
 
 
 import asyncio
+import functools
 import importlib.metadata
 import importlib.util
 import inspect
@@ -11,6 +12,7 @@ import json
 import os
 import sys
 import typing
+import warnings
 
 import pulumi
 import pulumi.runtime
@@ -19,6 +21,8 @@ from pulumi.runtime.sync_await import _sync_await
 from semver import VersionInfo as SemverVersion
 from parver import Version as PEP440Version
 
+C = typing.TypeVar("C", bound=typing.Callable)
+
 
 def get_env(*args):
     for v in args:
@@ -96,10 +100,6 @@ def _get_semver_version():
 _version = _get_semver_version()
 _version_str = str(_version)
 
-
-def get_version():
-    return _version_str
-
 def get_resource_opts_defaults() -> pulumi.ResourceOptions:
     return pulumi.ResourceOptions(
         version=get_version(),
@@ -287,5 +287,39 @@ async def _await_output(o: pulumi.Output[typing.Any]) -> typing.Tuple[object, bo
         await o._resources,
     )
 
+
+# This is included to provide an upgrade path for users who are using a version
+# of the Pulumi SDK (<3.121.0) that does not include the `deprecated` decorator.
+def deprecated(message: str) -> typing.Callable[[C], C]:
+    """
+    Decorator to indicate a function is deprecated.
+
+    As well as inserting appropriate statements to indicate that the function is
+    deprecated, this decorator also tags the function with a special attribute
+    so that Pulumi code can detect that it is deprecated and react appropriately
+    in certain situations.
+
+    message is the deprecation message that should be printed if the function is called.
+    """
+
+    def decorator(fn: C) -> C:
+        if not callable(fn):
+            raise TypeError("Expected fn to be callable")
+
+        @functools.wraps(fn)
+        def deprecated_fn(*args, **kwargs):
+            warnings.warn(message)
+            pulumi.warn(f"{fn.__name__} is deprecated: {message}")
+
+            return fn(*args, **kwargs)
+
+        deprecated_fn.__dict__["_pulumi_deprecated_callable"] = fn
+        return typing.cast(C, deprecated_fn)
+
+    return decorator
+
 def get_plugin_download_url():
 	return None
+
+def get_version():
+     return _version_str

{pulumi_dnsimple-3.4.2 → pulumi_dnsimple-3.5.0}/pulumi_dnsimple/domain.py

@@ -18,6 +18,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 +28,8 @@ class DomainArgs:
     def name(self) -> pulumi.Input[str]:
         """
         The domain name to be created
+
+        # Attributes Reference
         """
         return pulumi.get(self, "name")
 
@@ -46,7 +50,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 +78,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 +90,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 +104,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 +116,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 +128,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 +140,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 +152,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 +174,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 +249,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 +263,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 +393,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 +419,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 +437,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-3.4.2 → pulumi_dnsimple-3.5.0}/pulumi_dnsimple/email_forward.py

@@ -20,8 +20,8 @@ class EmailForwardArgs:
         """
         The set of arguments for constructing a EmailForward resource.
         :param pulumi.Input[str] alias_name: The name part (the part before the @) of the source email address on the domain
-        :param pulumi.Input[str] destination_email: The destination email address on another domain
-        :param pulumi.Input[str] domain: The domain to add the email forwarding rule to
+        :param pulumi.Input[str] destination_email: The destination email address
+        :param pulumi.Input[str] domain: The domain name to add the email forwarding rule to
         """
         pulumi.set(__self__, "alias_name", alias_name)
         pulumi.set(__self__, "destination_email", destination_email)
@@ -43,7 +43,7 @@ class EmailForwardArgs:
     @pulumi.getter(name="destinationEmail")
     def destination_email(self) -> pulumi.Input[str]:
         """
-        The destination email address on another domain
+        The destination email address
         """
         return pulumi.get(self, "destination_email")
 
@@ -55,7 +55,7 @@ class EmailForwardArgs:
     @pulumi.getter
     def domain(self) -> pulumi.Input[str]:
         """
-        The domain to add the email forwarding rule to
+        The domain name to add the email forwarding rule to
         """
         return pulumi.get(self, "domain")
 
@@ -73,10 +73,10 @@ class _EmailForwardState:
                  domain: Optional[pulumi.Input[str]] = None):
         """
         Input properties used for looking up and filtering EmailForward resources.
-        :param pulumi.Input[str] alias_email: The source email address on the domain
+        :param pulumi.Input[str] alias_email: The source email address on the domain, in full form. This is a computed attribute.
         :param pulumi.Input[str] alias_name: The name part (the part before the @) of the source email address on the domain
-        :param pulumi.Input[str] destination_email: The destination email address on another domain
-        :param pulumi.Input[str] domain: The domain to add the email forwarding rule to
+        :param pulumi.Input[str] destination_email: The destination email address
+        :param pulumi.Input[str] domain: The domain name to add the email forwarding rule to
         """
         if alias_email is not None:
             pulumi.set(__self__, "alias_email", alias_email)
@@ -91,7 +91,7 @@ class _EmailForwardState:
     @pulumi.getter(name="aliasEmail")
     def alias_email(self) -> Optional[pulumi.Input[str]]:
         """
-        The source email address on the domain
+        The source email address on the domain, in full form. This is a computed attribute.
         """
         return pulumi.get(self, "alias_email")
 
@@ -115,7 +115,7 @@ class _EmailForwardState:
     @pulumi.getter(name="destinationEmail")
     def destination_email(self) -> Optional[pulumi.Input[str]]:
         """
-        The destination email address on another domain
+        The destination email address
         """
         return pulumi.get(self, "destination_email")
 
@@ -127,7 +127,7 @@ class _EmailForwardState:
     @pulumi.getter
     def domain(self) -> Optional[pulumi.Input[str]]:
         """
-        The domain to add the email forwarding rule to
+        The domain name to add the email forwarding rule to
         """
         return pulumi.get(self, "domain")
 
@@ -150,24 +150,34 @@ class EmailForward(pulumi.CustomResource):
 
         ## Example Usage
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_dnsimple as dnsimple
 
         # Add an email forwarding rule to the domain
         foobar = dnsimple.EmailForward("foobar",
+            domain=dnsimple_domain["name"],
             alias_name="sales",
-            destination_email="jane.doe@example.com",
-            domain=var["dnsimple_domain"])
+            destination_email="alice.appleseed@example.com")
+        ```
+
+        ## Import
+
+        DNSimple resources can be imported using the domain name and numeric email forward ID.
+
+        **Importing email forward for example.com with email forward ID 1234**
+
+        bash
+
+        ```sh
+        $ pulumi import dnsimple:index/emailForward:EmailForward resource_name example.com_1234
         ```
-        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] alias_name: The name part (the part before the @) of the source email address on the domain
-        :param pulumi.Input[str] destination_email: The destination email address on another domain
-        :param pulumi.Input[str] domain: The domain to add the email forwarding rule to
+        :param pulumi.Input[str] destination_email: The destination email address
+        :param pulumi.Input[str] domain: The domain name to add the email forwarding rule to
         """
         ...
     @overload
@@ -180,18 +190,28 @@ class EmailForward(pulumi.CustomResource):
 
         ## Example Usage
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_dnsimple as dnsimple
 
         # Add an email forwarding rule to the domain
         foobar = dnsimple.EmailForward("foobar",
+            domain=dnsimple_domain["name"],
             alias_name="sales",
-            destination_email="jane.doe@example.com",
-            domain=var["dnsimple_domain"])
+            destination_email="alice.appleseed@example.com")
+        ```
+
+        ## Import
+
+        DNSimple resources can be imported using the domain name and numeric email forward ID.
+
+        **Importing email forward for example.com with email forward ID 1234**
+
+        bash
+
+        ```sh
+        $ pulumi import dnsimple:index/emailForward:EmailForward resource_name example.com_1234
         ```
-        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param EmailForwardArgs args: The arguments to use to populate this resource's properties.
@@ -251,10 +271,10 @@ class EmailForward(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[str] alias_email: The source email address on the domain
+        :param pulumi.Input[str] alias_email: The source email address on the domain, in full form. This is a computed attribute.
         :param pulumi.Input[str] alias_name: The name part (the part before the @) of the source email address on the domain
-        :param pulumi.Input[str] destination_email: The destination email address on another domain
-        :param pulumi.Input[str] domain: The domain to add the email forwarding rule to
+        :param pulumi.Input[str] destination_email: The destination email address
+        :param pulumi.Input[str] domain: The domain name to add the email forwarding rule to
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -270,7 +290,7 @@ class EmailForward(pulumi.CustomResource):
     @pulumi.getter(name="aliasEmail")
     def alias_email(self) -> pulumi.Output[str]:
         """
-        The source email address on the domain
+        The source email address on the domain, in full form. This is a computed attribute.
         """
         return pulumi.get(self, "alias_email")
 
@@ -286,7 +306,7 @@ class EmailForward(pulumi.CustomResource):
     @pulumi.getter(name="destinationEmail")
     def destination_email(self) -> pulumi.Output[str]:
         """
-        The destination email address on another domain
+        The destination email address
         """
         return pulumi.get(self, "destination_email")
 
@@ -294,7 +314,7 @@ class EmailForward(pulumi.CustomResource):
     @pulumi.getter
     def domain(self) -> pulumi.Output[str]:
         """
-        The domain to add the email forwarding rule to
+        The domain name to add the email forwarding rule to
         """
         return pulumi.get(self, "domain")
 

{pulumi_dnsimple-3.4.2 → pulumi_dnsimple-3.5.0}/pulumi_dnsimple/get_certificate.py

@@ -25,8 +25,8 @@ class GetCertificateResult:
         if certificate_chains and not isinstance(certificate_chains, list):
             raise TypeError("Expected argument 'certificate_chains' to be a list")
         pulumi.set(__self__, "certificate_chains", certificate_chains)
-        if certificate_id and not isinstance(certificate_id, str):
-            raise TypeError("Expected argument 'certificate_id' to be a str")
+        if certificate_id and not isinstance(certificate_id, int):
+            raise TypeError("Expected argument 'certificate_id' to be a int")
         pulumi.set(__self__, "certificate_id", certificate_id)
         if domain and not isinstance(domain, str):
             raise TypeError("Expected argument 'domain' to be a str")
@@ -54,7 +54,7 @@ class GetCertificateResult:
 
     @property
     @pulumi.getter(name="certificateId")
-    def certificate_id(self) -> str:
+    def certificate_id(self) -> int:
         return pulumi.get(self, "certificate_id")
 
     @property
@@ -65,9 +65,6 @@ class GetCertificateResult:
     @property
     @pulumi.getter
     def id(self) -> str:
-        """
-        The provider-assigned unique ID for this managed resource.
-        """
         return pulumi.get(self, "id")
 
     @property
@@ -110,7 +107,7 @@ class AwaitableGetCertificateResult(GetCertificateResult):
             server_certificate=self.server_certificate)
 
 
-def get_certificate(certificate_id: Optional[str] = None,
+def get_certificate(certificate_id: Optional[int] = None,
                     domain: Optional[str] = None,
                     opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetCertificateResult:
     """
@@ -118,18 +115,16 @@ def get_certificate(certificate_id: Optional[str] = None,
 
     ## Example Usage
 
-    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_dnsimple as dnsimple
 
-    foobar = dnsimple.get_certificate(certificate_id=var["dnsimple_certificate_id"],
-        domain=var["dnsimple_domain"])
+    foobar = dnsimple.get_certificate(domain=dnsimple_domain,
+        certificate_id=dnsimple_certificate_id)
     ```
-    <!--End PulumiCodeChooser -->
 
 
-    :param str certificate_id: The ID of the SSL Certificate
+    :param int certificate_id: The ID of the SSL Certificate
     :param str domain: The domain of the SSL Certificate
     """
     __args__ = dict()
@@ -149,7 +144,7 @@ def get_certificate(certificate_id: Optional[str] = None,
 
 
 @_utilities.lift_output_func(get_certificate)
-def get_certificate_output(certificate_id: Optional[pulumi.Input[str]] = None,
+def get_certificate_output(certificate_id: Optional[pulumi.Input[int]] = None,
                            domain: Optional[pulumi.Input[str]] = None,
                            opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetCertificateResult]:
     """
@@ -157,18 +152,16 @@ def get_certificate_output(certificate_id: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
-    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_dnsimple as dnsimple
 
-    foobar = dnsimple.get_certificate(certificate_id=var["dnsimple_certificate_id"],
-        domain=var["dnsimple_domain"])
+    foobar = dnsimple.get_certificate(domain=dnsimple_domain,
+        certificate_id=dnsimple_certificate_id)
     ```
-    <!--End PulumiCodeChooser -->
 
 
-    :param str certificate_id: The ID of the SSL Certificate
+    :param int certificate_id: The ID of the SSL Certificate
     :param str domain: The domain of the SSL Certificate
     """
     ...