pulumi-dnsimple 3.5.0a1721236014__py3-none-any.whl → 4.0.0__py3-none-any.whl

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")
 
@@ -154,18 +154,29 @@ class EmailForward(pulumi.CustomResource):
         import pulumi
         import pulumi_dnsimple as dnsimple
 
-        # Add an email forwarding rule to the domain
         foobar = dnsimple.EmailForward("foobar",
-            domain=dnsimple_domain,
+            domain=dnsimple_domain["name"],
             alias_name="sales",
-            destination_email="jane.doe@example.com")
+            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
         ```
 
         :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
@@ -182,11 +193,22 @@ class EmailForward(pulumi.CustomResource):
         import pulumi
         import pulumi_dnsimple as dnsimple
 
-        # Add an email forwarding rule to the domain
         foobar = dnsimple.EmailForward("foobar",
-            domain=dnsimple_domain,
+            domain=dnsimple_domain["name"],
             alias_name="sales",
-            destination_email="jane.doe@example.com")
+            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
         ```
 
         :param str resource_name: The name of the resource.
@@ -247,10 +269,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))
 
@@ -266,7 +288,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")
 
@@ -282,7 +304,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")
 
@@ -290,7 +312,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/get_certificate.py

@@ -8,6 +8,8 @@ import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
 from . import _utilities
+from . import outputs
+from ._inputs import *
 
 __all__ = [
     'GetCertificateResult',
@@ -21,12 +23,12 @@ class GetCertificateResult:
     """
     A collection of values returned by getCertificate.
     """
-    def __init__(__self__, certificate_chains=None, certificate_id=None, domain=None, id=None, private_key=None, root_certificate=None, server_certificate=None):
+    def __init__(__self__, certificate_chains=None, certificate_id=None, domain=None, id=None, private_key=None, root_certificate=None, server_certificate=None, timeouts=None):
         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")
@@ -43,6 +45,9 @@ class GetCertificateResult:
         if server_certificate and not isinstance(server_certificate, str):
             raise TypeError("Expected argument 'server_certificate' to be a str")
         pulumi.set(__self__, "server_certificate", server_certificate)
+        if timeouts and not isinstance(timeouts, dict):
+            raise TypeError("Expected argument 'timeouts' to be a dict")
+        pulumi.set(__self__, "timeouts", timeouts)
 
     @property
     @pulumi.getter(name="certificateChains")
@@ -54,7 +59,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 +70,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
@@ -94,6 +96,11 @@ class GetCertificateResult:
         """
         return pulumi.get(self, "server_certificate")
 
+    @property
+    @pulumi.getter
+    def timeouts(self) -> Optional['outputs.GetCertificateTimeoutsResult']:
+        return pulumi.get(self, "timeouts")
+
 
 class AwaitableGetCertificateResult(GetCertificateResult):
     # pylint: disable=using-constant-test
@@ -107,11 +114,13 @@ class AwaitableGetCertificateResult(GetCertificateResult):
             id=self.id,
             private_key=self.private_key,
             root_certificate=self.root_certificate,
-            server_certificate=self.server_certificate)
+            server_certificate=self.server_certificate,
+            timeouts=self.timeouts)
 
 
-def get_certificate(certificate_id: Optional[str] = None,
+def get_certificate(certificate_id: Optional[int] = None,
                     domain: Optional[str] = None,
+                    timeouts: Optional[pulumi.InputType['GetCertificateTimeoutsArgs']] = None,
                     opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetCertificateResult:
     """
     Provides a DNSimple certificate data source.
@@ -127,12 +136,13 @@ def get_certificate(certificate_id: Optional[str] = None,
     ```
 
 
-    :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()
     __args__['certificateId'] = certificate_id
     __args__['domain'] = domain
+    __args__['timeouts'] = timeouts
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke('dnsimple:index/getCertificate:getCertificate', __args__, opts=opts, typ=GetCertificateResult).value
 
@@ -143,12 +153,14 @@ def get_certificate(certificate_id: Optional[str] = None,
         id=pulumi.get(__ret__, 'id'),
         private_key=pulumi.get(__ret__, 'private_key'),
         root_certificate=pulumi.get(__ret__, 'root_certificate'),
-        server_certificate=pulumi.get(__ret__, 'server_certificate'))
+        server_certificate=pulumi.get(__ret__, 'server_certificate'),
+        timeouts=pulumi.get(__ret__, 'timeouts'))
 
 
 @_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,
+                           timeouts: Optional[pulumi.Input[Optional[pulumi.InputType['GetCertificateTimeoutsArgs']]]] = None,
                            opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetCertificateResult]:
     """
     Provides a DNSimple certificate data source.
@@ -164,7 +176,7 @@ def get_certificate_output(certificate_id: Optional[pulumi.Input[str]] = None,
     ```
 
 
-    :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
     """
     ...

pulumi_dnsimple/get_registrant_change_check.py

@@ -0,0 +1,160 @@
+# 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 pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from . import _utilities
+from . import outputs
+
+__all__ = [
+    'GetRegistrantChangeCheckResult',
+    'AwaitableGetRegistrantChangeCheckResult',
+    'get_registrant_change_check',
+    'get_registrant_change_check_output',
+]
+
+@pulumi.output_type
+class GetRegistrantChangeCheckResult:
+    """
+    A collection of values returned by getRegistrantChangeCheck.
+    """
+    def __init__(__self__, contact_id=None, domain_id=None, extended_attributes=None, id=None, registry_owner_change=None):
+        if contact_id and not isinstance(contact_id, str):
+            raise TypeError("Expected argument 'contact_id' to be a str")
+        pulumi.set(__self__, "contact_id", contact_id)
+        if domain_id and not isinstance(domain_id, str):
+            raise TypeError("Expected argument 'domain_id' to be a str")
+        pulumi.set(__self__, "domain_id", domain_id)
+        if extended_attributes and not isinstance(extended_attributes, list):
+            raise TypeError("Expected argument 'extended_attributes' to be a list")
+        pulumi.set(__self__, "extended_attributes", extended_attributes)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if registry_owner_change and not isinstance(registry_owner_change, bool):
+            raise TypeError("Expected argument 'registry_owner_change' to be a bool")
+        pulumi.set(__self__, "registry_owner_change", registry_owner_change)
+
+    @property
+    @pulumi.getter(name="contactId")
+    def contact_id(self) -> str:
+        return pulumi.get(self, "contact_id")
+
+    @property
+    @pulumi.getter(name="domainId")
+    def domain_id(self) -> str:
+        return pulumi.get(self, "domain_id")
+
+    @property
+    @pulumi.getter(name="extendedAttributes")
+    def extended_attributes(self) -> Sequence['outputs.GetRegistrantChangeCheckExtendedAttributeResult']:
+        return pulumi.get(self, "extended_attributes")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter(name="registryOwnerChange")
+    def registry_owner_change(self) -> bool:
+        return pulumi.get(self, "registry_owner_change")
+
+
+class AwaitableGetRegistrantChangeCheckResult(GetRegistrantChangeCheckResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetRegistrantChangeCheckResult(
+            contact_id=self.contact_id,
+            domain_id=self.domain_id,
+            extended_attributes=self.extended_attributes,
+            id=self.id,
+            registry_owner_change=self.registry_owner_change)
+
+
+def get_registrant_change_check(contact_id: Optional[str] = None,
+                                domain_id: Optional[str] = None,
+                                opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetRegistrantChangeCheckResult:
+    """
+    Get information on the requirements of a registrant change.
+
+    > **Note:** The registrant change API is currently in developer preview and is subject to change.
+
+    Get registrant change requirements for the `dnsimple.com` domain and the contact with ID `1234`:
+
+    ```python
+    import pulumi
+    import pulumi_dnsimple as dnsimple
+
+    example = dnsimple.get_registrant_change_check(domain_id="dnsimple.com",
+        contact_id="1234")
+    ```
+
+    The following arguments are supported:
+
+    * `domain_id` - (Required) The name or ID of the domain.
+    * `contact_id` - (Required) The ID of the contact you are planning to change to.
+
+    The following additional attributes are exported:
+
+    * `contact_id` - The ID of the contact you are planning to change to.
+    * `domain_id` - The name or ID of the domain.
+    * `extended_attributes` - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
+    * `registry_owner_change` - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
+
+    <a id="nestedblock--extended_attributes"></a>
+    """
+    __args__ = dict()
+    __args__['contactId'] = contact_id
+    __args__['domainId'] = domain_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('dnsimple:index/getRegistrantChangeCheck:getRegistrantChangeCheck', __args__, opts=opts, typ=GetRegistrantChangeCheckResult).value
+
+    return AwaitableGetRegistrantChangeCheckResult(
+        contact_id=pulumi.get(__ret__, 'contact_id'),
+        domain_id=pulumi.get(__ret__, 'domain_id'),
+        extended_attributes=pulumi.get(__ret__, 'extended_attributes'),
+        id=pulumi.get(__ret__, 'id'),
+        registry_owner_change=pulumi.get(__ret__, 'registry_owner_change'))
+
+
+@_utilities.lift_output_func(get_registrant_change_check)
+def get_registrant_change_check_output(contact_id: Optional[pulumi.Input[str]] = None,
+                                       domain_id: Optional[pulumi.Input[str]] = None,
+                                       opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetRegistrantChangeCheckResult]:
+    """
+    Get information on the requirements of a registrant change.
+
+    > **Note:** The registrant change API is currently in developer preview and is subject to change.
+
+    Get registrant change requirements for the `dnsimple.com` domain and the contact with ID `1234`:
+
+    ```python
+    import pulumi
+    import pulumi_dnsimple as dnsimple
+
+    example = dnsimple.get_registrant_change_check(domain_id="dnsimple.com",
+        contact_id="1234")
+    ```
+
+    The following arguments are supported:
+
+    * `domain_id` - (Required) The name or ID of the domain.
+    * `contact_id` - (Required) The ID of the contact you are planning to change to.
+
+    The following additional attributes are exported:
+
+    * `contact_id` - The ID of the contact you are planning to change to.
+    * `domain_id` - The name or ID of the domain.
+    * `extended_attributes` - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
+    * `registry_owner_change` - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
+
+    <a id="nestedblock--extended_attributes"></a>
+    """
+    ...

pulumi_dnsimple/get_zone.py

@@ -73,6 +73,8 @@ def get_zone(name: Optional[str] = None,
     """
     Get information about a DNSimple zone.
 
+    !> Data source is getting deprecated in favor of `dnsimple\\_zone` resource.
+
     Get zone:
 
     ```python
@@ -86,11 +88,10 @@ def get_zone(name: Optional[str] = None,
 
     * `name` - (Required) The name of the zone
 
-    The following attributes are exported:
+    The following additional attributes are exported:
 
     * `id` - The zone ID
     * `account_id` - The account ID
-    * `name` - The name of the zone
     * `reverse` - True for a reverse zone, false for a forward zone.
     """
     __args__ = dict()
@@ -111,6 +112,8 @@ def get_zone_output(name: Optional[pulumi.Input[str]] = None,
     """
     Get information about a DNSimple zone.
 
+    !> Data source is getting deprecated in favor of `dnsimple\\_zone` resource.
+
     Get zone:
 
     ```python
@@ -124,11 +127,10 @@ def get_zone_output(name: Optional[pulumi.Input[str]] = None,
 
     * `name` - (Required) The name of the zone
 
-    The following attributes are exported:
+    The following additional attributes are exported:
 
     * `id` - The zone ID
     * `account_id` - The account ID
-    * `name` - The name of the zone
     * `reverse` - True for a reverse zone, false for a forward zone.
     """
     ...