Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Waas
  5. getCustomProtectionRule
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.Waas.getCustomProtectionRule

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific Custom Protection Rule resource in Oracle Cloud Infrastructure Web Application Acceleration and Security service.

Gets the details of a custom protection rule.

Example Usage

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

const testCustomProtectionRule = oci.Waas.getCustomProtectionRule({
    customProtectionRuleId: testCustomProtectionRuleOciWaasCustomProtectionRule.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_custom_protection_rule = oci.Waas.get_custom_protection_rule(custom_protection_rule_id=test_custom_protection_rule_oci_waas_custom_protection_rule["id"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := waas.GetCustomProtectionRule(ctx, &waas.GetCustomProtectionRuleArgs{
			CustomProtectionRuleId: testCustomProtectionRuleOciWaasCustomProtectionRule.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCustomProtectionRule = Oci.Waas.GetCustomProtectionRule.Invoke(new()
    {
        CustomProtectionRuleId = testCustomProtectionRuleOciWaasCustomProtectionRule.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Waas.WaasFunctions;
import com.pulumi.oci.Waas.inputs.GetCustomProtectionRuleArgs;
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 testCustomProtectionRule = WaasFunctions.getCustomProtectionRule(GetCustomProtectionRuleArgs.builder()
            .customProtectionRuleId(testCustomProtectionRuleOciWaasCustomProtectionRule.id())
            .build());

    }
}
Copy
variables:
  testCustomProtectionRule:
    fn::invoke:
      function: oci:Waas:getCustomProtectionRule
      arguments:
        customProtectionRuleId: ${testCustomProtectionRuleOciWaasCustomProtectionRule.id}
Copy

Using getCustomProtectionRule

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 getCustomProtectionRule(args: GetCustomProtectionRuleArgs, opts?: InvokeOptions): Promise<GetCustomProtectionRuleResult>
function getCustomProtectionRuleOutput(args: GetCustomProtectionRuleOutputArgs, opts?: InvokeOptions): Output<GetCustomProtectionRuleResult>
Copy
def get_custom_protection_rule(custom_protection_rule_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetCustomProtectionRuleResult
def get_custom_protection_rule_output(custom_protection_rule_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetCustomProtectionRuleResult]
Copy
func GetCustomProtectionRule(ctx *Context, args *GetCustomProtectionRuleArgs, opts ...InvokeOption) (*GetCustomProtectionRuleResult, error)
func GetCustomProtectionRuleOutput(ctx *Context, args *GetCustomProtectionRuleOutputArgs, opts ...InvokeOption) GetCustomProtectionRuleResultOutput
Copy

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

public static class GetCustomProtectionRule 
{
    public static Task<GetCustomProtectionRuleResult> InvokeAsync(GetCustomProtectionRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomProtectionRuleResult> Invoke(GetCustomProtectionRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCustomProtectionRuleResult> getCustomProtectionRule(GetCustomProtectionRuleArgs args, InvokeOptions options)
public static Output<GetCustomProtectionRuleResult> getCustomProtectionRule(GetCustomProtectionRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Waas/getCustomProtectionRule:getCustomProtectionRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CustomProtectionRuleId This property is required. string
The OCID of the custom protection rule. This number is generated when the custom protection rule is added to the compartment.
CustomProtectionRuleId This property is required. string
The OCID of the custom protection rule. This number is generated when the custom protection rule is added to the compartment.
customProtectionRuleId This property is required. String
The OCID of the custom protection rule. This number is generated when the custom protection rule is added to the compartment.
customProtectionRuleId This property is required. string
The OCID of the custom protection rule. This number is generated when the custom protection rule is added to the compartment.
custom_protection_rule_id This property is required. str
The OCID of the custom protection rule. This number is generated when the custom protection rule is added to the compartment.
customProtectionRuleId This property is required. String
The OCID of the custom protection rule. This number is generated when the custom protection rule is added to the compartment.

getCustomProtectionRule Result

The following output properties are available:

CompartmentId string
The OCID of the custom protection rule's compartment.
CustomProtectionRuleId string
DefinedTags Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
The description of the custom protection rule.
DisplayName string
The user-friendly name of the custom protection rule.
FreeformTags Dictionary<string, string>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string
The OCID of the custom protection rule.
ModSecurityRuleIds List<string>
The auto-generated ID for the custom protection rule. These IDs are referenced in logs.
State string
The current lifecycle state of the custom protection rule.
Template string
The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.
TimeCreated string
The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
CompartmentId string
The OCID of the custom protection rule's compartment.
CustomProtectionRuleId string
DefinedTags map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
The description of the custom protection rule.
DisplayName string
The user-friendly name of the custom protection rule.
FreeformTags map[string]string
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string
The OCID of the custom protection rule.
ModSecurityRuleIds []string
The auto-generated ID for the custom protection rule. These IDs are referenced in logs.
State string
The current lifecycle state of the custom protection rule.
Template string
The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.
TimeCreated string
The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
compartmentId String
The OCID of the custom protection rule's compartment.
customProtectionRuleId String
definedTags Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
The description of the custom protection rule.
displayName String
The user-friendly name of the custom protection rule.
freeformTags Map<String,String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String
The OCID of the custom protection rule.
modSecurityRuleIds List<String>
The auto-generated ID for the custom protection rule. These IDs are referenced in logs.
state String
The current lifecycle state of the custom protection rule.
template String
The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.
timeCreated String
The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
compartmentId string
The OCID of the custom protection rule's compartment.
customProtectionRuleId string
definedTags {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string
The description of the custom protection rule.
displayName string
The user-friendly name of the custom protection rule.
freeformTags {[key: string]: string}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string
The OCID of the custom protection rule.
modSecurityRuleIds string[]
The auto-generated ID for the custom protection rule. These IDs are referenced in logs.
state string
The current lifecycle state of the custom protection rule.
template string
The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.
timeCreated string
The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
compartment_id str
The OCID of the custom protection rule's compartment.
custom_protection_rule_id str
defined_tags Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str
The description of the custom protection rule.
display_name str
The user-friendly name of the custom protection rule.
freeform_tags Mapping[str, str]
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str
The OCID of the custom protection rule.
mod_security_rule_ids Sequence[str]
The auto-generated ID for the custom protection rule. These IDs are referenced in logs.
state str
The current lifecycle state of the custom protection rule.
template str
The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.
time_created str
The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
compartmentId String
The OCID of the custom protection rule's compartment.
customProtectionRuleId String
definedTags Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
The description of the custom protection rule.
displayName String
The user-friendly name of the custom protection rule.
freeformTags Map<String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String
The OCID of the custom protection rule.
modSecurityRuleIds List<String>
The auto-generated ID for the custom protection rule. These IDs are referenced in logs.
state String
The current lifecycle state of the custom protection rule.
template String
The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.
timeCreated String
The date and time the protection rule was created, expressed in RFC 3339 timestamp format.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci