Oracle Cloud Infrastructure v0.20.0, May 31 23

oci.CloudGuard.getSecurityZone

Explore with Pulumi AI

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.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSecurityZone = Oci.CloudGuard.GetSecurityZone.Invoke(new()
    {
        SecurityZoneId = oci_cloud_guard_security_zone.Test_security_zone.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/CloudGuard"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := CloudGuard.GetSecurityZone(ctx, &cloudguard.GetSecurityZoneArgs{
			SecurityZoneId: oci_cloud_guard_security_zone.Test_security_zone.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.CloudGuard.CloudGuardFunctions;
import com.pulumi.oci.CloudGuard.inputs.GetSecurityZoneArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testSecurityZone = CloudGuardFunctions.getSecurityZone(GetSecurityZoneArgs.builder()
            .securityZoneId(oci_cloud_guard_security_zone.test_security_zone().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_security_zone = oci.CloudGuard.get_security_zone(security_zone_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSecurityZone = oci.CloudGuard.getSecurityZone({
    securityZoneId: oci_cloud_guard_security_zone.test_security_zone.id,
});

variables:
  testSecurityZone:
    fn::invoke:
      Function: oci:CloudGuard:getSecurityZone
      Arguments:
        securityZoneId: ${oci_cloud_guard_security_zone.test_security_zone.id}

Using getSecurityZone

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSecurityZone(args: GetSecurityZoneArgs, opts?: InvokeOptions): Promise<GetSecurityZoneResult>
function getSecurityZoneOutput(args: GetSecurityZoneOutputArgs, opts?: InvokeOptions): Output<GetSecurityZoneResult>

def get_security_zone(security_zone_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSecurityZoneResult
def get_security_zone_output(security_zone_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSecurityZoneResult]

func GetSecurityZone(ctx *Context, args *GetSecurityZoneArgs, opts ...InvokeOption) (*GetSecurityZoneResult, error)
func GetSecurityZoneOutput(ctx *Context, args *GetSecurityZoneOutputArgs, opts ...InvokeOption) GetSecurityZoneResultOutput

> Note: This function is named GetSecurityZone in the Go SDK.

public static class GetSecurityZone 
{
    public static Task<GetSecurityZoneResult> InvokeAsync(GetSecurityZoneArgs args, InvokeOptions? opts = null)
    public static Output<GetSecurityZoneResult> Invoke(GetSecurityZoneInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSecurityZoneResult> getSecurityZone(GetSecurityZoneArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:CloudGuard/getSecurityZone:getSecurityZone
  arguments:
    # arguments dictionary

The following arguments are supported:

SecurityZoneId string: The unique identifier of the security zone (SecurityZone)

SecurityZoneId string: The unique identifier of the security zone (SecurityZone)

securityZoneId String: The unique identifier of the security zone (SecurityZone)

securityZoneId string: The unique identifier of the security zone (SecurityZone)

security_zone_id str: The unique identifier of the security zone (SecurityZone)

securityZoneId String: The unique identifier of the security zone (SecurityZone)

getSecurityZone Result

The following output properties are available:

CompartmentId string: The OCID of the compartment for the security zone
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: The security zone's description
DisplayName string: The security zone's name
FreeformTags Dictionary<string, object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier that is immutable on creation
InheritedByCompartments List<string>: List of inherited compartments
LifecycleDetails string: A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the Failed state.
SecurityZoneId string
SecurityZoneRecipeId string: The OCID of the recipe (SecurityRecipe) for the security zone
SecurityZoneTargetId string: The OCID of the target associated with the security zone
State string: The current state of the security zone
TimeCreated string: The time the security zone was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time the security zone was last updated. An RFC3339 formatted datetime string.

CompartmentId string: The OCID of the compartment for the security zone
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: The security zone's description
DisplayName string: The security zone's name
FreeformTags map[string]interface{}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier that is immutable on creation
InheritedByCompartments []string: List of inherited compartments
LifecycleDetails string: A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the Failed state.
SecurityZoneId string
SecurityZoneRecipeId string: The OCID of the recipe (SecurityRecipe) for the security zone
SecurityZoneTargetId string: The OCID of the target associated with the security zone
State string: The current state of the security zone
TimeCreated string: The time the security zone was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time the security zone was last updated. An RFC3339 formatted datetime string.

compartmentId String: The OCID of the compartment for the security zone
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: The security zone's description
displayName String: The security zone's name
freeformTags Map<String,Object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier that is immutable on creation
inheritedByCompartments List<String>: List of inherited compartments
lifecycleDetails String: A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the Failed state.
securityZoneId String
securityZoneRecipeId String: The OCID of the recipe (SecurityRecipe) for the security zone
securityZoneTargetId String: The OCID of the target associated with the security zone
state String: The current state of the security zone
timeCreated String: The time the security zone was created. An RFC3339 formatted datetime string.
timeUpdated String: The time the security zone was last updated. An RFC3339 formatted datetime string.

compartmentId string: The OCID of the compartment for the security zone
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string: The security zone's description
displayName string: The security zone's name
freeformTags {[key: string]: any}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: Unique identifier that is immutable on creation
inheritedByCompartments string[]: List of inherited compartments
lifecycleDetails string: A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the Failed state.
securityZoneId string
securityZoneRecipeId string: The OCID of the recipe (SecurityRecipe) for the security zone
securityZoneTargetId string: The OCID of the target associated with the security zone
state string: The current state of the security zone
timeCreated string: The time the security zone was created. An RFC3339 formatted datetime string.
timeUpdated string: The time the security zone was last updated. An RFC3339 formatted datetime string.

compartment_id str: The OCID of the compartment for the security zone
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str: The security zone's description
display_name str: The security zone's name
freeform_tags Mapping[str, Any]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: Unique identifier that is immutable on creation
inherited_by_compartments Sequence[str]: List of inherited compartments
lifecycle_details str: A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the Failed state.
security_zone_id str
security_zone_recipe_id str: The OCID of the recipe (SecurityRecipe) for the security zone
security_zone_target_id str: The OCID of the target associated with the security zone
state str: The current state of the security zone
time_created str: The time the security zone was created. An RFC3339 formatted datetime string.
time_updated str: The time the security zone was last updated. An RFC3339 formatted datetime string.

compartmentId String: The OCID of the compartment for the security zone
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: The security zone's description
displayName String: The security zone's name
freeformTags Map<Any>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier that is immutable on creation
inheritedByCompartments List<String>: List of inherited compartments
lifecycleDetails String: A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the Failed state.
securityZoneId String
securityZoneRecipeId String: The OCID of the recipe (SecurityRecipe) for the security zone
securityZoneTargetId String: The OCID of the target associated with the security zone
state String: The current state of the security zone
timeCreated String: The time the security zone was created. An RFC3339 formatted datetime string.
timeUpdated String: The time the security zone was last updated. An RFC3339 formatted datetime string.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.