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

pulumi_oci/datasafe/get_unified_audit_policies.py

@@ -0,0 +1,386 @@
+# 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
+from ._inputs import *
+
+__all__ = [
+    'GetUnifiedAuditPoliciesResult',
+    'AwaitableGetUnifiedAuditPoliciesResult',
+    'get_unified_audit_policies',
+    'get_unified_audit_policies_output',
+]
+
+@pulumi.output_type
+class GetUnifiedAuditPoliciesResult:
+    """
+    A collection of values returned by getUnifiedAuditPolicies.
+    """
+    def __init__(__self__, access_level=None, compartment_id=None, compartment_id_in_subtree=None, display_name=None, filters=None, id=None, is_seeded=None, security_policy_id=None, state=None, time_created_greater_than_or_equal_to=None, time_created_less_than=None, unified_audit_policy_collections=None, unified_audit_policy_definition_id=None, unified_audit_policy_id=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 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 is_seeded and not isinstance(is_seeded, bool):
+            raise TypeError("Expected argument 'is_seeded' to be a bool")
+        pulumi.set(__self__, "is_seeded", is_seeded)
+        if security_policy_id and not isinstance(security_policy_id, str):
+            raise TypeError("Expected argument 'security_policy_id' to be a str")
+        pulumi.set(__self__, "security_policy_id", security_policy_id)
+        if state and not isinstance(state, str):
+            raise TypeError("Expected argument 'state' to be a str")
+        pulumi.set(__self__, "state", state)
+        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)
+        if unified_audit_policy_collections and not isinstance(unified_audit_policy_collections, list):
+            raise TypeError("Expected argument 'unified_audit_policy_collections' to be a list")
+        pulumi.set(__self__, "unified_audit_policy_collections", unified_audit_policy_collections)
+        if unified_audit_policy_definition_id and not isinstance(unified_audit_policy_definition_id, str):
+            raise TypeError("Expected argument 'unified_audit_policy_definition_id' to be a str")
+        pulumi.set(__self__, "unified_audit_policy_definition_id", unified_audit_policy_definition_id)
+        if unified_audit_policy_id and not isinstance(unified_audit_policy_id, str):
+            raise TypeError("Expected argument 'unified_audit_policy_id' to be a str")
+        pulumi.set(__self__, "unified_audit_policy_id", unified_audit_policy_id)
+
+    @_builtins.property
+    @pulumi.getter(name="accessLevel")
+    def access_level(self) -> Optional[_builtins.str]:
+        return pulumi.get(self, "access_level")
+
+    @_builtins.property
+    @pulumi.getter(name="compartmentId")
+    def compartment_id(self) -> _builtins.str:
+        """
+        The OCID of the compartment containing the unified audit policy.
+        """
+        return pulumi.get(self, "compartment_id")
+
+    @_builtins.property
+    @pulumi.getter(name="compartmentIdInSubtree")
+    def compartment_id_in_subtree(self) -> Optional[_builtins.bool]:
+        return pulumi.get(self, "compartment_id_in_subtree")
+
+    @_builtins.property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> Optional[_builtins.str]:
+        """
+        The display name of the unified audit policy.
+        """
+        return pulumi.get(self, "display_name")
+
+    @_builtins.property
+    @pulumi.getter
+    def filters(self) -> Optional[Sequence['outputs.GetUnifiedAuditPoliciesFilterResult']]:
+        return pulumi.get(self, "filters")
+
+    @_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(name="isSeeded")
+    def is_seeded(self) -> Optional[_builtins.bool]:
+        """
+        Indicates whether the unified audit policy is seeded or not.
+        """
+        return pulumi.get(self, "is_seeded")
+
+    @_builtins.property
+    @pulumi.getter(name="securityPolicyId")
+    def security_policy_id(self) -> Optional[_builtins.str]:
+        """
+        The OCID of the security policy corresponding to the unified audit policy.
+        """
+        return pulumi.get(self, "security_policy_id")
+
+    @_builtins.property
+    @pulumi.getter
+    def state(self) -> Optional[_builtins.str]:
+        """
+        The current state of the unified audit policy.
+        """
+        return pulumi.get(self, "state")
+
+    @_builtins.property
+    @pulumi.getter(name="timeCreatedGreaterThanOrEqualTo")
+    def time_created_greater_than_or_equal_to(self) -> Optional[_builtins.str]:
+        return pulumi.get(self, "time_created_greater_than_or_equal_to")
+
+    @_builtins.property
+    @pulumi.getter(name="timeCreatedLessThan")
+    def time_created_less_than(self) -> Optional[_builtins.str]:
+        return pulumi.get(self, "time_created_less_than")
+
+    @_builtins.property
+    @pulumi.getter(name="unifiedAuditPolicyCollections")
+    def unified_audit_policy_collections(self) -> Sequence['outputs.GetUnifiedAuditPoliciesUnifiedAuditPolicyCollectionResult']:
+        """
+        The list of unified_audit_policy_collection.
+        """
+        return pulumi.get(self, "unified_audit_policy_collections")
+
+    @_builtins.property
+    @pulumi.getter(name="unifiedAuditPolicyDefinitionId")
+    def unified_audit_policy_definition_id(self) -> Optional[_builtins.str]:
+        """
+        The OCID of the associated unified audit policy definition.
+        """
+        return pulumi.get(self, "unified_audit_policy_definition_id")
+
+    @_builtins.property
+    @pulumi.getter(name="unifiedAuditPolicyId")
+    def unified_audit_policy_id(self) -> Optional[_builtins.str]:
+        return pulumi.get(self, "unified_audit_policy_id")
+
+
+class AwaitableGetUnifiedAuditPoliciesResult(GetUnifiedAuditPoliciesResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetUnifiedAuditPoliciesResult(
+            access_level=self.access_level,
+            compartment_id=self.compartment_id,
+            compartment_id_in_subtree=self.compartment_id_in_subtree,
+            display_name=self.display_name,
+            filters=self.filters,
+            id=self.id,
+            is_seeded=self.is_seeded,
+            security_policy_id=self.security_policy_id,
+            state=self.state,
+            time_created_greater_than_or_equal_to=self.time_created_greater_than_or_equal_to,
+            time_created_less_than=self.time_created_less_than,
+            unified_audit_policy_collections=self.unified_audit_policy_collections,
+            unified_audit_policy_definition_id=self.unified_audit_policy_definition_id,
+            unified_audit_policy_id=self.unified_audit_policy_id)
+
+
+def get_unified_audit_policies(access_level: Optional[_builtins.str] = None,
+                               compartment_id: Optional[_builtins.str] = None,
+                               compartment_id_in_subtree: Optional[_builtins.bool] = None,
+                               display_name: Optional[_builtins.str] = None,
+                               filters: Optional[Sequence[Union['GetUnifiedAuditPoliciesFilterArgs', 'GetUnifiedAuditPoliciesFilterArgsDict']]] = None,
+                               is_seeded: Optional[_builtins.bool] = None,
+                               security_policy_id: Optional[_builtins.str] = None,
+                               state: Optional[_builtins.str] = None,
+                               time_created_greater_than_or_equal_to: Optional[_builtins.str] = None,
+                               time_created_less_than: Optional[_builtins.str] = None,
+                               unified_audit_policy_definition_id: Optional[_builtins.str] = None,
+                               unified_audit_policy_id: Optional[_builtins.str] = None,
+                               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetUnifiedAuditPoliciesResult:
+    """
+    This data source provides the list of Unified Audit Policies in Oracle Cloud Infrastructure Data Safe service.
+
+    Retrieves a list of all Unified Audit policies.
+
+    The ListUnifiedAuditPolicies operation returns only the Unified Audit policies in the specified `compartmentId`.
+
+    The parameter `accessLevel` specifies whether to return only those compartments for which the
+    requester has INSPECT permissions on at least one resource directly
+    or indirectly (ACCESSIBLE) (the resource can be in a sub-compartment) 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 ListUnifiedAuditPolicies 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 sub-compartments 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_unified_audit_policies = oci.DataSafe.get_unified_audit_policies(compartment_id=compartment_id,
+        access_level=unified_audit_policy_access_level,
+        compartment_id_in_subtree=unified_audit_policy_compartment_id_in_subtree,
+        display_name=unified_audit_policy_display_name,
+        is_seeded=unified_audit_policy_is_seeded,
+        security_policy_id=test_security_policy["id"],
+        state=unified_audit_policy_state,
+        time_created_greater_than_or_equal_to=unified_audit_policy_time_created_greater_than_or_equal_to,
+        time_created_less_than=unified_audit_policy_time_created_less_than,
+        unified_audit_policy_definition_id=test_unified_audit_policy_definition["id"],
+        unified_audit_policy_id=test_unified_audit_policy["id"])
+    ```
+
+
+    :param _builtins.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 _builtins.str compartment_id: A filter to return only resources that match the specified compartment OCID.
+    :param _builtins.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 _builtins.str display_name: A filter to return only resources that match the specified display name.
+    :param _builtins.bool is_seeded: A boolean flag indicating to list seeded unified audit policies. Set this parameter to get list of seeded unified audit policies.
+    :param _builtins.str security_policy_id: An optional filter to return only resources that match the specified OCID of the security policy resource.
+    :param _builtins.str state: The current state of the Unified Audit policy.
+    :param _builtins.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 _builtins.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
+    :param _builtins.str unified_audit_policy_definition_id: An optional filter to return only resources that match the specified OCID of the unified audit policy definition resource.
+    :param _builtins.str unified_audit_policy_id: An optional filter to return only resources that match the specified OCID of the Unified Audit policy resource.
+    """
+    __args__ = dict()
+    __args__['accessLevel'] = access_level
+    __args__['compartmentId'] = compartment_id
+    __args__['compartmentIdInSubtree'] = compartment_id_in_subtree
+    __args__['displayName'] = display_name
+    __args__['filters'] = filters
+    __args__['isSeeded'] = is_seeded
+    __args__['securityPolicyId'] = security_policy_id
+    __args__['state'] = state
+    __args__['timeCreatedGreaterThanOrEqualTo'] = time_created_greater_than_or_equal_to
+    __args__['timeCreatedLessThan'] = time_created_less_than
+    __args__['unifiedAuditPolicyDefinitionId'] = unified_audit_policy_definition_id
+    __args__['unifiedAuditPolicyId'] = unified_audit_policy_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('oci:DataSafe/getUnifiedAuditPolicies:getUnifiedAuditPolicies', __args__, opts=opts, typ=GetUnifiedAuditPoliciesResult).value
+
+    return AwaitableGetUnifiedAuditPoliciesResult(
+        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'),
+        display_name=pulumi.get(__ret__, 'display_name'),
+        filters=pulumi.get(__ret__, 'filters'),
+        id=pulumi.get(__ret__, 'id'),
+        is_seeded=pulumi.get(__ret__, 'is_seeded'),
+        security_policy_id=pulumi.get(__ret__, 'security_policy_id'),
+        state=pulumi.get(__ret__, 'state'),
+        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'),
+        unified_audit_policy_collections=pulumi.get(__ret__, 'unified_audit_policy_collections'),
+        unified_audit_policy_definition_id=pulumi.get(__ret__, 'unified_audit_policy_definition_id'),
+        unified_audit_policy_id=pulumi.get(__ret__, 'unified_audit_policy_id'))
+def get_unified_audit_policies_output(access_level: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      compartment_id: Optional[pulumi.Input[_builtins.str]] = None,
+                                      compartment_id_in_subtree: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                                      display_name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      filters: Optional[pulumi.Input[Optional[Sequence[Union['GetUnifiedAuditPoliciesFilterArgs', 'GetUnifiedAuditPoliciesFilterArgsDict']]]]] = None,
+                                      is_seeded: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                                      security_policy_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      state: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      time_created_greater_than_or_equal_to: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      time_created_less_than: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      unified_audit_policy_definition_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      unified_audit_policy_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetUnifiedAuditPoliciesResult]:
+    """
+    This data source provides the list of Unified Audit Policies in Oracle Cloud Infrastructure Data Safe service.
+
+    Retrieves a list of all Unified Audit policies.
+
+    The ListUnifiedAuditPolicies operation returns only the Unified Audit policies in the specified `compartmentId`.
+
+    The parameter `accessLevel` specifies whether to return only those compartments for which the
+    requester has INSPECT permissions on at least one resource directly
+    or indirectly (ACCESSIBLE) (the resource can be in a sub-compartment) 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 ListUnifiedAuditPolicies 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 sub-compartments 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_unified_audit_policies = oci.DataSafe.get_unified_audit_policies(compartment_id=compartment_id,
+        access_level=unified_audit_policy_access_level,
+        compartment_id_in_subtree=unified_audit_policy_compartment_id_in_subtree,
+        display_name=unified_audit_policy_display_name,
+        is_seeded=unified_audit_policy_is_seeded,
+        security_policy_id=test_security_policy["id"],
+        state=unified_audit_policy_state,
+        time_created_greater_than_or_equal_to=unified_audit_policy_time_created_greater_than_or_equal_to,
+        time_created_less_than=unified_audit_policy_time_created_less_than,
+        unified_audit_policy_definition_id=test_unified_audit_policy_definition["id"],
+        unified_audit_policy_id=test_unified_audit_policy["id"])
+    ```
+
+
+    :param _builtins.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 _builtins.str compartment_id: A filter to return only resources that match the specified compartment OCID.
+    :param _builtins.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 _builtins.str display_name: A filter to return only resources that match the specified display name.
+    :param _builtins.bool is_seeded: A boolean flag indicating to list seeded unified audit policies. Set this parameter to get list of seeded unified audit policies.
+    :param _builtins.str security_policy_id: An optional filter to return only resources that match the specified OCID of the security policy resource.
+    :param _builtins.str state: The current state of the Unified Audit policy.
+    :param _builtins.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 _builtins.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
+    :param _builtins.str unified_audit_policy_definition_id: An optional filter to return only resources that match the specified OCID of the unified audit policy definition resource.
+    :param _builtins.str unified_audit_policy_id: An optional filter to return only resources that match the specified OCID of the Unified Audit policy resource.
+    """
+    __args__ = dict()
+    __args__['accessLevel'] = access_level
+    __args__['compartmentId'] = compartment_id
+    __args__['compartmentIdInSubtree'] = compartment_id_in_subtree
+    __args__['displayName'] = display_name
+    __args__['filters'] = filters
+    __args__['isSeeded'] = is_seeded
+    __args__['securityPolicyId'] = security_policy_id
+    __args__['state'] = state
+    __args__['timeCreatedGreaterThanOrEqualTo'] = time_created_greater_than_or_equal_to
+    __args__['timeCreatedLessThan'] = time_created_less_than
+    __args__['unifiedAuditPolicyDefinitionId'] = unified_audit_policy_definition_id
+    __args__['unifiedAuditPolicyId'] = unified_audit_policy_id
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('oci:DataSafe/getUnifiedAuditPolicies:getUnifiedAuditPolicies', __args__, opts=opts, typ=GetUnifiedAuditPoliciesResult)
+    return __ret__.apply(lambda __response__: GetUnifiedAuditPoliciesResult(
+        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'),
+        display_name=pulumi.get(__response__, 'display_name'),
+        filters=pulumi.get(__response__, 'filters'),
+        id=pulumi.get(__response__, 'id'),
+        is_seeded=pulumi.get(__response__, 'is_seeded'),
+        security_policy_id=pulumi.get(__response__, 'security_policy_id'),
+        state=pulumi.get(__response__, 'state'),
+        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'),
+        unified_audit_policy_collections=pulumi.get(__response__, 'unified_audit_policy_collections'),
+        unified_audit_policy_definition_id=pulumi.get(__response__, 'unified_audit_policy_definition_id'),
+        unified_audit_policy_id=pulumi.get(__response__, 'unified_audit_policy_id')))