oci logo
Oracle Cloud Infrastructure v0.6.0, Jan 23 23

oci.CloudGuard.getSecurityRecipes

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.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testSecurityRecipes = Oci.CloudGuard.GetSecurityRecipes.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.Security_recipe_display_name,
        Id = @var.Security_recipe_id,
        State = @var.Security_recipe_state,
    });

});
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.GetSecurityRecipes(ctx, &cloudguard.GetSecurityRecipesArgs{
			CompartmentId: _var.Compartment_id,
			DisplayName:   pulumi.StringRef(_var.Security_recipe_display_name),
			Id:            pulumi.StringRef(_var.Security_recipe_id),
			State:         pulumi.StringRef(_var.Security_recipe_state),
		}, 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.GetSecurityRecipesArgs;
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 testSecurityRecipes = CloudGuardFunctions.getSecurityRecipes(GetSecurityRecipesArgs.builder()
            .compartmentId(var_.compartment_id())
            .displayName(var_.security_recipe_display_name())
            .id(var_.security_recipe_id())
            .state(var_.security_recipe_state())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_security_recipes = oci.CloudGuard.get_security_recipes(compartment_id=var["compartment_id"],
    display_name=var["security_recipe_display_name"],
    id=var["security_recipe_id"],
    state=var["security_recipe_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSecurityRecipes = oci.CloudGuard.getSecurityRecipes({
    compartmentId: _var.compartment_id,
    displayName: _var.security_recipe_display_name,
    id: _var.security_recipe_id,
    state: _var.security_recipe_state,
});
variables:
  testSecurityRecipes:
    fn::invoke:
      Function: oci:CloudGuard:getSecurityRecipes
      Arguments:
        compartmentId: ${var.compartment_id}
        displayName: ${var.security_recipe_display_name}
        id: ${var.security_recipe_id}
        state: ${var.security_recipe_state}

Using getSecurityRecipes

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 getSecurityRecipes(args: GetSecurityRecipesArgs, opts?: InvokeOptions): Promise<GetSecurityRecipesResult>
function getSecurityRecipesOutput(args: GetSecurityRecipesOutputArgs, opts?: InvokeOptions): Output<GetSecurityRecipesResult>
def get_security_recipes(compartment_id: Optional[str] = None,
                         display_name: Optional[str] = None,
                         filters: Optional[Sequence[_cloudguard.GetSecurityRecipesFilter]] = None,
                         id: Optional[str] = None,
                         state: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSecurityRecipesResult
def get_security_recipes_output(compartment_id: Optional[pulumi.Input[str]] = None,
                         display_name: Optional[pulumi.Input[str]] = None,
                         filters: Optional[pulumi.Input[Sequence[pulumi.Input[_cloudguard.GetSecurityRecipesFilterArgs]]]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         state: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetSecurityRecipesResult]
func GetSecurityRecipes(ctx *Context, args *GetSecurityRecipesArgs, opts ...InvokeOption) (*GetSecurityRecipesResult, error)
func GetSecurityRecipesOutput(ctx *Context, args *GetSecurityRecipesOutputArgs, opts ...InvokeOption) GetSecurityRecipesResultOutput

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

public static class GetSecurityRecipes 
{
    public static Task<GetSecurityRecipesResult> InvokeAsync(GetSecurityRecipesArgs args, InvokeOptions? opts = null)
    public static Output<GetSecurityRecipesResult> Invoke(GetSecurityRecipesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSecurityRecipesResult> getSecurityRecipes(GetSecurityRecipesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:CloudGuard/getSecurityRecipes:getSecurityRecipes
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string

The ID of the compartment in which to list resources.

DisplayName string

A filter to return only resources that match the entire display name given.

Filters List<GetSecurityRecipesFilter>
Id string

The unique identifier of the security zone recipe (SecurityRecipe)

State string

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.

CompartmentId string

The ID of the compartment in which to list resources.

DisplayName string

A filter to return only resources that match the entire display name given.

Filters []GetSecurityRecipesFilter
Id string

The unique identifier of the security zone recipe (SecurityRecipe)

State string

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.

compartmentId String

The ID of the compartment in which to list resources.

displayName String

A filter to return only resources that match the entire display name given.

filters List<GetSecurityRecipesFilter>
id String

The unique identifier of the security zone recipe (SecurityRecipe)

state String

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.

compartmentId string

The ID of the compartment in which to list resources.

displayName string

A filter to return only resources that match the entire display name given.

filters GetSecurityRecipesFilter[]
id string

The unique identifier of the security zone recipe (SecurityRecipe)

state string

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.

compartment_id str

The ID of the compartment in which to list resources.

display_name str

A filter to return only resources that match the entire display name given.

filters GetSecurityRecipesFilter]
id str

The unique identifier of the security zone recipe (SecurityRecipe)

state str

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.

compartmentId String

The ID of the compartment in which to list resources.

displayName String

A filter to return only resources that match the entire display name given.

filters List<Property Map>
id String

The unique identifier of the security zone recipe (SecurityRecipe)

state String

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.

getSecurityRecipes Result

The following output properties are available:

CompartmentId string

The id of the compartment that contains the recipe

SecurityRecipeCollections List<GetSecurityRecipesSecurityRecipeCollection>

The list of security_recipe_collection.

DisplayName string

The recipe's name

Filters List<GetSecurityRecipesFilter>
Id string

Unique identifier that is immutable on creation

State string

The current state of the recipe

CompartmentId string

The id of the compartment that contains the recipe

SecurityRecipeCollections []GetSecurityRecipesSecurityRecipeCollection

The list of security_recipe_collection.

DisplayName string

The recipe's name

Filters []GetSecurityRecipesFilter
Id string

Unique identifier that is immutable on creation

State string

The current state of the recipe

compartmentId String

The id of the compartment that contains the recipe

securityRecipeCollections List<GetSecurityRecipesSecurityRecipeCollection>

The list of security_recipe_collection.

displayName String

The recipe's name

filters List<GetSecurityRecipesFilter>
id String

Unique identifier that is immutable on creation

state String

The current state of the recipe

compartmentId string

The id of the compartment that contains the recipe

securityRecipeCollections GetSecurityRecipesSecurityRecipeCollection[]

The list of security_recipe_collection.

displayName string

The recipe's name

filters GetSecurityRecipesFilter[]
id string

Unique identifier that is immutable on creation

state string

The current state of the recipe

compartment_id str

The id of the compartment that contains the recipe

security_recipe_collections GetSecurityRecipesSecurityRecipeCollection]

The list of security_recipe_collection.

display_name str

The recipe's name

filters GetSecurityRecipesFilter]
id str

Unique identifier that is immutable on creation

state str

The current state of the recipe

compartmentId String

The id of the compartment that contains the recipe

securityRecipeCollections List<Property Map>

The list of security_recipe_collection.

displayName String

The recipe's name

filters List<Property Map>
id String

Unique identifier that is immutable on creation

state String

The current state of the recipe

Supporting Types

GetSecurityRecipesFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

GetSecurityRecipesSecurityRecipeCollection

GetSecurityRecipesSecurityRecipeCollectionItem

CompartmentId string

The ID of the compartment in which to list resources.

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 recipe's description

DisplayName string

A filter to return only resources that match the entire display name given.

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

The unique identifier of the security zone recipe (SecurityRecipe)

LifecycleDetails string

A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the Failed state.

Owner string

The owner of the recipe

SecurityPolicies List<string>

The list of SecurityPolicy ids that are included in the recipe

State string

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.

SystemTags Dictionary<string, object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The time the recipe was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the recipe was last updated. An RFC3339 formatted datetime string.

CompartmentId string

The ID of the compartment in which to list resources.

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 recipe's description

DisplayName string

A filter to return only resources that match the entire display name given.

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

The unique identifier of the security zone recipe (SecurityRecipe)

LifecycleDetails string

A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the Failed state.

Owner string

The owner of the recipe

SecurityPolicies []string

The list of SecurityPolicy ids that are included in the recipe

State string

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.

SystemTags map[string]interface{}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The time the recipe was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the recipe was last updated. An RFC3339 formatted datetime string.

compartmentId String

The ID of the compartment in which to list resources.

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 recipe's description

displayName String

A filter to return only resources that match the entire display name given.

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

The unique identifier of the security zone recipe (SecurityRecipe)

lifecycleDetails String

A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the Failed state.

owner String

The owner of the recipe

securityPolicies List<String>

The list of SecurityPolicy ids that are included in the recipe

state String

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.

systemTags Map<String,Object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The time the recipe was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the recipe was last updated. An RFC3339 formatted datetime string.

compartmentId string

The ID of the compartment in which to list resources.

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 recipe's description

displayName string

A filter to return only resources that match the entire display name given.

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

The unique identifier of the security zone recipe (SecurityRecipe)

lifecycleDetails string

A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the Failed state.

owner string

The owner of the recipe

securityPolicies string[]

The list of SecurityPolicy ids that are included in the recipe

state string

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.

systemTags {[key: string]: any}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

The time the recipe was created. An RFC3339 formatted datetime string.

timeUpdated string

The time the recipe was last updated. An RFC3339 formatted datetime string.

compartment_id str

The ID of the compartment in which to list resources.

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 recipe's description

display_name str

A filter to return only resources that match the entire display name given.

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

The unique identifier of the security zone recipe (SecurityRecipe)

lifecycle_details str

A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the Failed state.

owner str

The owner of the recipe

security_policies Sequence[str]

The list of SecurityPolicy ids that are included in the recipe

state str

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.

system_tags Mapping[str, Any]

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

The time the recipe was created. An RFC3339 formatted datetime string.

time_updated str

The time the recipe was last updated. An RFC3339 formatted datetime string.

compartmentId String

The ID of the compartment in which to list resources.

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 recipe's description

displayName String

A filter to return only resources that match the entire display name given.

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

The unique identifier of the security zone recipe (SecurityRecipe)

lifecycleDetails String

A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the Failed state.

owner String

The owner of the recipe

securityPolicies List<String>

The list of SecurityPolicy ids that are included in the recipe

state String

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.

systemTags Map<Any>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The time the recipe was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the recipe 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.