pulumi-dnsimple 5.1.0a1768541715__py3-none-any.whl

pulumi_dnsimple/email_forward.py

@@ -0,0 +1,324 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+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__ = ['EmailForwardArgs', 'EmailForward']
+
+@pulumi.input_type
+class EmailForwardArgs:
+    def __init__(__self__, *,
+                 alias_name: pulumi.Input[_builtins.str],
+                 destination_email: pulumi.Input[_builtins.str],
+                 domain: pulumi.Input[_builtins.str]):
+        """
+        The set of arguments for constructing a EmailForward resource.
+        :param pulumi.Input[_builtins.str] alias_name: The name part (the part before the @) of the source email address on the domain.
+        :param pulumi.Input[_builtins.str] destination_email: The destination email address.
+        :param pulumi.Input[_builtins.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)
+        pulumi.set(__self__, "domain", domain)
+
+    @_builtins.property
+    @pulumi.getter(name="aliasName")
+    def alias_name(self) -> pulumi.Input[_builtins.str]:
+        """
+        The name part (the part before the @) of the source email address on the domain.
+        """
+        return pulumi.get(self, "alias_name")
+
+    @alias_name.setter
+    def alias_name(self, value: pulumi.Input[_builtins.str]):
+        pulumi.set(self, "alias_name", value)
+
+    @_builtins.property
+    @pulumi.getter(name="destinationEmail")
+    def destination_email(self) -> pulumi.Input[_builtins.str]:
+        """
+        The destination email address.
+        """
+        return pulumi.get(self, "destination_email")
+
+    @destination_email.setter
+    def destination_email(self, value: pulumi.Input[_builtins.str]):
+        pulumi.set(self, "destination_email", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def domain(self) -> pulumi.Input[_builtins.str]:
+        """
+        The domain name to add the email forwarding rule to.
+        """
+        return pulumi.get(self, "domain")
+
+    @domain.setter
+    def domain(self, value: pulumi.Input[_builtins.str]):
+        pulumi.set(self, "domain", value)
+
+
+@pulumi.input_type
+class _EmailForwardState:
+    def __init__(__self__, *,
+                 alias_email: Optional[pulumi.Input[_builtins.str]] = None,
+                 alias_name: Optional[pulumi.Input[_builtins.str]] = None,
+                 destination_email: Optional[pulumi.Input[_builtins.str]] = None,
+                 domain: Optional[pulumi.Input[_builtins.str]] = None):
+        """
+        Input properties used for looking up and filtering EmailForward resources.
+        :param pulumi.Input[_builtins.str] alias_email: The source email address on the domain, in full form. This is a computed attribute.
+        :param pulumi.Input[_builtins.str] alias_name: The name part (the part before the @) of the source email address on the domain.
+        :param pulumi.Input[_builtins.str] destination_email: The destination email address.
+        :param pulumi.Input[_builtins.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)
+        if alias_name is not None:
+            pulumi.set(__self__, "alias_name", alias_name)
+        if destination_email is not None:
+            pulumi.set(__self__, "destination_email", destination_email)
+        if domain is not None:
+            pulumi.set(__self__, "domain", domain)
+
+    @_builtins.property
+    @pulumi.getter(name="aliasEmail")
+    def alias_email(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The source email address on the domain, in full form. This is a computed attribute.
+        """
+        return pulumi.get(self, "alias_email")
+
+    @alias_email.setter
+    def alias_email(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "alias_email", value)
+
+    @_builtins.property
+    @pulumi.getter(name="aliasName")
+    def alias_name(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The name part (the part before the @) of the source email address on the domain.
+        """
+        return pulumi.get(self, "alias_name")
+
+    @alias_name.setter
+    def alias_name(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "alias_name", value)
+
+    @_builtins.property
+    @pulumi.getter(name="destinationEmail")
+    def destination_email(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The destination email address.
+        """
+        return pulumi.get(self, "destination_email")
+
+    @destination_email.setter
+    def destination_email(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "destination_email", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def domain(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The domain name to add the email forwarding rule to.
+        """
+        return pulumi.get(self, "domain")
+
+    @domain.setter
+    def domain(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "domain", value)
+
+
+@pulumi.type_token("dnsimple:index/emailForward:EmailForward")
+class EmailForward(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 alias_name: Optional[pulumi.Input[_builtins.str]] = None,
+                 destination_email: Optional[pulumi.Input[_builtins.str]] = None,
+                 domain: Optional[pulumi.Input[_builtins.str]] = None,
+                 __props__=None):
+        """
+        Provides a DNSimple email forward resource.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_dnsimple as dnsimple
+
+        example = dnsimple.EmailForward("example",
+            domain="example.com",
+            alias_name="sales",
+            destination_email="alice@example.com")
+        ```
+
+        ## Import
+
+        DNSimple email forwards can be imported using the domain name and numeric email forward ID in the format `domain_name_email_forward_id`.
+
+        bash
+
+        ```sh
+        $ pulumi import dnsimple:index/emailForward:EmailForward example example.com_1234
+        ```
+
+        The email forward ID can be found via the [DNSimple Email Forwards API](https://developer.dnsimple.com/v2/email-forwards/#listEmailForwards).
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[_builtins.str] alias_name: The name part (the part before the @) of the source email address on the domain.
+        :param pulumi.Input[_builtins.str] destination_email: The destination email address.
+        :param pulumi.Input[_builtins.str] domain: The domain name to add the email forwarding rule to.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: EmailForwardArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Provides a DNSimple email forward resource.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_dnsimple as dnsimple
+
+        example = dnsimple.EmailForward("example",
+            domain="example.com",
+            alias_name="sales",
+            destination_email="alice@example.com")
+        ```
+
+        ## Import
+
+        DNSimple email forwards can be imported using the domain name and numeric email forward ID in the format `domain_name_email_forward_id`.
+
+        bash
+
+        ```sh
+        $ pulumi import dnsimple:index/emailForward:EmailForward example example.com_1234
+        ```
+
+        The email forward ID can be found via the [DNSimple Email Forwards API](https://developer.dnsimple.com/v2/email-forwards/#listEmailForwards).
+
+        :param str resource_name: The name of the resource.
+        :param EmailForwardArgs 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(EmailForwardArgs, 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,
+                 alias_name: Optional[pulumi.Input[_builtins.str]] = None,
+                 destination_email: Optional[pulumi.Input[_builtins.str]] = None,
+                 domain: Optional[pulumi.Input[_builtins.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__ = EmailForwardArgs.__new__(EmailForwardArgs)
+
+            if alias_name is None and not opts.urn:
+                raise TypeError("Missing required property 'alias_name'")
+            __props__.__dict__["alias_name"] = alias_name
+            if destination_email is None and not opts.urn:
+                raise TypeError("Missing required property 'destination_email'")
+            __props__.__dict__["destination_email"] = destination_email
+            if domain is None and not opts.urn:
+                raise TypeError("Missing required property 'domain'")
+            __props__.__dict__["domain"] = domain
+            __props__.__dict__["alias_email"] = None
+        super(EmailForward, __self__).__init__(
+            'dnsimple:index/emailForward:EmailForward',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            alias_email: Optional[pulumi.Input[_builtins.str]] = None,
+            alias_name: Optional[pulumi.Input[_builtins.str]] = None,
+            destination_email: Optional[pulumi.Input[_builtins.str]] = None,
+            domain: Optional[pulumi.Input[_builtins.str]] = None) -> 'EmailForward':
+        """
+        Get an existing EmailForward 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[_builtins.str] alias_email: The source email address on the domain, in full form. This is a computed attribute.
+        :param pulumi.Input[_builtins.str] alias_name: The name part (the part before the @) of the source email address on the domain.
+        :param pulumi.Input[_builtins.str] destination_email: The destination email address.
+        :param pulumi.Input[_builtins.str] domain: The domain name to add the email forwarding rule to.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _EmailForwardState.__new__(_EmailForwardState)
+
+        __props__.__dict__["alias_email"] = alias_email
+        __props__.__dict__["alias_name"] = alias_name
+        __props__.__dict__["destination_email"] = destination_email
+        __props__.__dict__["domain"] = domain
+        return EmailForward(resource_name, opts=opts, __props__=__props__)
+
+    @_builtins.property
+    @pulumi.getter(name="aliasEmail")
+    def alias_email(self) -> pulumi.Output[_builtins.str]:
+        """
+        The source email address on the domain, in full form. This is a computed attribute.
+        """
+        return pulumi.get(self, "alias_email")
+
+    @_builtins.property
+    @pulumi.getter(name="aliasName")
+    def alias_name(self) -> pulumi.Output[_builtins.str]:
+        """
+        The name part (the part before the @) of the source email address on the domain.
+        """
+        return pulumi.get(self, "alias_name")
+
+    @_builtins.property
+    @pulumi.getter(name="destinationEmail")
+    def destination_email(self) -> pulumi.Output[_builtins.str]:
+        """
+        The destination email address.
+        """
+        return pulumi.get(self, "destination_email")
+
+    @_builtins.property
+    @pulumi.getter
+    def domain(self) -> pulumi.Output[_builtins.str]:
+        """
+        The domain name to add the email forwarding rule to.
+        """
+        return pulumi.get(self, "domain")
+

pulumi_dnsimple/get_certificate.py

@@ -0,0 +1,203 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+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
+from . import outputs
+from ._inputs import *
+
+__all__ = [
+    'GetCertificateResult',
+    'AwaitableGetCertificateResult',
+    'get_certificate',
+    'get_certificate_output',
+]
+
+@pulumi.output_type
+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, 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, 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")
+        pulumi.set(__self__, "domain", domain)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if private_key and not isinstance(private_key, str):
+            raise TypeError("Expected argument 'private_key' to be a str")
+        pulumi.set(__self__, "private_key", private_key)
+        if root_certificate and not isinstance(root_certificate, str):
+            raise TypeError("Expected argument 'root_certificate' to be a str")
+        pulumi.set(__self__, "root_certificate", root_certificate)
+        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)
+
+    @_builtins.property
+    @pulumi.getter(name="certificateChains")
+    def certificate_chains(self) -> Sequence[_builtins.str]:
+        """
+        A list of certificates that make up the certificate chain.
+        """
+        return pulumi.get(self, "certificate_chains")
+
+    @_builtins.property
+    @pulumi.getter(name="certificateId")
+    def certificate_id(self) -> _builtins.int:
+        return pulumi.get(self, "certificate_id")
+
+    @_builtins.property
+    @pulumi.getter
+    def domain(self) -> _builtins.str:
+        return pulumi.get(self, "domain")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The certificate ID.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter(name="privateKey")
+    def private_key(self) -> _builtins.str:
+        """
+        The corresponding private key for the SSL certificate.
+        """
+        return pulumi.get(self, "private_key")
+
+    @_builtins.property
+    @pulumi.getter(name="rootCertificate")
+    def root_certificate(self) -> _builtins.str:
+        """
+        The root certificate of the issuing CA.
+        """
+        return pulumi.get(self, "root_certificate")
+
+    @_builtins.property
+    @pulumi.getter(name="serverCertificate")
+    def server_certificate(self) -> _builtins.str:
+        """
+        The SSL certificate.
+        """
+        return pulumi.get(self, "server_certificate")
+
+    @_builtins.property
+    @pulumi.getter
+    def timeouts(self) -> Optional['outputs.GetCertificateTimeoutsResult']:
+        return pulumi.get(self, "timeouts")
+
+
+class AwaitableGetCertificateResult(GetCertificateResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetCertificateResult(
+            certificate_chains=self.certificate_chains,
+            certificate_id=self.certificate_id,
+            domain=self.domain,
+            id=self.id,
+            private_key=self.private_key,
+            root_certificate=self.root_certificate,
+            server_certificate=self.server_certificate,
+            timeouts=self.timeouts)
+
+
+def get_certificate(certificate_id: Optional[_builtins.int] = None,
+                    domain: Optional[_builtins.str] = None,
+                    timeouts: Optional[Union['GetCertificateTimeoutsArgs', 'GetCertificateTimeoutsArgsDict']] = None,
+                    opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetCertificateResult:
+    """
+    Get information about a DNSimple SSL certificate.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_dnsimple as dnsimple
+
+    example = dnsimple.get_certificate(domain="example.com",
+        certificate_id=1234)
+    ```
+
+
+    :param _builtins.int certificate_id: The ID of the SSL certificate.
+    :param _builtins.str domain: The domain name of the SSL certificate.
+    :param Union['GetCertificateTimeoutsArgs', 'GetCertificateTimeoutsArgsDict'] timeouts: (see below for nested schema)
+    """
+    __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
+
+    return AwaitableGetCertificateResult(
+        certificate_chains=pulumi.get(__ret__, 'certificate_chains'),
+        certificate_id=pulumi.get(__ret__, 'certificate_id'),
+        domain=pulumi.get(__ret__, 'domain'),
+        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'),
+        timeouts=pulumi.get(__ret__, 'timeouts'))
+def get_certificate_output(certificate_id: Optional[pulumi.Input[_builtins.int]] = None,
+                           domain: Optional[pulumi.Input[_builtins.str]] = None,
+                           timeouts: Optional[pulumi.Input[Optional[Union['GetCertificateTimeoutsArgs', 'GetCertificateTimeoutsArgsDict']]]] = None,
+                           opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetCertificateResult]:
+    """
+    Get information about a DNSimple SSL certificate.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_dnsimple as dnsimple
+
+    example = dnsimple.get_certificate(domain="example.com",
+        certificate_id=1234)
+    ```
+
+
+    :param _builtins.int certificate_id: The ID of the SSL certificate.
+    :param _builtins.str domain: The domain name of the SSL certificate.
+    :param Union['GetCertificateTimeoutsArgs', 'GetCertificateTimeoutsArgsDict'] timeouts: (see below for nested schema)
+    """
+    __args__ = dict()
+    __args__['certificateId'] = certificate_id
+    __args__['domain'] = domain
+    __args__['timeouts'] = timeouts
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('dnsimple:index/getCertificate:getCertificate', __args__, opts=opts, typ=GetCertificateResult)
+    return __ret__.apply(lambda __response__: GetCertificateResult(
+        certificate_chains=pulumi.get(__response__, 'certificate_chains'),
+        certificate_id=pulumi.get(__response__, 'certificate_id'),
+        domain=pulumi.get(__response__, 'domain'),
+        id=pulumi.get(__response__, 'id'),
+        private_key=pulumi.get(__response__, 'private_key'),
+        root_certificate=pulumi.get(__response__, 'root_certificate'),
+        server_certificate=pulumi.get(__response__, 'server_certificate'),
+        timeouts=pulumi.get(__response__, 'timeouts')))