pulumi-dnsimple 5.1.0a1768541715__py3-none-any.whl

pulumi_dnsimple/domain.py

@@ -0,0 +1,362 @@
+# 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__ = ['DomainArgs', 'Domain']
+
+@pulumi.input_type
+class DomainArgs:
+    def __init__(__self__, *,
+                 name: pulumi.Input[_builtins.str]):
+        """
+        The set of arguments for constructing a Domain resource.
+        :param pulumi.Input[_builtins.str] name: The domain name to be created.
+        """
+        pulumi.set(__self__, "name", name)
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> pulumi.Input[_builtins.str]:
+        """
+        The domain name to be created.
+        """
+        return pulumi.get(self, "name")
+
+    @name.setter
+    def name(self, value: pulumi.Input[_builtins.str]):
+        pulumi.set(self, "name", value)
+
+
+@pulumi.input_type
+class _DomainState:
+    def __init__(__self__, *,
+                 account_id: Optional[pulumi.Input[_builtins.int]] = None,
+                 auto_renew: Optional[pulumi.Input[_builtins.bool]] = None,
+                 name: Optional[pulumi.Input[_builtins.str]] = None,
+                 private_whois: Optional[pulumi.Input[_builtins.bool]] = None,
+                 registrant_id: Optional[pulumi.Input[_builtins.int]] = None,
+                 state: Optional[pulumi.Input[_builtins.str]] = None,
+                 unicode_name: Optional[pulumi.Input[_builtins.str]] = None):
+        """
+        Input properties used for looking up and filtering Domain resources.
+        :param pulumi.Input[_builtins.int] account_id: The account ID for the domain.
+        :param pulumi.Input[_builtins.bool] auto_renew: Whether the domain is set to auto-renew.
+        :param pulumi.Input[_builtins.str] name: The domain name to be created.
+        :param pulumi.Input[_builtins.bool] private_whois: Whether the domain has WhoIs privacy enabled.
+        :param pulumi.Input[_builtins.int] registrant_id: The ID of the registrant (contact) for the domain.
+        :param pulumi.Input[_builtins.str] state: The state of the domain.
+        :param pulumi.Input[_builtins.str] unicode_name: The domain name in Unicode format.
+        """
+        if account_id is not None:
+            pulumi.set(__self__, "account_id", account_id)
+        if auto_renew is not None:
+            pulumi.set(__self__, "auto_renew", auto_renew)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if private_whois is not None:
+            pulumi.set(__self__, "private_whois", private_whois)
+        if registrant_id is not None:
+            pulumi.set(__self__, "registrant_id", registrant_id)
+        if state is not None:
+            pulumi.set(__self__, "state", state)
+        if unicode_name is not None:
+            pulumi.set(__self__, "unicode_name", unicode_name)
+
+    @_builtins.property
+    @pulumi.getter(name="accountId")
+    def account_id(self) -> Optional[pulumi.Input[_builtins.int]]:
+        """
+        The account ID for the domain.
+        """
+        return pulumi.get(self, "account_id")
+
+    @account_id.setter
+    def account_id(self, value: Optional[pulumi.Input[_builtins.int]]):
+        pulumi.set(self, "account_id", value)
+
+    @_builtins.property
+    @pulumi.getter(name="autoRenew")
+    def auto_renew(self) -> Optional[pulumi.Input[_builtins.bool]]:
+        """
+        Whether the domain is set to auto-renew.
+        """
+        return pulumi.get(self, "auto_renew")
+
+    @auto_renew.setter
+    def auto_renew(self, value: Optional[pulumi.Input[_builtins.bool]]):
+        pulumi.set(self, "auto_renew", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The domain name to be created.
+        """
+        return pulumi.get(self, "name")
+
+    @name.setter
+    def name(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "name", value)
+
+    @_builtins.property
+    @pulumi.getter(name="privateWhois")
+    def private_whois(self) -> Optional[pulumi.Input[_builtins.bool]]:
+        """
+        Whether the domain has WhoIs privacy enabled.
+        """
+        return pulumi.get(self, "private_whois")
+
+    @private_whois.setter
+    def private_whois(self, value: Optional[pulumi.Input[_builtins.bool]]):
+        pulumi.set(self, "private_whois", value)
+
+    @_builtins.property
+    @pulumi.getter(name="registrantId")
+    def registrant_id(self) -> Optional[pulumi.Input[_builtins.int]]:
+        """
+        The ID of the registrant (contact) for the domain.
+        """
+        return pulumi.get(self, "registrant_id")
+
+    @registrant_id.setter
+    def registrant_id(self, value: Optional[pulumi.Input[_builtins.int]]):
+        pulumi.set(self, "registrant_id", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def state(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The state of the domain.
+        """
+        return pulumi.get(self, "state")
+
+    @state.setter
+    def state(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "state", value)
+
+    @_builtins.property
+    @pulumi.getter(name="unicodeName")
+    def unicode_name(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The domain name in Unicode format.
+        """
+        return pulumi.get(self, "unicode_name")
+
+    @unicode_name.setter
+    def unicode_name(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "unicode_name", value)
+
+
+@pulumi.type_token("dnsimple:index/domain:Domain")
+class Domain(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 name: Optional[pulumi.Input[_builtins.str]] = None,
+                 __props__=None):
+        """
+        Provides a DNSimple domain resource.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_dnsimple as dnsimple
+
+        example = dnsimple.Domain("example", name="example.com")
+        ```
+
+        ## Import
+
+        DNSimple domains can be imported using the domain name.
+
+        bash
+
+        ```sh
+        $ pulumi import dnsimple:index/domain:Domain example example.com
+        ```
+
+        The domain name can be found within the [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.
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[_builtins.str] name: The domain name to be created.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: DomainArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Provides a DNSimple domain resource.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_dnsimple as dnsimple
+
+        example = dnsimple.Domain("example", name="example.com")
+        ```
+
+        ## Import
+
+        DNSimple domains can be imported using the domain name.
+
+        bash
+
+        ```sh
+        $ pulumi import dnsimple:index/domain:Domain example example.com
+        ```
+
+        The domain name can be found within the [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.
+
+        :param str resource_name: The name of the resource.
+        :param DomainArgs 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(DomainArgs, 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,
+                 name: 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__ = DomainArgs.__new__(DomainArgs)
+
+            if name is None and not opts.urn:
+                raise TypeError("Missing required property 'name'")
+            __props__.__dict__["name"] = name
+            __props__.__dict__["account_id"] = None
+            __props__.__dict__["auto_renew"] = None
+            __props__.__dict__["private_whois"] = None
+            __props__.__dict__["registrant_id"] = None
+            __props__.__dict__["state"] = None
+            __props__.__dict__["unicode_name"] = None
+        super(Domain, __self__).__init__(
+            'dnsimple:index/domain:Domain',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            account_id: Optional[pulumi.Input[_builtins.int]] = None,
+            auto_renew: Optional[pulumi.Input[_builtins.bool]] = None,
+            name: Optional[pulumi.Input[_builtins.str]] = None,
+            private_whois: Optional[pulumi.Input[_builtins.bool]] = None,
+            registrant_id: Optional[pulumi.Input[_builtins.int]] = None,
+            state: Optional[pulumi.Input[_builtins.str]] = None,
+            unicode_name: Optional[pulumi.Input[_builtins.str]] = None) -> 'Domain':
+        """
+        Get an existing Domain 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.int] account_id: The account ID for the domain.
+        :param pulumi.Input[_builtins.bool] auto_renew: Whether the domain is set to auto-renew.
+        :param pulumi.Input[_builtins.str] name: The domain name to be created.
+        :param pulumi.Input[_builtins.bool] private_whois: Whether the domain has WhoIs privacy enabled.
+        :param pulumi.Input[_builtins.int] registrant_id: The ID of the registrant (contact) for the domain.
+        :param pulumi.Input[_builtins.str] state: The state of the domain.
+        :param pulumi.Input[_builtins.str] unicode_name: The domain name in Unicode format.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _DomainState.__new__(_DomainState)
+
+        __props__.__dict__["account_id"] = account_id
+        __props__.__dict__["auto_renew"] = auto_renew
+        __props__.__dict__["name"] = name
+        __props__.__dict__["private_whois"] = private_whois
+        __props__.__dict__["registrant_id"] = registrant_id
+        __props__.__dict__["state"] = state
+        __props__.__dict__["unicode_name"] = unicode_name
+        return Domain(resource_name, opts=opts, __props__=__props__)
+
+    @_builtins.property
+    @pulumi.getter(name="accountId")
+    def account_id(self) -> pulumi.Output[_builtins.int]:
+        """
+        The account ID for the domain.
+        """
+        return pulumi.get(self, "account_id")
+
+    @_builtins.property
+    @pulumi.getter(name="autoRenew")
+    def auto_renew(self) -> pulumi.Output[_builtins.bool]:
+        """
+        Whether the domain is set to auto-renew.
+        """
+        return pulumi.get(self, "auto_renew")
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[_builtins.str]:
+        """
+        The domain name to be created.
+        """
+        return pulumi.get(self, "name")
+
+    @_builtins.property
+    @pulumi.getter(name="privateWhois")
+    def private_whois(self) -> pulumi.Output[_builtins.bool]:
+        """
+        Whether the domain has WhoIs privacy enabled.
+        """
+        return pulumi.get(self, "private_whois")
+
+    @_builtins.property
+    @pulumi.getter(name="registrantId")
+    def registrant_id(self) -> pulumi.Output[_builtins.int]:
+        """
+        The ID of the registrant (contact) for the domain.
+        """
+        return pulumi.get(self, "registrant_id")
+
+    @_builtins.property
+    @pulumi.getter
+    def state(self) -> pulumi.Output[_builtins.str]:
+        """
+        The state of the domain.
+        """
+        return pulumi.get(self, "state")
+
+    @_builtins.property
+    @pulumi.getter(name="unicodeName")
+    def unicode_name(self) -> pulumi.Output[_builtins.str]:
+        """
+        The domain name in Unicode format.
+        """
+        return pulumi.get(self, "unicode_name")
+

pulumi_dnsimple/domain_delegation.py

@@ -0,0 +1,244 @@
+# 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__ = ['DomainDelegationArgs', 'DomainDelegation']
+
+@pulumi.input_type
+class DomainDelegationArgs:
+    def __init__(__self__, *,
+                 domain: pulumi.Input[_builtins.str],
+                 name_servers: pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]):
+        """
+        The set of arguments for constructing a DomainDelegation resource.
+        :param pulumi.Input[_builtins.str] domain: The domain name.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] name_servers: List of name servers to delegate to.
+        """
+        pulumi.set(__self__, "domain", domain)
+        pulumi.set(__self__, "name_servers", name_servers)
+
+    @_builtins.property
+    @pulumi.getter
+    def domain(self) -> pulumi.Input[_builtins.str]:
+        """
+        The domain name.
+        """
+        return pulumi.get(self, "domain")
+
+    @domain.setter
+    def domain(self, value: pulumi.Input[_builtins.str]):
+        pulumi.set(self, "domain", value)
+
+    @_builtins.property
+    @pulumi.getter(name="nameServers")
+    def name_servers(self) -> pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]:
+        """
+        List of name servers to delegate to.
+        """
+        return pulumi.get(self, "name_servers")
+
+    @name_servers.setter
+    def name_servers(self, value: pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]):
+        pulumi.set(self, "name_servers", value)
+
+
+@pulumi.input_type
+class _DomainDelegationState:
+    def __init__(__self__, *,
+                 domain: Optional[pulumi.Input[_builtins.str]] = None,
+                 name_servers: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None):
+        """
+        Input properties used for looking up and filtering DomainDelegation resources.
+        :param pulumi.Input[_builtins.str] domain: The domain name.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] name_servers: List of name servers to delegate to.
+        """
+        if domain is not None:
+            pulumi.set(__self__, "domain", domain)
+        if name_servers is not None:
+            pulumi.set(__self__, "name_servers", name_servers)
+
+    @_builtins.property
+    @pulumi.getter
+    def domain(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The domain name.
+        """
+        return pulumi.get(self, "domain")
+
+    @domain.setter
+    def domain(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "domain", value)
+
+    @_builtins.property
+    @pulumi.getter(name="nameServers")
+    def name_servers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
+        """
+        List of name servers to delegate to.
+        """
+        return pulumi.get(self, "name_servers")
+
+    @name_servers.setter
+    def name_servers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
+        pulumi.set(self, "name_servers", value)
+
+
+@pulumi.type_token("dnsimple:index/domainDelegation:DomainDelegation")
+class DomainDelegation(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 domain: Optional[pulumi.Input[_builtins.str]] = None,
+                 name_servers: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 __props__=None):
+        """
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_dnsimple as dnsimple
+
+        example = dnsimple.DomainDelegation("example",
+            domain="example.com",
+            name_servers=[
+                "ns1.example.org",
+                "ns2.example.com",
+            ])
+        ```
+
+        ## Import
+
+        DNSimple domain delegations can be imported using the domain name.
+
+        bash
+
+        ```sh
+        $ pulumi import dnsimple:index/domainDelegation:DomainDelegation example example.com
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[_builtins.str] domain: The domain name.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] name_servers: List of name servers to delegate to.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: DomainDelegationArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_dnsimple as dnsimple
+
+        example = dnsimple.DomainDelegation("example",
+            domain="example.com",
+            name_servers=[
+                "ns1.example.org",
+                "ns2.example.com",
+            ])
+        ```
+
+        ## Import
+
+        DNSimple domain delegations can be imported using the domain name.
+
+        bash
+
+        ```sh
+        $ pulumi import dnsimple:index/domainDelegation:DomainDelegation example 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[_builtins.str]] = None,
+                 name_servers: Optional[pulumi.Input[Sequence[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__ = 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[_builtins.str]] = None,
+            name_servers: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.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[_builtins.str] domain: The domain name.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] name_servers: List of name servers to delegate to.
+        """
+        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__)
+
+    @_builtins.property
+    @pulumi.getter
+    def domain(self) -> pulumi.Output[_builtins.str]:
+        """
+        The domain name.
+        """
+        return pulumi.get(self, "domain")
+
+    @_builtins.property
+    @pulumi.getter(name="nameServers")
+    def name_servers(self) -> pulumi.Output[Sequence[_builtins.str]]:
+        """
+        List of name servers to delegate to.
+        """
+        return pulumi.get(self, "name_servers")
+