1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Waf
  5. getProtectionCapabilities
Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi

oci.Waf.getProtectionCapabilities

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi

    This data source provides the list of Protection Capabilities in Oracle Cloud Infrastructure Waf service.

    Lists of protection capabilities filtered by query parameters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testProtectionCapabilities = oci.Waf.getProtectionCapabilities({
        compartmentId: _var.compartment_id,
        displayName: _var.protection_capability_display_name,
        groupTags: _var.protection_capability_group_tag,
        isLatestVersions: _var.protection_capability_is_latest_version,
        key: _var.protection_capability_key,
        type: _var.protection_capability_type,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_protection_capabilities = oci.Waf.get_protection_capabilities(compartment_id=var["compartment_id"],
        display_name=var["protection_capability_display_name"],
        group_tags=var["protection_capability_group_tag"],
        is_latest_versions=var["protection_capability_is_latest_version"],
        key=var["protection_capability_key"],
        type=var["protection_capability_type"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Waf"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Waf.GetProtectionCapabilities(ctx, &waf.GetProtectionCapabilitiesArgs{
    			CompartmentId:    _var.Compartment_id,
    			DisplayName:      pulumi.StringRef(_var.Protection_capability_display_name),
    			GroupTags:        _var.Protection_capability_group_tag,
    			IsLatestVersions: _var.Protection_capability_is_latest_version,
    			Key:              pulumi.StringRef(_var.Protection_capability_key),
    			Type:             pulumi.StringRef(_var.Protection_capability_type),
    		}, 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 testProtectionCapabilities = Oci.Waf.GetProtectionCapabilities.Invoke(new()
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Protection_capability_display_name,
            GroupTags = @var.Protection_capability_group_tag,
            IsLatestVersions = @var.Protection_capability_is_latest_version,
            Key = @var.Protection_capability_key,
            Type = @var.Protection_capability_type,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Waf.WafFunctions;
    import com.pulumi.oci.Waf.inputs.GetProtectionCapabilitiesArgs;
    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 testProtectionCapabilities = WafFunctions.getProtectionCapabilities(GetProtectionCapabilitiesArgs.builder()
                .compartmentId(var_.compartment_id())
                .displayName(var_.protection_capability_display_name())
                .groupTags(var_.protection_capability_group_tag())
                .isLatestVersions(var_.protection_capability_is_latest_version())
                .key(var_.protection_capability_key())
                .type(var_.protection_capability_type())
                .build());
    
        }
    }
    
    variables:
      testProtectionCapabilities:
        fn::invoke:
          Function: oci:Waf:getProtectionCapabilities
          Arguments:
            compartmentId: ${var.compartment_id}
            displayName: ${var.protection_capability_display_name}
            groupTags: ${var.protection_capability_group_tag}
            isLatestVersions: ${var.protection_capability_is_latest_version}
            key: ${var.protection_capability_key}
            type: ${var.protection_capability_type}
    

    Using getProtectionCapabilities

    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 getProtectionCapabilities(args: GetProtectionCapabilitiesArgs, opts?: InvokeOptions): Promise<GetProtectionCapabilitiesResult>
    function getProtectionCapabilitiesOutput(args: GetProtectionCapabilitiesOutputArgs, opts?: InvokeOptions): Output<GetProtectionCapabilitiesResult>
    def get_protection_capabilities(compartment_id: Optional[str] = None,
                                    display_name: Optional[str] = None,
                                    filters: Optional[Sequence[_waf.GetProtectionCapabilitiesFilter]] = None,
                                    group_tags: Optional[Sequence[str]] = None,
                                    is_latest_versions: Optional[Sequence[bool]] = None,
                                    key: Optional[str] = None,
                                    type: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetProtectionCapabilitiesResult
    def get_protection_capabilities_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                    display_name: Optional[pulumi.Input[str]] = None,
                                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_waf.GetProtectionCapabilitiesFilterArgs]]]] = None,
                                    group_tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                    is_latest_versions: Optional[pulumi.Input[Sequence[pulumi.Input[bool]]]] = None,
                                    key: Optional[pulumi.Input[str]] = None,
                                    type: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetProtectionCapabilitiesResult]
    func GetProtectionCapabilities(ctx *Context, args *GetProtectionCapabilitiesArgs, opts ...InvokeOption) (*GetProtectionCapabilitiesResult, error)
    func GetProtectionCapabilitiesOutput(ctx *Context, args *GetProtectionCapabilitiesOutputArgs, opts ...InvokeOption) GetProtectionCapabilitiesResultOutput

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

    public static class GetProtectionCapabilities 
    {
        public static Task<GetProtectionCapabilitiesResult> InvokeAsync(GetProtectionCapabilitiesArgs args, InvokeOptions? opts = null)
        public static Output<GetProtectionCapabilitiesResult> Invoke(GetProtectionCapabilitiesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProtectionCapabilitiesResult> getProtectionCapabilities(GetProtectionCapabilitiesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Waf/getProtectionCapabilities:getProtectionCapabilities
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID 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<GetProtectionCapabilitiesFilter>
    GroupTags List<string>
    A filter to return only resources that are accociated given group tag.
    IsLatestVersions List<bool>
    A filter to return only resources that matches given isLatestVersion.
    Key string
    The unique key of protection capability to filter by.
    Type string
    A filter to return only resources that matches given type.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters []GetProtectionCapabilitiesFilter
    GroupTags []string
    A filter to return only resources that are accociated given group tag.
    IsLatestVersions []bool
    A filter to return only resources that matches given isLatestVersion.
    Key string
    The unique key of protection capability to filter by.
    Type string
    A filter to return only resources that matches given type.
    compartmentId String
    The OCID 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<GetProtectionCapabilitiesFilter>
    groupTags List<String>
    A filter to return only resources that are accociated given group tag.
    isLatestVersions List<Boolean>
    A filter to return only resources that matches given isLatestVersion.
    key String
    The unique key of protection capability to filter by.
    type String
    A filter to return only resources that matches given type.
    compartmentId string
    The OCID of the compartment in which to list resources.
    displayName string
    A filter to return only resources that match the entire display name given.
    filters GetProtectionCapabilitiesFilter[]
    groupTags string[]
    A filter to return only resources that are accociated given group tag.
    isLatestVersions boolean[]
    A filter to return only resources that matches given isLatestVersion.
    key string
    The unique key of protection capability to filter by.
    type string
    A filter to return only resources that matches given type.
    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 GetProtectionCapabilitiesFilter]
    group_tags Sequence[str]
    A filter to return only resources that are accociated given group tag.
    is_latest_versions Sequence[bool]
    A filter to return only resources that matches given isLatestVersion.
    key str
    The unique key of protection capability to filter by.
    type str
    A filter to return only resources that matches given type.
    compartmentId String
    The OCID 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>
    groupTags List<String>
    A filter to return only resources that are accociated given group tag.
    isLatestVersions List<Boolean>
    A filter to return only resources that matches given isLatestVersion.
    key String
    The unique key of protection capability to filter by.
    type String
    A filter to return only resources that matches given type.

    getProtectionCapabilities Result

    The following output properties are available:

    CompartmentId string
    Id string
    The provider-assigned unique ID for this managed resource.
    ProtectionCapabilityCollections List<GetProtectionCapabilitiesProtectionCapabilityCollection>
    The list of protection_capability_collection.
    DisplayName string
    The display name of protection capability.
    Filters List<GetProtectionCapabilitiesFilter>
    GroupTags List<string>
    IsLatestVersions List<bool>
    The field that shows if this is the latest version of protection capability.
    Key string
    Unique key of protection capability.
    Type string
    The type of protection capability.

    • REQUEST_PROTECTION_CAPABILITY can only be used in requestProtection module of WebAppFirewallPolicy.
    • RESPONSE_PROTECTION_CAPABILITY can only be used in responseProtection module of WebAppFirewallPolicy.
    CompartmentId string
    Id string
    The provider-assigned unique ID for this managed resource.
    ProtectionCapabilityCollections []GetProtectionCapabilitiesProtectionCapabilityCollection
    The list of protection_capability_collection.
    DisplayName string
    The display name of protection capability.
    Filters []GetProtectionCapabilitiesFilter
    GroupTags []string
    IsLatestVersions []bool
    The field that shows if this is the latest version of protection capability.
    Key string
    Unique key of protection capability.
    Type string
    The type of protection capability.

    • REQUEST_PROTECTION_CAPABILITY can only be used in requestProtection module of WebAppFirewallPolicy.
    • RESPONSE_PROTECTION_CAPABILITY can only be used in responseProtection module of WebAppFirewallPolicy.
    compartmentId String
    id String
    The provider-assigned unique ID for this managed resource.
    protectionCapabilityCollections List<GetProtectionCapabilitiesProtectionCapabilityCollection>
    The list of protection_capability_collection.
    displayName String
    The display name of protection capability.
    filters List<GetProtectionCapabilitiesFilter>
    groupTags List<String>
    isLatestVersions List<Boolean>
    The field that shows if this is the latest version of protection capability.
    key String
    Unique key of protection capability.
    type String
    The type of protection capability.

    • REQUEST_PROTECTION_CAPABILITY can only be used in requestProtection module of WebAppFirewallPolicy.
    • RESPONSE_PROTECTION_CAPABILITY can only be used in responseProtection module of WebAppFirewallPolicy.
    compartmentId string
    id string
    The provider-assigned unique ID for this managed resource.
    protectionCapabilityCollections GetProtectionCapabilitiesProtectionCapabilityCollection[]
    The list of protection_capability_collection.
    displayName string
    The display name of protection capability.
    filters GetProtectionCapabilitiesFilter[]
    groupTags string[]
    isLatestVersions boolean[]
    The field that shows if this is the latest version of protection capability.
    key string
    Unique key of protection capability.
    type string
    The type of protection capability.

    • REQUEST_PROTECTION_CAPABILITY can only be used in requestProtection module of WebAppFirewallPolicy.
    • RESPONSE_PROTECTION_CAPABILITY can only be used in responseProtection module of WebAppFirewallPolicy.
    compartment_id str
    id str
    The provider-assigned unique ID for this managed resource.
    protection_capability_collections GetProtectionCapabilitiesProtectionCapabilityCollection]
    The list of protection_capability_collection.
    display_name str
    The display name of protection capability.
    filters GetProtectionCapabilitiesFilter]
    group_tags Sequence[str]
    is_latest_versions Sequence[bool]
    The field that shows if this is the latest version of protection capability.
    key str
    Unique key of protection capability.
    type str
    The type of protection capability.

    • REQUEST_PROTECTION_CAPABILITY can only be used in requestProtection module of WebAppFirewallPolicy.
    • RESPONSE_PROTECTION_CAPABILITY can only be used in responseProtection module of WebAppFirewallPolicy.
    compartmentId String
    id String
    The provider-assigned unique ID for this managed resource.
    protectionCapabilityCollections List<Property Map>
    The list of protection_capability_collection.
    displayName String
    The display name of protection capability.
    filters List<Property Map>
    groupTags List<String>
    isLatestVersions List<Boolean>
    The field that shows if this is the latest version of protection capability.
    key String
    Unique key of protection capability.
    type String
    The type of protection capability.

    • REQUEST_PROTECTION_CAPABILITY can only be used in requestProtection module of WebAppFirewallPolicy.
    • RESPONSE_PROTECTION_CAPABILITY can only be used in responseProtection module of WebAppFirewallPolicy.

    Supporting Types

    GetProtectionCapabilitiesFilter

    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

    GetProtectionCapabilitiesProtectionCapabilityCollection

    items List<Property Map>
    List of protection capabilities.

    GetProtectionCapabilitiesProtectionCapabilityCollectionItem

    CollaborativeActionThreshold int
    The default collaborative action threshold for OCI-managed collaborative protection capability. Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as contributing capabilities later on) which have weights assigned to them. These weights can be found in the collaborativeWeights array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to collaborativeActionThreshold is the incoming/outgoing HTTP message marked as malicious.
    CollaborativeWeights List<GetProtectionCapabilitiesProtectionCapabilityCollectionItemCollaborativeWeight>
    The weights of contributing capabilities. Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability.
    Description string
    The description of protection capability.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    GroupTags List<string>
    The list of unique names protection capability group tags that are associated with this capability. Example: ["PCI", "Recommended"]
    IsLatestVersion bool
    A filter to return only resources that matches given isLatestVersion.
    Key string
    The unique key of protection capability to filter by.
    Type string
    A filter to return only resources that matches given type.
    Version int
    The version of protection capability.
    CollaborativeActionThreshold int
    The default collaborative action threshold for OCI-managed collaborative protection capability. Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as contributing capabilities later on) which have weights assigned to them. These weights can be found in the collaborativeWeights array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to collaborativeActionThreshold is the incoming/outgoing HTTP message marked as malicious.
    CollaborativeWeights []GetProtectionCapabilitiesProtectionCapabilityCollectionItemCollaborativeWeight
    The weights of contributing capabilities. Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability.
    Description string
    The description of protection capability.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    GroupTags []string
    The list of unique names protection capability group tags that are associated with this capability. Example: ["PCI", "Recommended"]
    IsLatestVersion bool
    A filter to return only resources that matches given isLatestVersion.
    Key string
    The unique key of protection capability to filter by.
    Type string
    A filter to return only resources that matches given type.
    Version int
    The version of protection capability.
    collaborativeActionThreshold Integer
    The default collaborative action threshold for OCI-managed collaborative protection capability. Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as contributing capabilities later on) which have weights assigned to them. These weights can be found in the collaborativeWeights array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to collaborativeActionThreshold is the incoming/outgoing HTTP message marked as malicious.
    collaborativeWeights List<GetProtectionCapabilitiesProtectionCapabilityCollectionItemCollaborativeWeight>
    The weights of contributing capabilities. Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability.
    description String
    The description of protection capability.
    displayName String
    A filter to return only resources that match the entire display name given.
    groupTags List<String>
    The list of unique names protection capability group tags that are associated with this capability. Example: ["PCI", "Recommended"]
    isLatestVersion Boolean
    A filter to return only resources that matches given isLatestVersion.
    key String
    The unique key of protection capability to filter by.
    type String
    A filter to return only resources that matches given type.
    version Integer
    The version of protection capability.
    collaborativeActionThreshold number
    The default collaborative action threshold for OCI-managed collaborative protection capability. Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as contributing capabilities later on) which have weights assigned to them. These weights can be found in the collaborativeWeights array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to collaborativeActionThreshold is the incoming/outgoing HTTP message marked as malicious.
    collaborativeWeights GetProtectionCapabilitiesProtectionCapabilityCollectionItemCollaborativeWeight[]
    The weights of contributing capabilities. Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability.
    description string
    The description of protection capability.
    displayName string
    A filter to return only resources that match the entire display name given.
    groupTags string[]
    The list of unique names protection capability group tags that are associated with this capability. Example: ["PCI", "Recommended"]
    isLatestVersion boolean
    A filter to return only resources that matches given isLatestVersion.
    key string
    The unique key of protection capability to filter by.
    type string
    A filter to return only resources that matches given type.
    version number
    The version of protection capability.
    collaborative_action_threshold int
    The default collaborative action threshold for OCI-managed collaborative protection capability. Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as contributing capabilities later on) which have weights assigned to them. These weights can be found in the collaborativeWeights array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to collaborativeActionThreshold is the incoming/outgoing HTTP message marked as malicious.
    collaborative_weights GetProtectionCapabilitiesProtectionCapabilityCollectionItemCollaborativeWeight]
    The weights of contributing capabilities. Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability.
    description str
    The description of protection capability.
    display_name str
    A filter to return only resources that match the entire display name given.
    group_tags Sequence[str]
    The list of unique names protection capability group tags that are associated with this capability. Example: ["PCI", "Recommended"]
    is_latest_version bool
    A filter to return only resources that matches given isLatestVersion.
    key str
    The unique key of protection capability to filter by.
    type str
    A filter to return only resources that matches given type.
    version int
    The version of protection capability.
    collaborativeActionThreshold Number
    The default collaborative action threshold for OCI-managed collaborative protection capability. Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as contributing capabilities later on) which have weights assigned to them. These weights can be found in the collaborativeWeights array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to collaborativeActionThreshold is the incoming/outgoing HTTP message marked as malicious.
    collaborativeWeights List<Property Map>
    The weights of contributing capabilities. Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability.
    description String
    The description of protection capability.
    displayName String
    A filter to return only resources that match the entire display name given.
    groupTags List<String>
    The list of unique names protection capability group tags that are associated with this capability. Example: ["PCI", "Recommended"]
    isLatestVersion Boolean
    A filter to return only resources that matches given isLatestVersion.
    key String
    The unique key of protection capability to filter by.
    type String
    A filter to return only resources that matches given type.
    version Number
    The version of protection capability.

    GetProtectionCapabilitiesProtectionCapabilityCollectionItemCollaborativeWeight

    DisplayName string
    A filter to return only resources that match the entire display name given.
    Key string
    The unique key of protection capability to filter by.
    Weight int
    The weight of contributing protection capability.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Key string
    The unique key of protection capability to filter by.
    Weight int
    The weight of contributing protection capability.
    displayName String
    A filter to return only resources that match the entire display name given.
    key String
    The unique key of protection capability to filter by.
    weight Integer
    The weight of contributing protection capability.
    displayName string
    A filter to return only resources that match the entire display name given.
    key string
    The unique key of protection capability to filter by.
    weight number
    The weight of contributing protection capability.
    display_name str
    A filter to return only resources that match the entire display name given.
    key str
    The unique key of protection capability to filter by.
    weight int
    The weight of contributing protection capability.
    displayName String
    A filter to return only resources that match the entire display name given.
    key String
    The unique key of protection capability to filter by.
    weight Number
    The weight of contributing protection capability.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi