pulumi-oci 3.4.0a1755714728__py3-none-any.whl → 3.5.0a1756190604__py3-none-any.whl

pulumi_oci/databasemanagement/get_cloud_cluster.py

@@ -0,0 +1,408 @@
+# 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
+
+__all__ = [
+    'GetCloudClusterResult',
+    'AwaitableGetCloudClusterResult',
+    'get_cloud_cluster',
+    'get_cloud_cluster_output',
+]
+
+@pulumi.output_type
+class GetCloudClusterResult:
+    """
+    A collection of values returned by getCloudCluster.
+    """
+    def __init__(__self__, additional_details=None, cloud_cluster_id=None, cloud_connector_id=None, cloud_db_system_id=None, compartment_id=None, component_name=None, dbaas_id=None, defined_tags=None, display_name=None, freeform_tags=None, grid_home=None, id=None, is_flex_cluster=None, lifecycle_details=None, network_configurations=None, ocr_file_location=None, scan_configurations=None, state=None, system_tags=None, time_created=None, time_updated=None, version=None, vip_configurations=None):
+        if additional_details and not isinstance(additional_details, dict):
+            raise TypeError("Expected argument 'additional_details' to be a dict")
+        pulumi.set(__self__, "additional_details", additional_details)
+        if cloud_cluster_id and not isinstance(cloud_cluster_id, str):
+            raise TypeError("Expected argument 'cloud_cluster_id' to be a str")
+        pulumi.set(__self__, "cloud_cluster_id", cloud_cluster_id)
+        if cloud_connector_id and not isinstance(cloud_connector_id, str):
+            raise TypeError("Expected argument 'cloud_connector_id' to be a str")
+        pulumi.set(__self__, "cloud_connector_id", cloud_connector_id)
+        if cloud_db_system_id and not isinstance(cloud_db_system_id, str):
+            raise TypeError("Expected argument 'cloud_db_system_id' to be a str")
+        pulumi.set(__self__, "cloud_db_system_id", cloud_db_system_id)
+        if compartment_id and not isinstance(compartment_id, str):
+            raise TypeError("Expected argument 'compartment_id' to be a str")
+        pulumi.set(__self__, "compartment_id", compartment_id)
+        if component_name and not isinstance(component_name, str):
+            raise TypeError("Expected argument 'component_name' to be a str")
+        pulumi.set(__self__, "component_name", component_name)
+        if dbaas_id and not isinstance(dbaas_id, str):
+            raise TypeError("Expected argument 'dbaas_id' to be a str")
+        pulumi.set(__self__, "dbaas_id", dbaas_id)
+        if defined_tags and not isinstance(defined_tags, dict):
+            raise TypeError("Expected argument 'defined_tags' to be a dict")
+        pulumi.set(__self__, "defined_tags", defined_tags)
+        if display_name and not isinstance(display_name, str):
+            raise TypeError("Expected argument 'display_name' to be a str")
+        pulumi.set(__self__, "display_name", display_name)
+        if freeform_tags and not isinstance(freeform_tags, dict):
+            raise TypeError("Expected argument 'freeform_tags' to be a dict")
+        pulumi.set(__self__, "freeform_tags", freeform_tags)
+        if grid_home and not isinstance(grid_home, str):
+            raise TypeError("Expected argument 'grid_home' to be a str")
+        pulumi.set(__self__, "grid_home", grid_home)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if is_flex_cluster and not isinstance(is_flex_cluster, bool):
+            raise TypeError("Expected argument 'is_flex_cluster' to be a bool")
+        pulumi.set(__self__, "is_flex_cluster", is_flex_cluster)
+        if lifecycle_details and not isinstance(lifecycle_details, str):
+            raise TypeError("Expected argument 'lifecycle_details' to be a str")
+        pulumi.set(__self__, "lifecycle_details", lifecycle_details)
+        if network_configurations and not isinstance(network_configurations, list):
+            raise TypeError("Expected argument 'network_configurations' to be a list")
+        pulumi.set(__self__, "network_configurations", network_configurations)
+        if ocr_file_location and not isinstance(ocr_file_location, str):
+            raise TypeError("Expected argument 'ocr_file_location' to be a str")
+        pulumi.set(__self__, "ocr_file_location", ocr_file_location)
+        if scan_configurations and not isinstance(scan_configurations, list):
+            raise TypeError("Expected argument 'scan_configurations' to be a list")
+        pulumi.set(__self__, "scan_configurations", scan_configurations)
+        if state and not isinstance(state, str):
+            raise TypeError("Expected argument 'state' to be a str")
+        pulumi.set(__self__, "state", state)
+        if system_tags and not isinstance(system_tags, dict):
+            raise TypeError("Expected argument 'system_tags' to be a dict")
+        pulumi.set(__self__, "system_tags", system_tags)
+        if time_created and not isinstance(time_created, str):
+            raise TypeError("Expected argument 'time_created' to be a str")
+        pulumi.set(__self__, "time_created", time_created)
+        if time_updated and not isinstance(time_updated, str):
+            raise TypeError("Expected argument 'time_updated' to be a str")
+        pulumi.set(__self__, "time_updated", time_updated)
+        if version and not isinstance(version, str):
+            raise TypeError("Expected argument 'version' to be a str")
+        pulumi.set(__self__, "version", version)
+        if vip_configurations and not isinstance(vip_configurations, list):
+            raise TypeError("Expected argument 'vip_configurations' to be a list")
+        pulumi.set(__self__, "vip_configurations", vip_configurations)
+
+    @_builtins.property
+    @pulumi.getter(name="additionalDetails")
+    def additional_details(self) -> Mapping[str, _builtins.str]:
+        """
+        The additional details of the cloud cluster defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}`
+        """
+        return pulumi.get(self, "additional_details")
+
+    @_builtins.property
+    @pulumi.getter(name="cloudClusterId")
+    def cloud_cluster_id(self) -> _builtins.str:
+        return pulumi.get(self, "cloud_cluster_id")
+
+    @_builtins.property
+    @pulumi.getter(name="cloudConnectorId")
+    def cloud_connector_id(self) -> _builtins.str:
+        """
+        The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud connector.
+        """
+        return pulumi.get(self, "cloud_connector_id")
+
+    @_builtins.property
+    @pulumi.getter(name="cloudDbSystemId")
+    def cloud_db_system_id(self) -> _builtins.str:
+        """
+        The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system that the cluster is a part of.
+        """
+        return pulumi.get(self, "cloud_db_system_id")
+
+    @_builtins.property
+    @pulumi.getter(name="compartmentId")
+    def compartment_id(self) -> _builtins.str:
+        """
+        The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
+        """
+        return pulumi.get(self, "compartment_id")
+
+    @_builtins.property
+    @pulumi.getter(name="componentName")
+    def component_name(self) -> _builtins.str:
+        """
+        The name of the cloud cluster.
+        """
+        return pulumi.get(self, "component_name")
+
+    @_builtins.property
+    @pulumi.getter(name="dbaasId")
+    def dbaas_id(self) -> _builtins.str:
+        """
+        The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) in DBaas service.
+        """
+        return pulumi.get(self, "dbaas_id")
+
+    @_builtins.property
+    @pulumi.getter(name="definedTags")
+    def defined_tags(self) -> Mapping[str, _builtins.str]:
+        """
+        Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
+        """
+        return pulumi.get(self, "defined_tags")
+
+    @_builtins.property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> _builtins.str:
+        """
+        The user-friendly name for the cloud cluster. The name does not have to be unique.
+        """
+        return pulumi.get(self, "display_name")
+
+    @_builtins.property
+    @pulumi.getter(name="freeformTags")
+    def freeform_tags(self) -> Mapping[str, _builtins.str]:
+        """
+        Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
+        """
+        return pulumi.get(self, "freeform_tags")
+
+    @_builtins.property
+    @pulumi.getter(name="gridHome")
+    def grid_home(self) -> _builtins.str:
+        """
+        The directory in which Oracle Grid Infrastructure is installed.
+        """
+        return pulumi.get(self, "grid_home")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud cluster.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter(name="isFlexCluster")
+    def is_flex_cluster(self) -> _builtins.bool:
+        """
+        Indicates whether the cluster is Oracle Flex Cluster or not.
+        """
+        return pulumi.get(self, "is_flex_cluster")
+
+    @_builtins.property
+    @pulumi.getter(name="lifecycleDetails")
+    def lifecycle_details(self) -> _builtins.str:
+        """
+        Additional information about the current lifecycle state.
+        """
+        return pulumi.get(self, "lifecycle_details")
+
+    @_builtins.property
+    @pulumi.getter(name="networkConfigurations")
+    def network_configurations(self) -> Sequence['outputs.GetCloudClusterNetworkConfigurationResult']:
+        """
+        The list of network address configurations of the cloud cluster.
+        """
+        return pulumi.get(self, "network_configurations")
+
+    @_builtins.property
+    @pulumi.getter(name="ocrFileLocation")
+    def ocr_file_location(self) -> _builtins.str:
+        """
+        The location of the Oracle Cluster Registry (OCR).
+        """
+        return pulumi.get(self, "ocr_file_location")
+
+    @_builtins.property
+    @pulumi.getter(name="scanConfigurations")
+    def scan_configurations(self) -> Sequence['outputs.GetCloudClusterScanConfigurationResult']:
+        """
+        The list of Single Client Access Name (SCAN) configurations of the cloud cluster.
+        """
+        return pulumi.get(self, "scan_configurations")
+
+    @_builtins.property
+    @pulumi.getter
+    def state(self) -> _builtins.str:
+        """
+        The current lifecycle state of the cloud cluster.
+        """
+        return pulumi.get(self, "state")
+
+    @_builtins.property
+    @pulumi.getter(name="systemTags")
+    def system_tags(self) -> Mapping[str, _builtins.str]:
+        """
+        System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system.  Example: `{"orcl-cloud.free-tier-retained": "true"}`
+        """
+        return pulumi.get(self, "system_tags")
+
+    @_builtins.property
+    @pulumi.getter(name="timeCreated")
+    def time_created(self) -> _builtins.str:
+        """
+        The date and time the cloud cluster was created.
+        """
+        return pulumi.get(self, "time_created")
+
+    @_builtins.property
+    @pulumi.getter(name="timeUpdated")
+    def time_updated(self) -> _builtins.str:
+        """
+        The date and time the cloud cluster was last updated.
+        """
+        return pulumi.get(self, "time_updated")
+
+    @_builtins.property
+    @pulumi.getter
+    def version(self) -> _builtins.str:
+        """
+        The cluster version.
+        """
+        return pulumi.get(self, "version")
+
+    @_builtins.property
+    @pulumi.getter(name="vipConfigurations")
+    def vip_configurations(self) -> Sequence['outputs.GetCloudClusterVipConfigurationResult']:
+        """
+        The list of Virtual IP (VIP) configurations of the cloud cluster.
+        """
+        return pulumi.get(self, "vip_configurations")
+
+
+class AwaitableGetCloudClusterResult(GetCloudClusterResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetCloudClusterResult(
+            additional_details=self.additional_details,
+            cloud_cluster_id=self.cloud_cluster_id,
+            cloud_connector_id=self.cloud_connector_id,
+            cloud_db_system_id=self.cloud_db_system_id,
+            compartment_id=self.compartment_id,
+            component_name=self.component_name,
+            dbaas_id=self.dbaas_id,
+            defined_tags=self.defined_tags,
+            display_name=self.display_name,
+            freeform_tags=self.freeform_tags,
+            grid_home=self.grid_home,
+            id=self.id,
+            is_flex_cluster=self.is_flex_cluster,
+            lifecycle_details=self.lifecycle_details,
+            network_configurations=self.network_configurations,
+            ocr_file_location=self.ocr_file_location,
+            scan_configurations=self.scan_configurations,
+            state=self.state,
+            system_tags=self.system_tags,
+            time_created=self.time_created,
+            time_updated=self.time_updated,
+            version=self.version,
+            vip_configurations=self.vip_configurations)
+
+
+def get_cloud_cluster(cloud_cluster_id: Optional[_builtins.str] = None,
+                      opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetCloudClusterResult:
+    """
+    This data source provides details about a specific Cloud Cluster resource in Oracle Cloud Infrastructure Database Management service.
+
+    Gets the details for the cloud cluster specified by `cloudClusterId`.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_oci as oci
+
+    test_cloud_cluster = oci.DatabaseManagement.get_cloud_cluster(cloud_cluster_id=test_cloud_cluster_oci_database_management_cloud_cluster["id"])
+    ```
+
+
+    :param _builtins.str cloud_cluster_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud cluster.
+    """
+    __args__ = dict()
+    __args__['cloudClusterId'] = cloud_cluster_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('oci:DatabaseManagement/getCloudCluster:getCloudCluster', __args__, opts=opts, typ=GetCloudClusterResult).value
+
+    return AwaitableGetCloudClusterResult(
+        additional_details=pulumi.get(__ret__, 'additional_details'),
+        cloud_cluster_id=pulumi.get(__ret__, 'cloud_cluster_id'),
+        cloud_connector_id=pulumi.get(__ret__, 'cloud_connector_id'),
+        cloud_db_system_id=pulumi.get(__ret__, 'cloud_db_system_id'),
+        compartment_id=pulumi.get(__ret__, 'compartment_id'),
+        component_name=pulumi.get(__ret__, 'component_name'),
+        dbaas_id=pulumi.get(__ret__, 'dbaas_id'),
+        defined_tags=pulumi.get(__ret__, 'defined_tags'),
+        display_name=pulumi.get(__ret__, 'display_name'),
+        freeform_tags=pulumi.get(__ret__, 'freeform_tags'),
+        grid_home=pulumi.get(__ret__, 'grid_home'),
+        id=pulumi.get(__ret__, 'id'),
+        is_flex_cluster=pulumi.get(__ret__, 'is_flex_cluster'),
+        lifecycle_details=pulumi.get(__ret__, 'lifecycle_details'),
+        network_configurations=pulumi.get(__ret__, 'network_configurations'),
+        ocr_file_location=pulumi.get(__ret__, 'ocr_file_location'),
+        scan_configurations=pulumi.get(__ret__, 'scan_configurations'),
+        state=pulumi.get(__ret__, 'state'),
+        system_tags=pulumi.get(__ret__, 'system_tags'),
+        time_created=pulumi.get(__ret__, 'time_created'),
+        time_updated=pulumi.get(__ret__, 'time_updated'),
+        version=pulumi.get(__ret__, 'version'),
+        vip_configurations=pulumi.get(__ret__, 'vip_configurations'))
+def get_cloud_cluster_output(cloud_cluster_id: Optional[pulumi.Input[_builtins.str]] = None,
+                             opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetCloudClusterResult]:
+    """
+    This data source provides details about a specific Cloud Cluster resource in Oracle Cloud Infrastructure Database Management service.
+
+    Gets the details for the cloud cluster specified by `cloudClusterId`.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_oci as oci
+
+    test_cloud_cluster = oci.DatabaseManagement.get_cloud_cluster(cloud_cluster_id=test_cloud_cluster_oci_database_management_cloud_cluster["id"])
+    ```
+
+
+    :param _builtins.str cloud_cluster_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud cluster.
+    """
+    __args__ = dict()
+    __args__['cloudClusterId'] = cloud_cluster_id
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('oci:DatabaseManagement/getCloudCluster:getCloudCluster', __args__, opts=opts, typ=GetCloudClusterResult)
+    return __ret__.apply(lambda __response__: GetCloudClusterResult(
+        additional_details=pulumi.get(__response__, 'additional_details'),
+        cloud_cluster_id=pulumi.get(__response__, 'cloud_cluster_id'),
+        cloud_connector_id=pulumi.get(__response__, 'cloud_connector_id'),
+        cloud_db_system_id=pulumi.get(__response__, 'cloud_db_system_id'),
+        compartment_id=pulumi.get(__response__, 'compartment_id'),
+        component_name=pulumi.get(__response__, 'component_name'),
+        dbaas_id=pulumi.get(__response__, 'dbaas_id'),
+        defined_tags=pulumi.get(__response__, 'defined_tags'),
+        display_name=pulumi.get(__response__, 'display_name'),
+        freeform_tags=pulumi.get(__response__, 'freeform_tags'),
+        grid_home=pulumi.get(__response__, 'grid_home'),
+        id=pulumi.get(__response__, 'id'),
+        is_flex_cluster=pulumi.get(__response__, 'is_flex_cluster'),
+        lifecycle_details=pulumi.get(__response__, 'lifecycle_details'),
+        network_configurations=pulumi.get(__response__, 'network_configurations'),
+        ocr_file_location=pulumi.get(__response__, 'ocr_file_location'),
+        scan_configurations=pulumi.get(__response__, 'scan_configurations'),
+        state=pulumi.get(__response__, 'state'),
+        system_tags=pulumi.get(__response__, 'system_tags'),
+        time_created=pulumi.get(__response__, 'time_created'),
+        time_updated=pulumi.get(__response__, 'time_updated'),
+        version=pulumi.get(__response__, 'version'),
+        vip_configurations=pulumi.get(__response__, 'vip_configurations')))