pulumi-digitalocean 4.46.0a1747979086__py3-none-any.whl → 4.56.0a1766428645__py3-none-any.whl

pulumi_digitalocean/byoip_prefix.py

@@ -0,0 +1,452 @@
+# 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__ = ['ByoipPrefixArgs', 'ByoipPrefix']
+
+@pulumi.input_type
+class ByoipPrefixArgs:
+    def __init__(__self__, *,
+                 prefix: pulumi.Input[_builtins.str],
+                 region: pulumi.Input[_builtins.str],
+                 advertised: Optional[pulumi.Input[_builtins.bool]] = None,
+                 signature: Optional[pulumi.Input[_builtins.str]] = None):
+        """
+        The set of arguments for constructing a ByoipPrefix resource.
+        :param pulumi.Input[_builtins.str] prefix: The CIDR notation of the prefix (e.g., "192.0.2.0/24").
+        :param pulumi.Input[_builtins.str] region: The DigitalOcean region where the prefix will be deployed.
+        :param pulumi.Input[_builtins.bool] advertised: A boolean indicating whether the prefix should be advertised.
+               Defaults to `false`.
+        :param pulumi.Input[_builtins.str] signature: The cryptographic signature proving ownership of the prefix.
+               This is required during creation but can be omitted in subsequent updates.
+        """
+        pulumi.set(__self__, "prefix", prefix)
+        pulumi.set(__self__, "region", region)
+        if advertised is not None:
+            pulumi.set(__self__, "advertised", advertised)
+        if signature is not None:
+            pulumi.set(__self__, "signature", signature)
+
+    @_builtins.property
+    @pulumi.getter
+    def prefix(self) -> pulumi.Input[_builtins.str]:
+        """
+        The CIDR notation of the prefix (e.g., "192.0.2.0/24").
+        """
+        return pulumi.get(self, "prefix")
+
+    @prefix.setter
+    def prefix(self, value: pulumi.Input[_builtins.str]):
+        pulumi.set(self, "prefix", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def region(self) -> pulumi.Input[_builtins.str]:
+        """
+        The DigitalOcean region where the prefix will be deployed.
+        """
+        return pulumi.get(self, "region")
+
+    @region.setter
+    def region(self, value: pulumi.Input[_builtins.str]):
+        pulumi.set(self, "region", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def advertised(self) -> Optional[pulumi.Input[_builtins.bool]]:
+        """
+        A boolean indicating whether the prefix should be advertised.
+        Defaults to `false`.
+        """
+        return pulumi.get(self, "advertised")
+
+    @advertised.setter
+    def advertised(self, value: Optional[pulumi.Input[_builtins.bool]]):
+        pulumi.set(self, "advertised", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def signature(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The cryptographic signature proving ownership of the prefix.
+        This is required during creation but can be omitted in subsequent updates.
+        """
+        return pulumi.get(self, "signature")
+
+    @signature.setter
+    def signature(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "signature", value)
+
+
+@pulumi.input_type
+class _ByoipPrefixState:
+    def __init__(__self__, *,
+                 advertised: Optional[pulumi.Input[_builtins.bool]] = None,
+                 failure_reason: Optional[pulumi.Input[_builtins.str]] = None,
+                 prefix: Optional[pulumi.Input[_builtins.str]] = None,
+                 region: Optional[pulumi.Input[_builtins.str]] = None,
+                 signature: Optional[pulumi.Input[_builtins.str]] = None,
+                 status: Optional[pulumi.Input[_builtins.str]] = None,
+                 uuid: Optional[pulumi.Input[_builtins.str]] = None):
+        """
+        Input properties used for looking up and filtering ByoipPrefix resources.
+        :param pulumi.Input[_builtins.bool] advertised: A boolean indicating whether the prefix should be advertised.
+               Defaults to `false`.
+        :param pulumi.Input[_builtins.str] failure_reason: The reason for failure if the status is "failed".
+        :param pulumi.Input[_builtins.str] prefix: The CIDR notation of the prefix (e.g., "192.0.2.0/24").
+        :param pulumi.Input[_builtins.str] region: The DigitalOcean region where the prefix will be deployed.
+        :param pulumi.Input[_builtins.str] signature: The cryptographic signature proving ownership of the prefix.
+               This is required during creation but can be omitted in subsequent updates.
+        :param pulumi.Input[_builtins.str] status: The current status of the BYOIP prefix (e.g., "verified", "pending", "failed").
+        :param pulumi.Input[_builtins.str] uuid: The UUID of the BYOIP prefix.
+        """
+        if advertised is not None:
+            pulumi.set(__self__, "advertised", advertised)
+        if failure_reason is not None:
+            pulumi.set(__self__, "failure_reason", failure_reason)
+        if prefix is not None:
+            pulumi.set(__self__, "prefix", prefix)
+        if region is not None:
+            pulumi.set(__self__, "region", region)
+        if signature is not None:
+            pulumi.set(__self__, "signature", signature)
+        if status is not None:
+            pulumi.set(__self__, "status", status)
+        if uuid is not None:
+            pulumi.set(__self__, "uuid", uuid)
+
+    @_builtins.property
+    @pulumi.getter
+    def advertised(self) -> Optional[pulumi.Input[_builtins.bool]]:
+        """
+        A boolean indicating whether the prefix should be advertised.
+        Defaults to `false`.
+        """
+        return pulumi.get(self, "advertised")
+
+    @advertised.setter
+    def advertised(self, value: Optional[pulumi.Input[_builtins.bool]]):
+        pulumi.set(self, "advertised", value)
+
+    @_builtins.property
+    @pulumi.getter(name="failureReason")
+    def failure_reason(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The reason for failure if the status is "failed".
+        """
+        return pulumi.get(self, "failure_reason")
+
+    @failure_reason.setter
+    def failure_reason(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "failure_reason", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def prefix(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The CIDR notation of the prefix (e.g., "192.0.2.0/24").
+        """
+        return pulumi.get(self, "prefix")
+
+    @prefix.setter
+    def prefix(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "prefix", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def region(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The DigitalOcean region where the prefix will be deployed.
+        """
+        return pulumi.get(self, "region")
+
+    @region.setter
+    def region(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "region", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def signature(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The cryptographic signature proving ownership of the prefix.
+        This is required during creation but can be omitted in subsequent updates.
+        """
+        return pulumi.get(self, "signature")
+
+    @signature.setter
+    def signature(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "signature", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def status(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The current status of the BYOIP prefix (e.g., "verified", "pending", "failed").
+        """
+        return pulumi.get(self, "status")
+
+    @status.setter
+    def status(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "status", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def uuid(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The UUID of the BYOIP prefix.
+        """
+        return pulumi.get(self, "uuid")
+
+    @uuid.setter
+    def uuid(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "uuid", value)
+
+
+@pulumi.type_token("digitalocean:index/byoipPrefix:ByoipPrefix")
+class ByoipPrefix(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 advertised: Optional[pulumi.Input[_builtins.bool]] = None,
+                 prefix: Optional[pulumi.Input[_builtins.str]] = None,
+                 region: Optional[pulumi.Input[_builtins.str]] = None,
+                 signature: Optional[pulumi.Input[_builtins.str]] = None,
+                 __props__=None):
+        """
+        Provides a DigitalOcean BYOIP (Bring Your Own IP) prefix resource. This can be used to
+        create, modify, and delete BYOIP prefixes.
+
+        BYOIP prefixes allow you to bring your own IP address space to DigitalOcean. You can
+        use this feature to maintain your IP reputation or meet specific compliance requirements.
+
+        BYOIP prefix provisioning documentation: https://docs.digitalocean.com/products/networking/reserved-ips/how-to/provision-byoip/
+
+        Note: By default, newly provisioned BYOIP prefixes are not advertised to the internet. After the initial `pulumi up`, BYOIP provisioning request is initiated and DigitalOcean provisions the prefix, the prefix status changes to Active. At this point, you can initiate advertising prefix to the internet by setting field `advertised = true` and apply the configuration to make your prefix fully usable and accessible from the internet.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_digitalocean as digitalocean
+
+        # Create a new BYOIP prefix
+        example = digitalocean.ByoipPrefix("example",
+            prefix="192.0.2.0/24",
+            signature=prefix_signature,
+            region="nyc3",
+            advertised=False)
+        ```
+
+        ## Import
+
+        BYOIP prefixes can be imported using the prefix `uuid`, e.g.
+
+        ```sh
+        $ pulumi import digitalocean:index/byoipPrefix:ByoipPrefix example 506f78a4-e098-11e5-ad9f-000f53306ae1
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[_builtins.bool] advertised: A boolean indicating whether the prefix should be advertised.
+               Defaults to `false`.
+        :param pulumi.Input[_builtins.str] prefix: The CIDR notation of the prefix (e.g., "192.0.2.0/24").
+        :param pulumi.Input[_builtins.str] region: The DigitalOcean region where the prefix will be deployed.
+        :param pulumi.Input[_builtins.str] signature: The cryptographic signature proving ownership of the prefix.
+               This is required during creation but can be omitted in subsequent updates.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: ByoipPrefixArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Provides a DigitalOcean BYOIP (Bring Your Own IP) prefix resource. This can be used to
+        create, modify, and delete BYOIP prefixes.
+
+        BYOIP prefixes allow you to bring your own IP address space to DigitalOcean. You can
+        use this feature to maintain your IP reputation or meet specific compliance requirements.
+
+        BYOIP prefix provisioning documentation: https://docs.digitalocean.com/products/networking/reserved-ips/how-to/provision-byoip/
+
+        Note: By default, newly provisioned BYOIP prefixes are not advertised to the internet. After the initial `pulumi up`, BYOIP provisioning request is initiated and DigitalOcean provisions the prefix, the prefix status changes to Active. At this point, you can initiate advertising prefix to the internet by setting field `advertised = true` and apply the configuration to make your prefix fully usable and accessible from the internet.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_digitalocean as digitalocean
+
+        # Create a new BYOIP prefix
+        example = digitalocean.ByoipPrefix("example",
+            prefix="192.0.2.0/24",
+            signature=prefix_signature,
+            region="nyc3",
+            advertised=False)
+        ```
+
+        ## Import
+
+        BYOIP prefixes can be imported using the prefix `uuid`, e.g.
+
+        ```sh
+        $ pulumi import digitalocean:index/byoipPrefix:ByoipPrefix example 506f78a4-e098-11e5-ad9f-000f53306ae1
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param ByoipPrefixArgs 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(ByoipPrefixArgs, 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,
+                 advertised: Optional[pulumi.Input[_builtins.bool]] = None,
+                 prefix: Optional[pulumi.Input[_builtins.str]] = None,
+                 region: Optional[pulumi.Input[_builtins.str]] = None,
+                 signature: 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__ = ByoipPrefixArgs.__new__(ByoipPrefixArgs)
+
+            __props__.__dict__["advertised"] = advertised
+            if prefix is None and not opts.urn:
+                raise TypeError("Missing required property 'prefix'")
+            __props__.__dict__["prefix"] = prefix
+            if region is None and not opts.urn:
+                raise TypeError("Missing required property 'region'")
+            __props__.__dict__["region"] = region
+            __props__.__dict__["signature"] = signature
+            __props__.__dict__["failure_reason"] = None
+            __props__.__dict__["status"] = None
+            __props__.__dict__["uuid"] = None
+        super(ByoipPrefix, __self__).__init__(
+            'digitalocean:index/byoipPrefix:ByoipPrefix',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            advertised: Optional[pulumi.Input[_builtins.bool]] = None,
+            failure_reason: Optional[pulumi.Input[_builtins.str]] = None,
+            prefix: Optional[pulumi.Input[_builtins.str]] = None,
+            region: Optional[pulumi.Input[_builtins.str]] = None,
+            signature: Optional[pulumi.Input[_builtins.str]] = None,
+            status: Optional[pulumi.Input[_builtins.str]] = None,
+            uuid: Optional[pulumi.Input[_builtins.str]] = None) -> 'ByoipPrefix':
+        """
+        Get an existing ByoipPrefix 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.bool] advertised: A boolean indicating whether the prefix should be advertised.
+               Defaults to `false`.
+        :param pulumi.Input[_builtins.str] failure_reason: The reason for failure if the status is "failed".
+        :param pulumi.Input[_builtins.str] prefix: The CIDR notation of the prefix (e.g., "192.0.2.0/24").
+        :param pulumi.Input[_builtins.str] region: The DigitalOcean region where the prefix will be deployed.
+        :param pulumi.Input[_builtins.str] signature: The cryptographic signature proving ownership of the prefix.
+               This is required during creation but can be omitted in subsequent updates.
+        :param pulumi.Input[_builtins.str] status: The current status of the BYOIP prefix (e.g., "verified", "pending", "failed").
+        :param pulumi.Input[_builtins.str] uuid: The UUID of the BYOIP prefix.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _ByoipPrefixState.__new__(_ByoipPrefixState)
+
+        __props__.__dict__["advertised"] = advertised
+        __props__.__dict__["failure_reason"] = failure_reason
+        __props__.__dict__["prefix"] = prefix
+        __props__.__dict__["region"] = region
+        __props__.__dict__["signature"] = signature
+        __props__.__dict__["status"] = status
+        __props__.__dict__["uuid"] = uuid
+        return ByoipPrefix(resource_name, opts=opts, __props__=__props__)
+
+    @_builtins.property
+    @pulumi.getter
+    def advertised(self) -> pulumi.Output[Optional[_builtins.bool]]:
+        """
+        A boolean indicating whether the prefix should be advertised.
+        Defaults to `false`.
+        """
+        return pulumi.get(self, "advertised")
+
+    @_builtins.property
+    @pulumi.getter(name="failureReason")
+    def failure_reason(self) -> pulumi.Output[_builtins.str]:
+        """
+        The reason for failure if the status is "failed".
+        """
+        return pulumi.get(self, "failure_reason")
+
+    @_builtins.property
+    @pulumi.getter
+    def prefix(self) -> pulumi.Output[_builtins.str]:
+        """
+        The CIDR notation of the prefix (e.g., "192.0.2.0/24").
+        """
+        return pulumi.get(self, "prefix")
+
+    @_builtins.property
+    @pulumi.getter
+    def region(self) -> pulumi.Output[_builtins.str]:
+        """
+        The DigitalOcean region where the prefix will be deployed.
+        """
+        return pulumi.get(self, "region")
+
+    @_builtins.property
+    @pulumi.getter
+    def signature(self) -> pulumi.Output[Optional[_builtins.str]]:
+        """
+        The cryptographic signature proving ownership of the prefix.
+        This is required during creation but can be omitted in subsequent updates.
+        """
+        return pulumi.get(self, "signature")
+
+    @_builtins.property
+    @pulumi.getter
+    def status(self) -> pulumi.Output[_builtins.str]:
+        """
+        The current status of the BYOIP prefix (e.g., "verified", "pending", "failed").
+        """
+        return pulumi.get(self, "status")
+
+    @_builtins.property
+    @pulumi.getter
+    def uuid(self) -> pulumi.Output[_builtins.str]:
+        """
+        The UUID of the BYOIP prefix.
+        """
+        return pulumi.get(self, "uuid")
+