pulumi-oci 2.12.0a1728593306__py3-none-any.whl → 2.12.0a1728642710__py3-none-any.whl

pulumi_oci/datasafe/get_sql_collections.py

@@ -0,0 +1,364 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+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__ = [
+    'GetSqlCollectionsResult',
+    'AwaitableGetSqlCollectionsResult',
+    'get_sql_collections',
+    'get_sql_collections_output',
+]
+
+@pulumi.output_type
+class GetSqlCollectionsResult:
+    """
+    A collection of values returned by getSqlCollections.
+    """
+    def __init__(__self__, access_level=None, compartment_id=None, compartment_id_in_subtree=None, db_user_name=None, display_name=None, filters=None, id=None, sql_collection_collections=None, sql_collection_id=None, state=None, target_id=None, time_created_greater_than_or_equal_to=None, time_created_less_than=None):
+        if access_level and not isinstance(access_level, str):
+            raise TypeError("Expected argument 'access_level' to be a str")
+        pulumi.set(__self__, "access_level", access_level)
+        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 compartment_id_in_subtree and not isinstance(compartment_id_in_subtree, bool):
+            raise TypeError("Expected argument 'compartment_id_in_subtree' to be a bool")
+        pulumi.set(__self__, "compartment_id_in_subtree", compartment_id_in_subtree)
+        if db_user_name and not isinstance(db_user_name, str):
+            raise TypeError("Expected argument 'db_user_name' to be a str")
+        pulumi.set(__self__, "db_user_name", db_user_name)
+        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 filters and not isinstance(filters, list):
+            raise TypeError("Expected argument 'filters' to be a list")
+        pulumi.set(__self__, "filters", filters)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if sql_collection_collections and not isinstance(sql_collection_collections, list):
+            raise TypeError("Expected argument 'sql_collection_collections' to be a list")
+        pulumi.set(__self__, "sql_collection_collections", sql_collection_collections)
+        if sql_collection_id and not isinstance(sql_collection_id, str):
+            raise TypeError("Expected argument 'sql_collection_id' to be a str")
+        pulumi.set(__self__, "sql_collection_id", sql_collection_id)
+        if state and not isinstance(state, str):
+            raise TypeError("Expected argument 'state' to be a str")
+        pulumi.set(__self__, "state", state)
+        if target_id and not isinstance(target_id, str):
+            raise TypeError("Expected argument 'target_id' to be a str")
+        pulumi.set(__self__, "target_id", target_id)
+        if time_created_greater_than_or_equal_to and not isinstance(time_created_greater_than_or_equal_to, str):
+            raise TypeError("Expected argument 'time_created_greater_than_or_equal_to' to be a str")
+        pulumi.set(__self__, "time_created_greater_than_or_equal_to", time_created_greater_than_or_equal_to)
+        if time_created_less_than and not isinstance(time_created_less_than, str):
+            raise TypeError("Expected argument 'time_created_less_than' to be a str")
+        pulumi.set(__self__, "time_created_less_than", time_created_less_than)
+
+    @property
+    @pulumi.getter(name="accessLevel")
+    def access_level(self) -> Optional[str]:
+        return pulumi.get(self, "access_level")
+
+    @property
+    @pulumi.getter(name="compartmentId")
+    def compartment_id(self) -> str:
+        """
+        The OCID of the compartment containing the SQL collection.
+        """
+        return pulumi.get(self, "compartment_id")
+
+    @property
+    @pulumi.getter(name="compartmentIdInSubtree")
+    def compartment_id_in_subtree(self) -> Optional[bool]:
+        return pulumi.get(self, "compartment_id_in_subtree")
+
+    @property
+    @pulumi.getter(name="dbUserName")
+    def db_user_name(self) -> Optional[str]:
+        """
+        The database user name.
+        """
+        return pulumi.get(self, "db_user_name")
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> Optional[str]:
+        """
+        The display name of the SQL collection.
+        """
+        return pulumi.get(self, "display_name")
+
+    @property
+    @pulumi.getter
+    def filters(self) -> Optional[Sequence['outputs.GetSqlCollectionsFilterResult']]:
+        return pulumi.get(self, "filters")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter(name="sqlCollectionCollections")
+    def sql_collection_collections(self) -> Sequence['outputs.GetSqlCollectionsSqlCollectionCollectionResult']:
+        """
+        The list of sql_collection_collection.
+        """
+        return pulumi.get(self, "sql_collection_collections")
+
+    @property
+    @pulumi.getter(name="sqlCollectionId")
+    def sql_collection_id(self) -> Optional[str]:
+        return pulumi.get(self, "sql_collection_id")
+
+    @property
+    @pulumi.getter
+    def state(self) -> Optional[str]:
+        """
+        The current state of the SQL collection.
+        """
+        return pulumi.get(self, "state")
+
+    @property
+    @pulumi.getter(name="targetId")
+    def target_id(self) -> Optional[str]:
+        """
+        The OCID of the target corresponding to the security policy deployment.
+        """
+        return pulumi.get(self, "target_id")
+
+    @property
+    @pulumi.getter(name="timeCreatedGreaterThanOrEqualTo")
+    def time_created_greater_than_or_equal_to(self) -> Optional[str]:
+        return pulumi.get(self, "time_created_greater_than_or_equal_to")
+
+    @property
+    @pulumi.getter(name="timeCreatedLessThan")
+    def time_created_less_than(self) -> Optional[str]:
+        return pulumi.get(self, "time_created_less_than")
+
+
+class AwaitableGetSqlCollectionsResult(GetSqlCollectionsResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetSqlCollectionsResult(
+            access_level=self.access_level,
+            compartment_id=self.compartment_id,
+            compartment_id_in_subtree=self.compartment_id_in_subtree,
+            db_user_name=self.db_user_name,
+            display_name=self.display_name,
+            filters=self.filters,
+            id=self.id,
+            sql_collection_collections=self.sql_collection_collections,
+            sql_collection_id=self.sql_collection_id,
+            state=self.state,
+            target_id=self.target_id,
+            time_created_greater_than_or_equal_to=self.time_created_greater_than_or_equal_to,
+            time_created_less_than=self.time_created_less_than)
+
+
+def get_sql_collections(access_level: Optional[str] = None,
+                        compartment_id: Optional[str] = None,
+                        compartment_id_in_subtree: Optional[bool] = None,
+                        db_user_name: Optional[str] = None,
+                        display_name: Optional[str] = None,
+                        filters: Optional[Sequence[Union['GetSqlCollectionsFilterArgs', 'GetSqlCollectionsFilterArgsDict']]] = None,
+                        sql_collection_id: Optional[str] = None,
+                        state: Optional[str] = None,
+                        target_id: Optional[str] = None,
+                        time_created_greater_than_or_equal_to: Optional[str] = None,
+                        time_created_less_than: Optional[str] = None,
+                        opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSqlCollectionsResult:
+    """
+    This data source provides the list of Sql Collections in Oracle Cloud Infrastructure Data Safe service.
+
+    Retrieves a list of all SQL collections in Data Safe.
+
+    The ListSqlCollections operation returns only the SQL collections in the specified `compartmentId`.
+
+    The parameter `accessLevel` specifies whether to return only those compartments for which the
+    requestor has INSPECT permissions on at least one resource directly
+    or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
+    Principal doesn't have access to even one of the child compartments. This is valid only when
+    `compartmentIdInSubtree` is set to `true`.
+
+    The parameter `compartmentIdInSubtree` applies when you perform ListSqlCollections on the
+    `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned.
+    To get a full list of all compartments and subcompartments in the tenancy (root compartment),
+    set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_oci as oci
+
+    test_sql_collections = oci.DataSafe.get_sql_collections(compartment_id=compartment_id,
+        access_level=sql_collection_access_level,
+        compartment_id_in_subtree=sql_collection_compartment_id_in_subtree,
+        db_user_name=test_user["name"],
+        display_name=sql_collection_display_name,
+        sql_collection_id=test_sql_collection["id"],
+        state=sql_collection_state,
+        target_id=test_target["id"],
+        time_created_greater_than_or_equal_to=sql_collection_time_created_greater_than_or_equal_to,
+        time_created_less_than=sql_collection_time_created_less_than)
+    ```
+
+
+    :param str access_level: Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
+    :param str compartment_id: A filter to return only resources that match the specified compartment OCID.
+    :param bool compartment_id_in_subtree: Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
+    :param str db_user_name: A filter to return only items that match the specified user name.
+    :param str display_name: A filter to return only resources that match the specified display name.
+    :param str sql_collection_id: An optional filter to return only resources that match the specified OCID of the SQL collection resource.
+    :param str state: The current state of the SQL collection.
+    :param str target_id: A filter to return only items related to a specific target OCID.
+    :param str time_created_greater_than_or_equal_to: A filter to return only the resources that were created after the specified date and time, as defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.
+           
+           **Example:** 2016-12-19T16:39:57.600Z
+    :param str time_created_less_than: Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
+           
+           **Example:** 2016-12-19T16:39:57.600Z
+    """
+    __args__ = dict()
+    __args__['accessLevel'] = access_level
+    __args__['compartmentId'] = compartment_id
+    __args__['compartmentIdInSubtree'] = compartment_id_in_subtree
+    __args__['dbUserName'] = db_user_name
+    __args__['displayName'] = display_name
+    __args__['filters'] = filters
+    __args__['sqlCollectionId'] = sql_collection_id
+    __args__['state'] = state
+    __args__['targetId'] = target_id
+    __args__['timeCreatedGreaterThanOrEqualTo'] = time_created_greater_than_or_equal_to
+    __args__['timeCreatedLessThan'] = time_created_less_than
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('oci:DataSafe/getSqlCollections:getSqlCollections', __args__, opts=opts, typ=GetSqlCollectionsResult).value
+
+    return AwaitableGetSqlCollectionsResult(
+        access_level=pulumi.get(__ret__, 'access_level'),
+        compartment_id=pulumi.get(__ret__, 'compartment_id'),
+        compartment_id_in_subtree=pulumi.get(__ret__, 'compartment_id_in_subtree'),
+        db_user_name=pulumi.get(__ret__, 'db_user_name'),
+        display_name=pulumi.get(__ret__, 'display_name'),
+        filters=pulumi.get(__ret__, 'filters'),
+        id=pulumi.get(__ret__, 'id'),
+        sql_collection_collections=pulumi.get(__ret__, 'sql_collection_collections'),
+        sql_collection_id=pulumi.get(__ret__, 'sql_collection_id'),
+        state=pulumi.get(__ret__, 'state'),
+        target_id=pulumi.get(__ret__, 'target_id'),
+        time_created_greater_than_or_equal_to=pulumi.get(__ret__, 'time_created_greater_than_or_equal_to'),
+        time_created_less_than=pulumi.get(__ret__, 'time_created_less_than'))
+def get_sql_collections_output(access_level: Optional[pulumi.Input[Optional[str]]] = None,
+                               compartment_id: Optional[pulumi.Input[str]] = None,
+                               compartment_id_in_subtree: Optional[pulumi.Input[Optional[bool]]] = None,
+                               db_user_name: Optional[pulumi.Input[Optional[str]]] = None,
+                               display_name: Optional[pulumi.Input[Optional[str]]] = None,
+                               filters: Optional[pulumi.Input[Optional[Sequence[Union['GetSqlCollectionsFilterArgs', 'GetSqlCollectionsFilterArgsDict']]]]] = None,
+                               sql_collection_id: Optional[pulumi.Input[Optional[str]]] = None,
+                               state: Optional[pulumi.Input[Optional[str]]] = None,
+                               target_id: Optional[pulumi.Input[Optional[str]]] = None,
+                               time_created_greater_than_or_equal_to: Optional[pulumi.Input[Optional[str]]] = None,
+                               time_created_less_than: Optional[pulumi.Input[Optional[str]]] = None,
+                               opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetSqlCollectionsResult]:
+    """
+    This data source provides the list of Sql Collections in Oracle Cloud Infrastructure Data Safe service.
+
+    Retrieves a list of all SQL collections in Data Safe.
+
+    The ListSqlCollections operation returns only the SQL collections in the specified `compartmentId`.
+
+    The parameter `accessLevel` specifies whether to return only those compartments for which the
+    requestor has INSPECT permissions on at least one resource directly
+    or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
+    Principal doesn't have access to even one of the child compartments. This is valid only when
+    `compartmentIdInSubtree` is set to `true`.
+
+    The parameter `compartmentIdInSubtree` applies when you perform ListSqlCollections on the
+    `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned.
+    To get a full list of all compartments and subcompartments in the tenancy (root compartment),
+    set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_oci as oci
+
+    test_sql_collections = oci.DataSafe.get_sql_collections(compartment_id=compartment_id,
+        access_level=sql_collection_access_level,
+        compartment_id_in_subtree=sql_collection_compartment_id_in_subtree,
+        db_user_name=test_user["name"],
+        display_name=sql_collection_display_name,
+        sql_collection_id=test_sql_collection["id"],
+        state=sql_collection_state,
+        target_id=test_target["id"],
+        time_created_greater_than_or_equal_to=sql_collection_time_created_greater_than_or_equal_to,
+        time_created_less_than=sql_collection_time_created_less_than)
+    ```
+
+
+    :param str access_level: Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
+    :param str compartment_id: A filter to return only resources that match the specified compartment OCID.
+    :param bool compartment_id_in_subtree: Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
+    :param str db_user_name: A filter to return only items that match the specified user name.
+    :param str display_name: A filter to return only resources that match the specified display name.
+    :param str sql_collection_id: An optional filter to return only resources that match the specified OCID of the SQL collection resource.
+    :param str state: The current state of the SQL collection.
+    :param str target_id: A filter to return only items related to a specific target OCID.
+    :param str time_created_greater_than_or_equal_to: A filter to return only the resources that were created after the specified date and time, as defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.
+           
+           **Example:** 2016-12-19T16:39:57.600Z
+    :param str time_created_less_than: Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
+           
+           **Example:** 2016-12-19T16:39:57.600Z
+    """
+    __args__ = dict()
+    __args__['accessLevel'] = access_level
+    __args__['compartmentId'] = compartment_id
+    __args__['compartmentIdInSubtree'] = compartment_id_in_subtree
+    __args__['dbUserName'] = db_user_name
+    __args__['displayName'] = display_name
+    __args__['filters'] = filters
+    __args__['sqlCollectionId'] = sql_collection_id
+    __args__['state'] = state
+    __args__['targetId'] = target_id
+    __args__['timeCreatedGreaterThanOrEqualTo'] = time_created_greater_than_or_equal_to
+    __args__['timeCreatedLessThan'] = time_created_less_than
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('oci:DataSafe/getSqlCollections:getSqlCollections', __args__, opts=opts, typ=GetSqlCollectionsResult)
+    return __ret__.apply(lambda __response__: GetSqlCollectionsResult(
+        access_level=pulumi.get(__response__, 'access_level'),
+        compartment_id=pulumi.get(__response__, 'compartment_id'),
+        compartment_id_in_subtree=pulumi.get(__response__, 'compartment_id_in_subtree'),
+        db_user_name=pulumi.get(__response__, 'db_user_name'),
+        display_name=pulumi.get(__response__, 'display_name'),
+        filters=pulumi.get(__response__, 'filters'),
+        id=pulumi.get(__response__, 'id'),
+        sql_collection_collections=pulumi.get(__response__, 'sql_collection_collections'),
+        sql_collection_id=pulumi.get(__response__, 'sql_collection_id'),
+        state=pulumi.get(__response__, 'state'),
+        target_id=pulumi.get(__response__, 'target_id'),
+        time_created_greater_than_or_equal_to=pulumi.get(__response__, 'time_created_greater_than_or_equal_to'),
+        time_created_less_than=pulumi.get(__response__, 'time_created_less_than')))