Oracle Cloud Infrastructure v2.12.0 published on Friday, Oct 11, 2024 by Pulumi
oci.CloudGuard.getSecurityRecipes
Explore with Pulumi AI
This data source provides the list of Security Recipes in Oracle Cloud Infrastructure Cloud Guard service.
Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testSecurityRecipes = oci.CloudGuard.getSecurityRecipes({
compartmentId: compartmentId,
displayName: securityRecipeDisplayName,
id: securityRecipeId,
state: securityRecipeState,
});
import pulumi
import pulumi_oci as oci
test_security_recipes = oci.CloudGuard.get_security_recipes(compartment_id=compartment_id,
display_name=security_recipe_display_name,
id=security_recipe_id,
state=security_recipe_state)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/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: compartmentId,
DisplayName: pulumi.StringRef(securityRecipeDisplayName),
Id: pulumi.StringRef(securityRecipeId),
State: pulumi.StringRef(securityRecipeState),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testSecurityRecipes = Oci.CloudGuard.GetSecurityRecipes.Invoke(new()
{
CompartmentId = compartmentId,
DisplayName = securityRecipeDisplayName,
Id = securityRecipeId,
State = securityRecipeState,
});
});
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(compartmentId)
.displayName(securityRecipeDisplayName)
.id(securityRecipeId)
.state(securityRecipeState)
.build());
}
}
variables:
testSecurityRecipes:
fn::invoke:
Function: oci:CloudGuard:getSecurityRecipes
Arguments:
compartmentId: ${compartmentId}
displayName: ${securityRecipeDisplayName}
id: ${securityRecipeId}
state: ${securityRecipeState}
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:
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the entire display name given.
- Filters
List<Get
Security Recipes Filter> - Id string
- The unique identifier of the security zone recipe. (
SecurityRecipe
) - State string
- The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the entire display name given.
- Filters
[]Get
Security Recipes Filter - Id string
- The unique identifier of the security zone recipe. (
SecurityRecipe
) - State string
- The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name String - A filter to return only resources that match the entire display name given.
- filters
List<Get
Security Recipes Filter> - id String
- The unique identifier of the security zone recipe. (
SecurityRecipe
) - state String
- The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
- compartment
Id string - The OCID of the compartment in which to list resources.
- display
Name string - A filter to return only resources that match the entire display name given.
- filters
Get
Security Recipes Filter[] - id string
- The unique identifier of the security zone recipe. (
SecurityRecipe
) - state string
- The field lifecycle 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 OCID 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
Sequence[cloudguard.
Get Security Recipes Filter] - id str
- The unique identifier of the security zone recipe. (
SecurityRecipe
) - state str
- The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name 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 lifecycle 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:
- Compartment
Id string - The OCID of the compartment that contains the recipe
- Security
Recipe List<GetCollections Security Recipes Security Recipe Collection> - The list of security_recipe_collection.
- Display
Name string - The recipe's display name
- Filters
List<Get
Security Recipes Filter> - Id string
- Unique identifier that can’t be changed after creation
- State string
- The current lifecycle state of the recipe
- Compartment
Id string - The OCID of the compartment that contains the recipe
- Security
Recipe []GetCollections Security Recipes Security Recipe Collection - The list of security_recipe_collection.
- Display
Name string - The recipe's display name
- Filters
[]Get
Security Recipes Filter - Id string
- Unique identifier that can’t be changed after creation
- State string
- The current lifecycle state of the recipe
- compartment
Id String - The OCID of the compartment that contains the recipe
- security
Recipe List<GetCollections Security Recipes Security Recipe Collection> - The list of security_recipe_collection.
- display
Name String - The recipe's display name
- filters
List<Get
Security Recipes Filter> - id String
- Unique identifier that can’t be changed after creation
- state String
- The current lifecycle state of the recipe
- compartment
Id string - The OCID of the compartment that contains the recipe
- security
Recipe GetCollections Security Recipes Security Recipe Collection[] - The list of security_recipe_collection.
- display
Name string - The recipe's display name
- filters
Get
Security Recipes Filter[] - id string
- Unique identifier that can’t be changed after creation
- state string
- The current lifecycle state of the recipe
- compartment_
id str - The OCID of the compartment that contains the recipe
- security_
recipe_ Sequence[cloudguard.collections Get Security Recipes Security Recipe Collection] - The list of security_recipe_collection.
- display_
name str - The recipe's display name
- filters
Sequence[cloudguard.
Get Security Recipes Filter] - id str
- Unique identifier that can’t be changed after creation
- state str
- The current lifecycle state of the recipe
- compartment
Id String - The OCID of the compartment that contains the recipe
- security
Recipe List<Property Map>Collections - The list of security_recipe_collection.
- display
Name String - The recipe's display name
- filters List<Property Map>
- id String
- Unique identifier that can’t be changed after creation
- state String
- The current lifecycle state of the recipe
Supporting Types
GetSecurityRecipesFilter
GetSecurityRecipesSecurityRecipeCollection
GetSecurityRecipesSecurityRecipeCollectionItem
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Dictionary<string, string>
- 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
- Display
Name string - A filter to return only resources that match the entire display name given.
- Dictionary<string, string>
- 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
) - Lifecycle
Details 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
- Security
Policies List<string> - The list of security policy IDs that are included in the recipe
- State string
- The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
- Time
Created string - The time the recipe was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time the recipe was last updated. An RFC3339 formatted datetime string.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- map[string]string
- 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
- Display
Name string - A filter to return only resources that match the entire display name given.
- map[string]string
- 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
) - Lifecycle
Details 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
- Security
Policies []string - The list of security policy IDs that are included in the recipe
- State string
- The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
- Time
Created string - The time the recipe was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time the recipe was last updated. An RFC3339 formatted datetime string.
- compartment
Id String - The OCID of the compartment in which to list resources.
- Map<String,String>
- 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
- display
Name String - A filter to return only resources that match the entire display name given.
- Map<String,String>
- 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
) - lifecycle
Details 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
- security
Policies List<String> - The list of security policy IDs that are included in the recipe
- state String
- The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
- time
Created String - The time the recipe was created. An RFC3339 formatted datetime string.
- time
Updated String - The time the recipe was last updated. An RFC3339 formatted datetime string.
- compartment
Id string - The OCID of the compartment in which to list resources.
- {[key: string]: string}
- 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
- display
Name string - A filter to return only resources that match the entire display name given.
- {[key: string]: string}
- 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
) - lifecycle
Details 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
- security
Policies string[] - The list of security policy IDs that are included in the recipe
- state string
- The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
- time
Created string - The time the recipe was created. An RFC3339 formatted datetime string.
- time
Updated string - The time the recipe was last updated. An RFC3339 formatted datetime string.
- compartment_
id str - The OCID of the compartment in which to list resources.
- Mapping[str, str]
- 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.
- Mapping[str, str]
- 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 security policy IDs that are included in the recipe
- state str
- The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
- 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.
- compartment
Id String - The OCID of the compartment in which to list resources.
- Map<String>
- 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
- display
Name String - A filter to return only resources that match the entire display name given.
- Map<String>
- 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
) - lifecycle
Details 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
- security
Policies List<String> - The list of security policy IDs that are included in the recipe
- state String
- The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
- time
Created String - The time the recipe was created. An RFC3339 formatted datetime string.
- time
Updated 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.