pulumi-oci 1.37.0a1715927489__py3-none-any.whl → 1.37.0a1716526633__py3-none-any.whl

pulumi_oci/cloudguard/get_security_policies.py

@@ -47,7 +47,7 @@ class GetSecurityPoliciesResult:
     @pulumi.getter(name="compartmentId")
     def compartment_id(self) -> str:
         """
-        The id of the security policy's compartment
+        The OCID of the security policy's compartment
         """
         return pulumi.get(self, "compartment_id")
 
@@ -55,7 +55,7 @@ class GetSecurityPoliciesResult:
     @pulumi.getter(name="displayName")
     def display_name(self) -> Optional[str]:
         """
-        The security policy's full name
+        The security policy's display name
         """
         return pulumi.get(self, "display_name")
 
@@ -68,7 +68,7 @@ class GetSecurityPoliciesResult:
     @pulumi.getter
     def id(self) -> Optional[str]:
         """
-        Unique identifier that is immutable on creation
+        Unique identifier that can’t be changed after creation
         """
         return pulumi.get(self, "id")
 
@@ -84,7 +84,7 @@ class GetSecurityPoliciesResult:
     @pulumi.getter
     def state(self) -> Optional[str]:
         """
-        The current state of the security policy
+        The current lifecycle state of the security policy
         """
         return pulumi.get(self, "state")
 
@@ -112,7 +112,8 @@ def get_security_policies(compartment_id: Optional[str] = None,
     """
     This data source provides the list of Security Policies in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Returns a list of security zone policies. Specify any compartment.
+    Returns a list of security zone policies (SecurityPolicySummary resources),
+    identified by compartmentId.
 
     ## Example Usage
 
@@ -127,10 +128,10 @@ def get_security_policies(compartment_id: Optional[str] = None,
     ```
 
 
-    :param str compartment_id: The ID of the compartment in which to list resources.
+    :param str compartment_id: The OCID of the compartment in which to list resources.
     :param str display_name: A filter to return only resources that match the entire display name given.
-    :param str id: The unique identifier of the security zone policy (`SecurityPolicy`)
-    :param str state: The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
+    :param str id: The unique identifier of the security zone policy. (`SecurityPolicy`)
+    :param str state: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
     """
     __args__ = dict()
     __args__['compartmentId'] = compartment_id
@@ -160,7 +161,8 @@ def get_security_policies_output(compartment_id: Optional[pulumi.Input[str]] = N
     """
     This data source provides the list of Security Policies in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Returns a list of security zone policies. Specify any compartment.
+    Returns a list of security zone policies (SecurityPolicySummary resources),
+    identified by compartmentId.
 
     ## Example Usage
 
@@ -175,9 +177,9 @@ def get_security_policies_output(compartment_id: Optional[pulumi.Input[str]] = N
     ```
 
 
-    :param str compartment_id: The ID of the compartment in which to list resources.
+    :param str compartment_id: The OCID of the compartment in which to list resources.
     :param str display_name: A filter to return only resources that match the entire display name given.
-    :param str id: The unique identifier of the security zone policy (`SecurityPolicy`)
-    :param str state: The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
+    :param str id: The unique identifier of the security zone policy. (`SecurityPolicy`)
+    :param str state: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
     """
     ...

pulumi_oci/cloudguard/get_security_policy.py

@@ -72,7 +72,7 @@ class GetSecurityPolicyResult:
     @pulumi.getter
     def category(self) -> str:
         """
-        The category of security policy
+        The category of the security policy
         """
         return pulumi.get(self, "category")
 
@@ -80,7 +80,7 @@ class GetSecurityPolicyResult:
     @pulumi.getter(name="compartmentId")
     def compartment_id(self) -> str:
         """
-        The id of the security policy's compartment
+        The OCID of the security policy's compartment
         """
         return pulumi.get(self, "compartment_id")
 
@@ -104,7 +104,7 @@ class GetSecurityPolicyResult:
     @pulumi.getter(name="displayName")
     def display_name(self) -> str:
         """
-        The security policy's full name
+        The security policy's display name
         """
         return pulumi.get(self, "display_name")
 
@@ -165,7 +165,7 @@ class GetSecurityPolicyResult:
     @pulumi.getter
     def state(self) -> str:
         """
-        The current state of the security policy
+        The current lifecycle state of the security policy
         """
         return pulumi.get(self, "state")
 
@@ -214,7 +214,9 @@ def get_security_policy(security_policy_id: Optional[str] = None,
     """
     This data source provides details about a specific Security Policy resource in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Gets a security zone policy using its identifier. When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is denied.
+    Returns a security zone policy (SecurityPolicy resource), identified by its unique ID
+    (securityPolicyId). When a policy is enabled in a security zone, then any action in
+    the zone that attempts to violate that policy is blocked.
 
     ## Example Usage
 
@@ -226,7 +228,7 @@ def get_security_policy(security_policy_id: Optional[str] = None,
     ```
 
 
-    :param str security_policy_id: The unique identifier of the security zone policy (`SecurityPolicy`)
+    :param str security_policy_id: The unique identifier of the security zone policy. (`SecurityPolicy`)
     """
     __args__ = dict()
     __args__['securityPolicyId'] = security_policy_id
@@ -257,7 +259,9 @@ def get_security_policy_output(security_policy_id: Optional[pulumi.Input[str]] =
     """
     This data source provides details about a specific Security Policy resource in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Gets a security zone policy using its identifier. When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is denied.
+    Returns a security zone policy (SecurityPolicy resource), identified by its unique ID
+    (securityPolicyId). When a policy is enabled in a security zone, then any action in
+    the zone that attempts to violate that policy is blocked.
 
     ## Example Usage
 
@@ -269,6 +273,6 @@ def get_security_policy_output(security_policy_id: Optional[pulumi.Input[str]] =
     ```
 
 
-    :param str security_policy_id: The unique identifier of the security zone policy (`SecurityPolicy`)
+    :param str security_policy_id: The unique identifier of the security zone policy. (`SecurityPolicy`)
     """
     ...

pulumi_oci/cloudguard/get_security_recipe.py

@@ -66,7 +66,7 @@ class GetSecurityRecipeResult:
     @pulumi.getter(name="compartmentId")
     def compartment_id(self) -> str:
         """
-        The id of the compartment that contains the recipe
+        The OCID of the compartment that contains the recipe
         """
         return pulumi.get(self, "compartment_id")
 
@@ -90,7 +90,7 @@ class GetSecurityRecipeResult:
     @pulumi.getter(name="displayName")
     def display_name(self) -> str:
         """
-        The recipe's name
+        The recipe's display name
         """
         return pulumi.get(self, "display_name")
 
@@ -106,7 +106,7 @@ class GetSecurityRecipeResult:
     @pulumi.getter
     def id(self) -> str:
         """
-        Unique identifier that is immutable on creation
+        Unique identifier that can’t be changed after creation
         """
         return pulumi.get(self, "id")
 
@@ -130,7 +130,7 @@ class GetSecurityRecipeResult:
     @pulumi.getter(name="securityPolicies")
     def security_policies(self) -> Sequence[str]:
         """
-        The list of `SecurityPolicy` ids that are included in the recipe
+        The list of security policy IDs that are included in the recipe
         """
         return pulumi.get(self, "security_policies")
 
@@ -143,7 +143,7 @@ class GetSecurityRecipeResult:
     @pulumi.getter
     def state(self) -> str:
         """
-        The current state of the recipe
+        The current lifecycle state of the recipe
         """
         return pulumi.get(self, "state")
 
@@ -190,7 +190,7 @@ def get_security_recipe(security_recipe_id: Optional[str] = None,
     """
     This data source provides details about a specific Security Recipe resource in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Gets a security zone recipe by identifier. A security zone recipe is a collection of security zone policies.
+    Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.
 
     ## Example Usage
 
@@ -202,7 +202,7 @@ def get_security_recipe(security_recipe_id: Optional[str] = None,
     ```
 
 
-    :param str security_recipe_id: The unique identifier of the security zone recipe (`SecurityRecipe`)
+    :param str security_recipe_id: The unique identifier of the security zone recipe. (`SecurityRecipe`)
     """
     __args__ = dict()
     __args__['securityRecipeId'] = security_recipe_id
@@ -231,7 +231,7 @@ def get_security_recipe_output(security_recipe_id: Optional[pulumi.Input[str]] =
     """
     This data source provides details about a specific Security Recipe resource in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Gets a security zone recipe by identifier. A security zone recipe is a collection of security zone policies.
+    Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.
 
     ## Example Usage
 
@@ -243,6 +243,6 @@ def get_security_recipe_output(security_recipe_id: Optional[pulumi.Input[str]] =
     ```
 
 
-    :param str security_recipe_id: The unique identifier of the security zone recipe (`SecurityRecipe`)
+    :param str security_recipe_id: The unique identifier of the security zone recipe. (`SecurityRecipe`)
     """
     ...

pulumi_oci/cloudguard/get_security_recipes.py

@@ -47,7 +47,7 @@ class GetSecurityRecipesResult:
     @pulumi.getter(name="compartmentId")
     def compartment_id(self) -> str:
         """
-        The id of the compartment that contains the recipe
+        The OCID of the compartment that contains the recipe
         """
         return pulumi.get(self, "compartment_id")
 
@@ -55,7 +55,7 @@ class GetSecurityRecipesResult:
     @pulumi.getter(name="displayName")
     def display_name(self) -> Optional[str]:
         """
-        The recipe's name
+        The recipe's display name
         """
         return pulumi.get(self, "display_name")
 
@@ -68,7 +68,7 @@ class GetSecurityRecipesResult:
     @pulumi.getter
     def id(self) -> Optional[str]:
         """
-        Unique identifier that is immutable on creation
+        Unique identifier that can’t be changed after creation
         """
         return pulumi.get(self, "id")
 
@@ -84,7 +84,7 @@ class GetSecurityRecipesResult:
     @pulumi.getter
     def state(self) -> Optional[str]:
         """
-        The current state of the recipe
+        The current lifecycle state of the recipe
         """
         return pulumi.get(self, "state")
 
@@ -112,7 +112,8 @@ def get_security_recipes(compartment_id: Optional[str] = None,
     """
     This data source provides the list of Security Recipes in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Gets a list of all security zone recipes in a compartment.
+    Returns a list of security zone recipes (SecurityRecipeSummary resources) in a
+    compartment, identified by compartmentId.
 
     ## Example Usage
 
@@ -127,10 +128,10 @@ def get_security_recipes(compartment_id: Optional[str] = None,
     ```
 
 
-    :param str compartment_id: The ID of the compartment in which to list resources.
+    :param str compartment_id: The OCID of the compartment in which to list resources.
     :param str display_name: A filter to return only resources that match the entire display name given.
-    :param str id: The unique identifier of the security zone recipe (`SecurityRecipe`)
-    :param str state: The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
+    :param str id: The unique identifier of the security zone recipe. (`SecurityRecipe`)
+    :param str state: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
     """
     __args__ = dict()
     __args__['compartmentId'] = compartment_id
@@ -160,7 +161,8 @@ def get_security_recipes_output(compartment_id: Optional[pulumi.Input[str]] = No
     """
     This data source provides the list of Security Recipes in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Gets a list of all security zone recipes in a compartment.
+    Returns a list of security zone recipes (SecurityRecipeSummary resources) in a
+    compartment, identified by compartmentId.
 
     ## Example Usage
 
@@ -175,9 +177,9 @@ def get_security_recipes_output(compartment_id: Optional[pulumi.Input[str]] = No
     ```
 
 
-    :param str compartment_id: The ID of the compartment in which to list resources.
+    :param str compartment_id: The OCID of the compartment in which to list resources.
     :param str display_name: A filter to return only resources that match the entire display name given.
-    :param str id: The unique identifier of the security zone recipe (`SecurityRecipe`)
-    :param str state: The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
+    :param str id: The unique identifier of the security zone recipe. (`SecurityRecipe`)
+    :param str state: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
     """
     ...

pulumi_oci/cloudguard/get_security_zone.py

@@ -93,7 +93,7 @@ class GetSecurityZoneResult:
     @pulumi.getter(name="displayName")
     def display_name(self) -> str:
         """
-        The security zone's name
+        The security zone's display name
         """
         return pulumi.get(self, "display_name")
 
@@ -109,7 +109,7 @@ class GetSecurityZoneResult:
     @pulumi.getter
     def id(self) -> str:
         """
-        Unique identifier that is immutable on creation
+        Unique identifier that can’t be changed after creation
         """
         return pulumi.get(self, "id")
 
@@ -138,7 +138,7 @@ class GetSecurityZoneResult:
     @pulumi.getter(name="securityZoneRecipeId")
     def security_zone_recipe_id(self) -> str:
         """
-        The OCID of the recipe (`SecurityRecipe`) for the security zone
+        The OCID of the recipe (`SecurityRecipe` resource) for the security zone
         """
         return pulumi.get(self, "security_zone_recipe_id")
 
@@ -154,7 +154,7 @@ class GetSecurityZoneResult:
     @pulumi.getter
     def state(self) -> str:
         """
-        The current state of the security zone
+        The current lifecycle state of the security zone
         """
         return pulumi.get(self, "state")
 
@@ -202,7 +202,7 @@ def get_security_zone(security_zone_id: Optional[str] = None,
     """
     This data source provides details about a specific Security Zone resource in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Gets a security zone by its identifier. A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe. Any actions in the zone's compartments that violate a policy are denied.
+    Returns a security zone (SecurityZone resource) identified by securityZoneId.
 
     ## Example Usage
 
@@ -214,7 +214,7 @@ def get_security_zone(security_zone_id: Optional[str] = None,
     ```
 
 
-    :param str security_zone_id: The unique identifier of the security zone (`SecurityZone`)
+    :param str security_zone_id: The unique identifier of the security zone (`SecurityZone` resource).
     """
     __args__ = dict()
     __args__['securityZoneId'] = security_zone_id
@@ -244,7 +244,7 @@ def get_security_zone_output(security_zone_id: Optional[pulumi.Input[str]] = Non
     """
     This data source provides details about a specific Security Zone resource in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Gets a security zone by its identifier. A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe. Any actions in the zone's compartments that violate a policy are denied.
+    Returns a security zone (SecurityZone resource) identified by securityZoneId.
 
     ## Example Usage
 
@@ -256,6 +256,6 @@ def get_security_zone_output(security_zone_id: Optional[pulumi.Input[str]] = Non
     ```
 
 
-    :param str security_zone_id: The unique identifier of the security zone (`SecurityZone`)
+    :param str security_zone_id: The unique identifier of the security zone (`SecurityZone` resource).
     """
     ...

pulumi_oci/cloudguard/get_security_zones.py

@@ -61,7 +61,7 @@ class GetSecurityZonesResult:
     @pulumi.getter(name="displayName")
     def display_name(self) -> Optional[str]:
         """
-        The security zone's name
+        The security zone's display name
         """
         return pulumi.get(self, "display_name")
 
@@ -74,7 +74,7 @@ class GetSecurityZonesResult:
     @pulumi.getter
     def id(self) -> Optional[str]:
         """
-        Unique identifier that is immutable on creation
+        Unique identifier that can’t be changed after creation
         """
         return pulumi.get(self, "id")
 
@@ -100,7 +100,7 @@ class GetSecurityZonesResult:
     @pulumi.getter
     def state(self) -> Optional[str]:
         """
-        The current state of the security zone
+        The current lifecycle state of the security zone
         """
         return pulumi.get(self, "state")
 
@@ -132,7 +132,8 @@ def get_security_zones(compartment_id: Optional[str] = None,
     """
     This data source provides the list of Security Zones in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Gets a list of all security zones in a compartment.
+    Returns a list of security zones (SecurityZone resources) in a compartment identified by
+    compartmentId. List is contained in a page of SecurityZoneSummary resources.
 
     ## Example Usage
 
@@ -149,12 +150,12 @@ def get_security_zones(compartment_id: Optional[str] = None,
     ```
 
 
-    :param str compartment_id: The ID of the compartment in which to list resources.
+    :param str compartment_id: The OCID of the compartment in which to list resources.
     :param str display_name: A filter to return only resources that match the entire display name given.
-    :param str id: The unique identifier of the security zone (`SecurityZone`)
-    :param bool is_required_security_zones_in_subtree: security zones in the subtree
-    :param str security_recipe_id: The unique identifier of the security zone recipe (`SecurityRecipe`)
-    :param str state: The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
+    :param str id: The unique identifier of the security zone (`SecurityZone` resource).
+    :param bool is_required_security_zones_in_subtree: Is security zones in the subtree?
+    :param str security_recipe_id: The unique identifier of the security zone recipe. (`SecurityRecipe` resource).
+    :param str state: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
     """
     __args__ = dict()
     __args__['compartmentId'] = compartment_id
@@ -190,7 +191,8 @@ def get_security_zones_output(compartment_id: Optional[pulumi.Input[str]] = None
     """
     This data source provides the list of Security Zones in Oracle Cloud Infrastructure Cloud Guard service.
 
-    Gets a list of all security zones in a compartment.
+    Returns a list of security zones (SecurityZone resources) in a compartment identified by
+    compartmentId. List is contained in a page of SecurityZoneSummary resources.
 
     ## Example Usage
 
@@ -207,11 +209,11 @@ def get_security_zones_output(compartment_id: Optional[pulumi.Input[str]] = None
     ```
 
 
-    :param str compartment_id: The ID of the compartment in which to list resources.
+    :param str compartment_id: The OCID of the compartment in which to list resources.
     :param str display_name: A filter to return only resources that match the entire display name given.
-    :param str id: The unique identifier of the security zone (`SecurityZone`)
-    :param bool is_required_security_zones_in_subtree: security zones in the subtree
-    :param str security_recipe_id: The unique identifier of the security zone recipe (`SecurityRecipe`)
-    :param str state: The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
+    :param str id: The unique identifier of the security zone (`SecurityZone` resource).
+    :param bool is_required_security_zones_in_subtree: Is security zones in the subtree?
+    :param str security_recipe_id: The unique identifier of the security zone recipe. (`SecurityRecipe` resource).
+    :param str state: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
     """
     ...