pulumi-digitalocean 4.49.0a1751946418__py3-none-any.whl → 4.50.0__py3-none-any.whl

pulumi_digitalocean/get_database_cluster.py

@@ -2,8 +2,7 @@
 # *** 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
-import copy
+import builtins as _builtins
 import warnings
 import sys
 import pulumi
@@ -28,7 +27,7 @@ class GetDatabaseClusterResult:
     """
     A collection of values returned by getDatabaseCluster.
     """
-    def __init__(__self__, database=None, engine=None, host=None, id=None, maintenance_windows=None, name=None, node_count=None, password=None, port=None, private_host=None, private_network_uuid=None, private_uri=None, project_id=None, region=None, size=None, storage_size_mib=None, tags=None, ui_database=None, ui_host=None, ui_password=None, ui_port=None, ui_uri=None, ui_user=None, uri=None, urn=None, user=None, version=None):
+    def __init__(__self__, database=None, engine=None, host=None, id=None, maintenance_windows=None, metrics_endpoints=None, name=None, node_count=None, password=None, port=None, private_host=None, private_network_uuid=None, private_uri=None, project_id=None, region=None, size=None, storage_size_mib=None, tags=None, ui_database=None, ui_host=None, ui_password=None, ui_port=None, ui_uri=None, ui_user=None, uri=None, urn=None, user=None, version=None):
         if database and not isinstance(database, str):
             raise TypeError("Expected argument 'database' to be a str")
         pulumi.set(__self__, "database", database)
@@ -44,6 +43,9 @@ class GetDatabaseClusterResult:
         if maintenance_windows and not isinstance(maintenance_windows, list):
             raise TypeError("Expected argument 'maintenance_windows' to be a list")
         pulumi.set(__self__, "maintenance_windows", maintenance_windows)
+        if metrics_endpoints and not isinstance(metrics_endpoints, list):
+            raise TypeError("Expected argument 'metrics_endpoints' to be a list")
+        pulumi.set(__self__, "metrics_endpoints", metrics_endpoints)
         if name and not isinstance(name, str):
             raise TypeError("Expected argument 'name' to be a str")
         pulumi.set(__self__, "name", name)
@@ -111,39 +113,39 @@ class GetDatabaseClusterResult:
             raise TypeError("Expected argument 'version' to be a str")
         pulumi.set(__self__, "version", version)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def database(self) -> builtins.str:
+    def database(self) -> _builtins.str:
         """
         Name of the cluster's default database.
         """
         return pulumi.get(self, "database")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def engine(self) -> builtins.str:
+    def engine(self) -> _builtins.str:
         """
         Database engine used by the cluster (ex. `pg` for PostgreSQL).
         """
         return pulumi.get(self, "engine")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def host(self) -> builtins.str:
+    def host(self) -> _builtins.str:
         """
         Database cluster's hostname.
         """
         return pulumi.get(self, "host")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def id(self) -> builtins.str:
+    def id(self) -> _builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
         return pulumi.get(self, "id")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="maintenanceWindows")
     def maintenance_windows(self) -> Sequence['outputs.GetDatabaseClusterMaintenanceWindowResult']:
         """
@@ -151,168 +153,176 @@ class GetDatabaseClusterResult:
         """
         return pulumi.get(self, "maintenance_windows")
 
-    @property
+    @_builtins.property
+    @pulumi.getter(name="metricsEndpoints")
+    def metrics_endpoints(self) -> Sequence[_builtins.str]:
+        """
+        A list of metrics endpoints for the database cluster, providing URLs to access Prometheus-compatible metrics.
+        """
+        return pulumi.get(self, "metrics_endpoints")
+
+    @_builtins.property
     @pulumi.getter
-    def name(self) -> builtins.str:
+    def name(self) -> _builtins.str:
         return pulumi.get(self, "name")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="nodeCount")
-    def node_count(self) -> builtins.int:
+    def node_count(self) -> _builtins.int:
         """
         Number of nodes that will be included in the cluster.
         """
         return pulumi.get(self, "node_count")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def password(self) -> builtins.str:
+    def password(self) -> _builtins.str:
         """
         Password for the cluster's default user.
         """
         return pulumi.get(self, "password")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def port(self) -> builtins.int:
+    def port(self) -> _builtins.int:
         """
         Network port that the database cluster is listening on.
         """
         return pulumi.get(self, "port")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="privateHost")
-    def private_host(self) -> builtins.str:
+    def private_host(self) -> _builtins.str:
         """
         Same as `host`, but only accessible from resources within the account and in the same region.
         """
         return pulumi.get(self, "private_host")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="privateNetworkUuid")
-    def private_network_uuid(self) -> builtins.str:
+    def private_network_uuid(self) -> _builtins.str:
         """
         The ID of the VPC where the database cluster is located.
         """
         return pulumi.get(self, "private_network_uuid")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="privateUri")
-    def private_uri(self) -> builtins.str:
+    def private_uri(self) -> _builtins.str:
         """
         Same as `uri`, but only accessible from resources within the account and in the same region.
         """
         return pulumi.get(self, "private_uri")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="projectId")
-    def project_id(self) -> builtins.str:
+    def project_id(self) -> _builtins.str:
         """
         The ID of the project that the database cluster is assigned to.
         """
         return pulumi.get(self, "project_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def region(self) -> builtins.str:
+    def region(self) -> _builtins.str:
         """
         DigitalOcean region where the cluster will reside.
         """
         return pulumi.get(self, "region")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def size(self) -> builtins.str:
+    def size(self) -> _builtins.str:
         """
         Database droplet size associated with the cluster (ex. `db-s-1vcpu-1gb`).
         """
         return pulumi.get(self, "size")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="storageSizeMib")
-    def storage_size_mib(self) -> builtins.str:
+    def storage_size_mib(self) -> _builtins.str:
         return pulumi.get(self, "storage_size_mib")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def tags(self) -> Optional[Sequence[builtins.str]]:
+    def tags(self) -> Optional[Sequence[_builtins.str]]:
         return pulumi.get(self, "tags")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="uiDatabase")
-    def ui_database(self) -> builtins.str:
+    def ui_database(self) -> _builtins.str:
         """
         Name of the OpenSearch dashboard db.
         """
         return pulumi.get(self, "ui_database")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="uiHost")
-    def ui_host(self) -> builtins.str:
+    def ui_host(self) -> _builtins.str:
         """
         Hostname for the OpenSearch dashboard.
         """
         return pulumi.get(self, "ui_host")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="uiPassword")
-    def ui_password(self) -> builtins.str:
+    def ui_password(self) -> _builtins.str:
         """
         Password for the OpenSearch dashboard's default user.
         """
         return pulumi.get(self, "ui_password")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="uiPort")
-    def ui_port(self) -> builtins.int:
+    def ui_port(self) -> _builtins.int:
         """
         Network port that the OpenSearch dashboard is listening on.
         """
         return pulumi.get(self, "ui_port")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="uiUri")
-    def ui_uri(self) -> builtins.str:
+    def ui_uri(self) -> _builtins.str:
         """
         The full URI for connecting to the OpenSearch dashboard.
         """
         return pulumi.get(self, "ui_uri")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="uiUser")
-    def ui_user(self) -> builtins.str:
+    def ui_user(self) -> _builtins.str:
         """
         Username for OpenSearch dashboard's default user.
         """
         return pulumi.get(self, "ui_user")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def uri(self) -> builtins.str:
+    def uri(self) -> _builtins.str:
         """
         The full URI for connecting to the database cluster.
         """
         return pulumi.get(self, "uri")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def urn(self) -> builtins.str:
+    def urn(self) -> _builtins.str:
         """
         The uniform resource name of the database cluster.
         """
         return pulumi.get(self, "urn")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def user(self) -> builtins.str:
+    def user(self) -> _builtins.str:
         """
         Username for the cluster's default user.
         """
         return pulumi.get(self, "user")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def version(self) -> builtins.str:
+    def version(self) -> _builtins.str:
         """
         Engine version used by the cluster (ex. `11` for PostgreSQL 11).
         """
@@ -330,6 +340,7 @@ class AwaitableGetDatabaseClusterResult(GetDatabaseClusterResult):
             host=self.host,
             id=self.id,
             maintenance_windows=self.maintenance_windows,
+            metrics_endpoints=self.metrics_endpoints,
             name=self.name,
             node_count=self.node_count,
             password=self.password,
@@ -354,8 +365,8 @@ class AwaitableGetDatabaseClusterResult(GetDatabaseClusterResult):
             version=self.version)
 
 
-def get_database_cluster(name: Optional[builtins.str] = None,
-                         tags: Optional[Sequence[builtins.str]] = None,
+def get_database_cluster(name: Optional[_builtins.str] = None,
+                         tags: Optional[Sequence[_builtins.str]] = None,
                          opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDatabaseClusterResult:
     """
     Provides information on a DigitalOcean database cluster resource.
@@ -371,7 +382,7 @@ def get_database_cluster(name: Optional[builtins.str] = None,
     ```
 
 
-    :param builtins.str name: The name of the database cluster.
+    :param _builtins.str name: The name of the database cluster.
     """
     __args__ = dict()
     __args__['name'] = name
@@ -385,6 +396,7 @@ def get_database_cluster(name: Optional[builtins.str] = None,
         host=pulumi.get(__ret__, 'host'),
         id=pulumi.get(__ret__, 'id'),
         maintenance_windows=pulumi.get(__ret__, 'maintenance_windows'),
+        metrics_endpoints=pulumi.get(__ret__, 'metrics_endpoints'),
         name=pulumi.get(__ret__, 'name'),
         node_count=pulumi.get(__ret__, 'node_count'),
         password=pulumi.get(__ret__, 'password'),
@@ -407,8 +419,8 @@ def get_database_cluster(name: Optional[builtins.str] = None,
         urn=pulumi.get(__ret__, 'urn'),
         user=pulumi.get(__ret__, 'user'),
         version=pulumi.get(__ret__, 'version'))
-def get_database_cluster_output(name: Optional[pulumi.Input[builtins.str]] = None,
-                                tags: Optional[pulumi.Input[Optional[Sequence[builtins.str]]]] = None,
+def get_database_cluster_output(name: Optional[pulumi.Input[_builtins.str]] = None,
+                                tags: Optional[pulumi.Input[Optional[Sequence[_builtins.str]]]] = None,
                                 opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDatabaseClusterResult]:
     """
     Provides information on a DigitalOcean database cluster resource.
@@ -424,7 +436,7 @@ def get_database_cluster_output(name: Optional[pulumi.Input[builtins.str]] = Non
     ```
 
 
-    :param builtins.str name: The name of the database cluster.
+    :param _builtins.str name: The name of the database cluster.
     """
     __args__ = dict()
     __args__['name'] = name
@@ -437,6 +449,7 @@ def get_database_cluster_output(name: Optional[pulumi.Input[builtins.str]] = Non
         host=pulumi.get(__response__, 'host'),
         id=pulumi.get(__response__, 'id'),
         maintenance_windows=pulumi.get(__response__, 'maintenance_windows'),
+        metrics_endpoints=pulumi.get(__response__, 'metrics_endpoints'),
         name=pulumi.get(__response__, 'name'),
         node_count=pulumi.get(__response__, 'node_count'),
         password=pulumi.get(__response__, 'password'),

pulumi_digitalocean/get_database_connection_pool.py

@@ -2,8 +2,7 @@
 # *** 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
-import copy
+import builtins as _builtins
 import warnings
 import sys
 import pulumi
@@ -68,99 +67,99 @@ class GetDatabaseConnectionPoolResult:
             raise TypeError("Expected argument 'user' to be a str")
         pulumi.set(__self__, "user", user)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="clusterId")
-    def cluster_id(self) -> builtins.str:
+    def cluster_id(self) -> _builtins.str:
         return pulumi.get(self, "cluster_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="dbName")
-    def db_name(self) -> builtins.str:
+    def db_name(self) -> _builtins.str:
         """
         Name of the connection pool's default database.
         """
         return pulumi.get(self, "db_name")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def host(self) -> builtins.str:
+    def host(self) -> _builtins.str:
         """
         Connection pool hostname.
         """
         return pulumi.get(self, "host")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def id(self) -> builtins.str:
+    def id(self) -> _builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
         return pulumi.get(self, "id")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def mode(self) -> builtins.str:
+    def mode(self) -> _builtins.str:
         """
         The transaction mode for the connection pool.
         """
         return pulumi.get(self, "mode")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def name(self) -> builtins.str:
+    def name(self) -> _builtins.str:
         return pulumi.get(self, "name")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def password(self) -> builtins.str:
+    def password(self) -> _builtins.str:
         """
         Password for the connection pool's default user.
         """
         return pulumi.get(self, "password")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def port(self) -> builtins.int:
+    def port(self) -> _builtins.int:
         """
         Network port that the connection pool is listening on.
         """
         return pulumi.get(self, "port")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="privateHost")
-    def private_host(self) -> builtins.str:
+    def private_host(self) -> _builtins.str:
         """
         Same as `host`, but only accessible from resources within the account and in the same region.
         """
         return pulumi.get(self, "private_host")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="privateUri")
-    def private_uri(self) -> builtins.str:
+    def private_uri(self) -> _builtins.str:
         """
         Same as `uri`, but only accessible from resources within the account and in the same region.
         """
         return pulumi.get(self, "private_uri")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def size(self) -> builtins.int:
+    def size(self) -> _builtins.int:
         """
         Size of the connection pool.
         """
         return pulumi.get(self, "size")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def uri(self) -> builtins.str:
+    def uri(self) -> _builtins.str:
         """
         The full URI for connecting to the database connection pool.
         """
         return pulumi.get(self, "uri")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def user(self) -> builtins.str:
+    def user(self) -> _builtins.str:
         """
         Username for the connection pool's default user.
         """
@@ -188,8 +187,8 @@ class AwaitableGetDatabaseConnectionPoolResult(GetDatabaseConnectionPoolResult):
             user=self.user)
 
 
-def get_database_connection_pool(cluster_id: Optional[builtins.str] = None,
-                                 name: Optional[builtins.str] = None,
+def get_database_connection_pool(cluster_id: Optional[_builtins.str] = None,
+                                 name: Optional[_builtins.str] = None,
                                  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDatabaseConnectionPoolResult:
     """
     Provides information on a DigitalOcean PostgreSQL database connection pool.
@@ -207,8 +206,8 @@ def get_database_connection_pool(cluster_id: Optional[builtins.str] = None,
     ```
 
 
-    :param builtins.str cluster_id: The ID of the original source database cluster.
-    :param builtins.str name: The name for the database connection pool.
+    :param _builtins.str cluster_id: The ID of the original source database cluster.
+    :param _builtins.str name: The name for the database connection pool.
     """
     __args__ = dict()
     __args__['clusterId'] = cluster_id
@@ -230,8 +229,8 @@ def get_database_connection_pool(cluster_id: Optional[builtins.str] = None,
         size=pulumi.get(__ret__, 'size'),
         uri=pulumi.get(__ret__, 'uri'),
         user=pulumi.get(__ret__, 'user'))
-def get_database_connection_pool_output(cluster_id: Optional[pulumi.Input[builtins.str]] = None,
-                                        name: Optional[pulumi.Input[builtins.str]] = None,
+def get_database_connection_pool_output(cluster_id: Optional[pulumi.Input[_builtins.str]] = None,
+                                        name: Optional[pulumi.Input[_builtins.str]] = None,
                                         opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDatabaseConnectionPoolResult]:
     """
     Provides information on a DigitalOcean PostgreSQL database connection pool.
@@ -249,8 +248,8 @@ def get_database_connection_pool_output(cluster_id: Optional[pulumi.Input[builti
     ```
 
 
-    :param builtins.str cluster_id: The ID of the original source database cluster.
-    :param builtins.str name: The name for the database connection pool.
+    :param _builtins.str cluster_id: The ID of the original source database cluster.
+    :param _builtins.str name: The name for the database connection pool.
     """
     __args__ = dict()
     __args__['clusterId'] = cluster_id

pulumi_digitalocean/get_database_metrics_credentials.py

@@ -0,0 +1,120 @@
+# 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__ = [
+    'GetDatabaseMetricsCredentialsResult',
+    'AwaitableGetDatabaseMetricsCredentialsResult',
+    'get_database_metrics_credentials',
+    'get_database_metrics_credentials_output',
+]
+
+@pulumi.output_type
+class GetDatabaseMetricsCredentialsResult:
+    """
+    A collection of values returned by getDatabaseMetricsCredentials.
+    """
+    def __init__(__self__, id=None, password=None, username=None):
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if password and not isinstance(password, str):
+            raise TypeError("Expected argument 'password' to be a str")
+        pulumi.set(__self__, "password", password)
+        if username and not isinstance(username, str):
+            raise TypeError("Expected argument 'username' to be a str")
+        pulumi.set(__self__, "username", username)
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter
+    def password(self) -> _builtins.str:
+        """
+        The password for accessing database metrics. This is marked as sensitive.
+        """
+        return pulumi.get(self, "password")
+
+    @_builtins.property
+    @pulumi.getter
+    def username(self) -> _builtins.str:
+        """
+        The username for accessing database metrics.
+        """
+        return pulumi.get(self, "username")
+
+
+class AwaitableGetDatabaseMetricsCredentialsResult(GetDatabaseMetricsCredentialsResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetDatabaseMetricsCredentialsResult(
+            id=self.id,
+            password=self.password,
+            username=self.username)
+
+
+def get_database_metrics_credentials(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDatabaseMetricsCredentialsResult:
+    """
+    Provides access to the metrics credentials for DigitalOcean database clusters. These credentials are account-wide and can be used to access metrics for any database cluster in the account.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_digitalocean as digitalocean
+
+    example = digitalocean.get_database_metrics_credentials()
+    pulumi.export("metricsUsername", example.username)
+    pulumi.export("metricsPassword", example.password)
+    ```
+    """
+    __args__ = dict()
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('digitalocean:index/getDatabaseMetricsCredentials:getDatabaseMetricsCredentials', __args__, opts=opts, typ=GetDatabaseMetricsCredentialsResult).value
+
+    return AwaitableGetDatabaseMetricsCredentialsResult(
+        id=pulumi.get(__ret__, 'id'),
+        password=pulumi.get(__ret__, 'password'),
+        username=pulumi.get(__ret__, 'username'))
+def get_database_metrics_credentials_output(opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDatabaseMetricsCredentialsResult]:
+    """
+    Provides access to the metrics credentials for DigitalOcean database clusters. These credentials are account-wide and can be used to access metrics for any database cluster in the account.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_digitalocean as digitalocean
+
+    example = digitalocean.get_database_metrics_credentials()
+    pulumi.export("metricsUsername", example.username)
+    pulumi.export("metricsPassword", example.password)
+    ```
+    """
+    __args__ = dict()
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('digitalocean:index/getDatabaseMetricsCredentials:getDatabaseMetricsCredentials', __args__, opts=opts, typ=GetDatabaseMetricsCredentialsResult)
+    return __ret__.apply(lambda __response__: GetDatabaseMetricsCredentialsResult(
+        id=pulumi.get(__response__, 'id'),
+        password=pulumi.get(__response__, 'password'),
+        username=pulumi.get(__response__, 'username')))