Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Events
  5. getRules
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.Events.getRules

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Rules in Oracle Cloud Infrastructure Events service.

    Lists rules for this compartment.

    Example Usage

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

const testRules = oci.Events.getRules({
    compartmentId: compartmentId,
    displayName: ruleDisplayName,
    state: ruleState,
});

    import pulumi
import pulumi_oci as oci

test_rules = oci.Events.get_rules(compartment_id=compartment_id,
    display_name=rule_display_name,
    state=rule_state)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Events.GetRules(ctx, &events.GetRulesArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(ruleDisplayName),
			State:         pulumi.StringRef(ruleState),
		}, 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 testRules = Oci.Events.GetRules.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = ruleDisplayName,
        State = ruleState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Events.EventsFunctions;
import com.pulumi.oci.Events.inputs.GetRulesArgs;
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 testRules = EventsFunctions.getRules(GetRulesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(ruleDisplayName)
            .state(ruleState)
            .build());

    }
}

    variables:
  testRules:
    fn::invoke:
      Function: oci:Events:getRules
      Arguments:
        compartmentId: ${compartmentId}
        displayName: ${ruleDisplayName}
        state: ${ruleState}

    Using getRules

    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 getRules(args: GetRulesArgs, opts?: InvokeOptions): Promise<GetRulesResult>
function getRulesOutput(args: GetRulesOutputArgs, opts?: InvokeOptions): Output<GetRulesResult>
    def get_rules(compartment_id: Optional[str] = None,
              display_name: Optional[str] = None,
              filters: Optional[Sequence[_events.GetRulesFilter]] = None,
              state: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetRulesResult
def get_rules_output(compartment_id: Optional[pulumi.Input[str]] = None,
              display_name: Optional[pulumi.Input[str]] = None,
              filters: Optional[pulumi.Input[Sequence[pulumi.Input[_events.GetRulesFilterArgs]]]] = None,
              state: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRulesResult]
    func GetRules(ctx *Context, args *GetRulesArgs, opts ...InvokeOption) (*GetRulesResult, error)
func GetRulesOutput(ctx *Context, args *GetRulesOutputArgs, opts ...InvokeOption) GetRulesResultOutput

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

    public static class GetRules 
{
    public static Task<GetRulesResult> InvokeAsync(GetRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetRulesResult> Invoke(GetRulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRulesResult> getRules(GetRulesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:Events/getRules:getRules
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment to which this rule belongs.
    DisplayName string
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    Filters List<GetRulesFilter>
    State string
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    CompartmentId string
    The OCID of the compartment to which this rule belongs.
    DisplayName string
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    Filters []GetRulesFilter
    State string
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    compartmentId String
    The OCID of the compartment to which this rule belongs.
    displayName String
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    filters List<GetRulesFilter>
    state String
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    compartmentId string
    The OCID of the compartment to which this rule belongs.
    displayName string
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    filters GetRulesFilter[]
    state string
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    compartment_id str
    The OCID of the compartment to which this rule belongs.
    display_name str
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    filters Sequence[events.GetRulesFilter]
    state str
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    compartmentId String
    The OCID of the compartment to which this rule belongs.
    displayName String
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    filters List<Property Map>
    state String
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating

    getRules Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment to which this rule belongs.
    Id string
    The provider-assigned unique ID for this managed resource.
    Rules List<GetRulesRule>
    The list of rules.
    DisplayName string
    A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. Example: "This rule sends a notification upon completion of DbaaS backup."
    Filters List<GetRulesFilter>
    State string
    The current state of the rule.
    CompartmentId string
    The OCID of the compartment to which this rule belongs.
    Id string
    The provider-assigned unique ID for this managed resource.
    Rules []GetRulesRule
    The list of rules.
    DisplayName string
    A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. Example: "This rule sends a notification upon completion of DbaaS backup."
    Filters []GetRulesFilter
    State string
    The current state of the rule.
    compartmentId String
    The OCID of the compartment to which this rule belongs.
    id String
    The provider-assigned unique ID for this managed resource.
    rules List<GetRulesRule>
    The list of rules.
    displayName String
    A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. Example: "This rule sends a notification upon completion of DbaaS backup."
    filters List<GetRulesFilter>
    state String
    The current state of the rule.
    compartmentId string
    The OCID of the compartment to which this rule belongs.
    id string
    The provider-assigned unique ID for this managed resource.
    rules GetRulesRule[]
    The list of rules.
    displayName string
    A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. Example: "This rule sends a notification upon completion of DbaaS backup."
    filters GetRulesFilter[]
    state string
    The current state of the rule.
    compartment_id str
    The OCID of the compartment to which this rule belongs.
    id str
    The provider-assigned unique ID for this managed resource.
    rules Sequence[events.GetRulesRule]
    The list of rules.
    display_name str
    A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. Example: "This rule sends a notification upon completion of DbaaS backup."
    filters Sequence[events.GetRulesFilter]
    state str
    The current state of the rule.
    compartmentId String
    The OCID of the compartment to which this rule belongs.
    id String
    The provider-assigned unique ID for this managed resource.
    rules List<Property Map>
    The list of rules.
    displayName String
    A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. Example: "This rule sends a notification upon completion of DbaaS backup."
    filters List<Property Map>
    state String
    The current state of the rule.

    Supporting Types

    GetRulesFilter

    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

    GetRulesRule

    Actions List<GetRulesRuleAction>
    A list of one or more Action objects.
    CompartmentId string
    The OCID of the compartment to which this rule belongs.
    Condition string
    A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters:

    • Fields not mentioned in the condition are ignored. You can create a valid filter that matches all events with two curly brackets: {}
    DefinedTags Dictionary<string, object>
    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
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    DisplayName string
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    FreeformTags Dictionary<string, object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of this rule.
    IsEnabled bool
    Whether or not this rule is currently enabled. Example: true
    LifecycleMessage string
    A message generated by the Events service about the current state of this rule.
    State string
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    TimeCreated string
    The time this rule was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z
    Actions []GetRulesRuleAction
    A list of one or more Action objects.
    CompartmentId string
    The OCID of the compartment to which this rule belongs.
    Condition string
    A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters:

    • Fields not mentioned in the condition are ignored. You can create a valid filter that matches all events with two curly brackets: {}
    DefinedTags map[string]interface{}
    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
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    DisplayName string
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    FreeformTags map[string]interface{}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of this rule.
    IsEnabled bool
    Whether or not this rule is currently enabled. Example: true
    LifecycleMessage string
    A message generated by the Events service about the current state of this rule.
    State string
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    TimeCreated string
    The time this rule was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z
    actions List<GetRulesRuleAction>
    A list of one or more Action objects.
    compartmentId String
    The OCID of the compartment to which this rule belongs.
    condition String
    A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters:

    • Fields not mentioned in the condition are ignored. You can create a valid filter that matches all events with two curly brackets: {}
    definedTags Map<String,Object>
    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
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    displayName String
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    freeformTags Map<String,Object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of this rule.
    isEnabled Boolean
    Whether or not this rule is currently enabled. Example: true
    lifecycleMessage String
    A message generated by the Events service about the current state of this rule.
    state String
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    timeCreated String
    The time this rule was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z
    actions GetRulesRuleAction[]
    A list of one or more Action objects.
    compartmentId string
    The OCID of the compartment to which this rule belongs.
    condition string
    A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters:

    • Fields not mentioned in the condition are ignored. You can create a valid filter that matches all events with two curly brackets: {}
    definedTags {[key: string]: any}
    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
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    displayName string
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    freeformTags {[key: string]: any}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of this rule.
    isEnabled boolean
    Whether or not this rule is currently enabled. Example: true
    lifecycleMessage string
    A message generated by the Events service about the current state of this rule.
    state string
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    timeCreated string
    The time this rule was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z
    actions Sequence[events.GetRulesRuleAction]
    A list of one or more Action objects.
    compartment_id str
    The OCID of the compartment to which this rule belongs.
    condition str
    A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters:

    • Fields not mentioned in the condition are ignored. You can create a valid filter that matches all events with two curly brackets: {}
    defined_tags Mapping[str, Any]
    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
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    display_name str
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    freeform_tags Mapping[str, Any]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of this rule.
    is_enabled bool
    Whether or not this rule is currently enabled. Example: true
    lifecycle_message str
    A message generated by the Events service about the current state of this rule.
    state str
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    time_created str
    The time this rule was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z
    actions List<Property Map>
    A list of one or more Action objects.
    compartmentId String
    The OCID of the compartment to which this rule belongs.
    condition String
    A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters:

    • Fields not mentioned in the condition are ignored. You can create a valid filter that matches all events with two curly brackets: {}
    definedTags Map<Any>
    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
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    displayName String
    A filter to return only rules with descriptions that match the displayName string in this parameter. Example: "This rule sends a notification upon completion of DbaaS backup."
    freeformTags Map<Any>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of this rule.
    isEnabled Boolean
    Whether or not this rule is currently enabled. Example: true
    lifecycleMessage String
    A message generated by the Events service about the current state of this rule.
    state String
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    timeCreated String
    The time this rule was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

    GetRulesRuleAction

    Actions List<GetRulesRuleActionAction>
    A list of one or more Action objects.
    Actions []GetRulesRuleActionAction
    A list of one or more Action objects.
    actions List<GetRulesRuleActionAction>
    A list of one or more Action objects.
    actions GetRulesRuleActionAction[]
    A list of one or more Action objects.
    actions Sequence[events.GetRulesRuleActionAction]
    A list of one or more Action objects.
    actions List<Property Map>
    A list of one or more Action objects.

    GetRulesRuleActionAction

    ActionType string
    The action to perform if the condition in the rule matches an event.

    • ONS: Send to an Oracle Notification Service topic.
    • OSS: Send to a stream from Oracle Streaming Service.
    • FAAS: Send to an Oracle Functions Service endpoint.
    Description string
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    FunctionId string
    The OCID of a Function hosted by Oracle Functions Service.
    Id string
    The OCID of this rule.
    IsEnabled bool
    Whether or not this rule is currently enabled. Example: true
    LifecycleMessage string
    A message generated by the Events service about the current state of this rule.
    State string
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    StreamId string
    The OCID of the stream to which messages are delivered.
    TopicId string
    The OCID of the topic to which messages are delivered.
    ActionType string
    The action to perform if the condition in the rule matches an event.

    • ONS: Send to an Oracle Notification Service topic.
    • OSS: Send to a stream from Oracle Streaming Service.
    • FAAS: Send to an Oracle Functions Service endpoint.
    Description string
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    FunctionId string
    The OCID of a Function hosted by Oracle Functions Service.
    Id string
    The OCID of this rule.
    IsEnabled bool
    Whether or not this rule is currently enabled. Example: true
    LifecycleMessage string
    A message generated by the Events service about the current state of this rule.
    State string
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    StreamId string
    The OCID of the stream to which messages are delivered.
    TopicId string
    The OCID of the topic to which messages are delivered.
    actionType String
    The action to perform if the condition in the rule matches an event.

    • ONS: Send to an Oracle Notification Service topic.
    • OSS: Send to a stream from Oracle Streaming Service.
    • FAAS: Send to an Oracle Functions Service endpoint.
    description String
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    functionId String
    The OCID of a Function hosted by Oracle Functions Service.
    id String
    The OCID of this rule.
    isEnabled Boolean
    Whether or not this rule is currently enabled. Example: true
    lifecycleMessage String
    A message generated by the Events service about the current state of this rule.
    state String
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    streamId String
    The OCID of the stream to which messages are delivered.
    topicId String
    The OCID of the topic to which messages are delivered.
    actionType string
    The action to perform if the condition in the rule matches an event.

    • ONS: Send to an Oracle Notification Service topic.
    • OSS: Send to a stream from Oracle Streaming Service.
    • FAAS: Send to an Oracle Functions Service endpoint.
    description string
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    functionId string
    The OCID of a Function hosted by Oracle Functions Service.
    id string
    The OCID of this rule.
    isEnabled boolean
    Whether or not this rule is currently enabled. Example: true
    lifecycleMessage string
    A message generated by the Events service about the current state of this rule.
    state string
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    streamId string
    The OCID of the stream to which messages are delivered.
    topicId string
    The OCID of the topic to which messages are delivered.
    action_type str
    The action to perform if the condition in the rule matches an event.

    • ONS: Send to an Oracle Notification Service topic.
    • OSS: Send to a stream from Oracle Streaming Service.
    • FAAS: Send to an Oracle Functions Service endpoint.
    description str
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    function_id str
    The OCID of a Function hosted by Oracle Functions Service.
    id str
    The OCID of this rule.
    is_enabled bool
    Whether or not this rule is currently enabled. Example: true
    lifecycle_message str
    A message generated by the Events service about the current state of this rule.
    state str
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    stream_id str
    The OCID of the stream to which messages are delivered.
    topic_id str
    The OCID of the topic to which messages are delivered.
    actionType String
    The action to perform if the condition in the rule matches an event.

    • ONS: Send to an Oracle Notification Service topic.
    • OSS: Send to a stream from Oracle Streaming Service.
    • FAAS: Send to an Oracle Functions Service endpoint.
    description String
    A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
    functionId String
    The OCID of a Function hosted by Oracle Functions Service.
    id String
    The OCID of this rule.
    isEnabled Boolean
    Whether or not this rule is currently enabled. Example: true
    lifecycleMessage String
    A message generated by the Events service about the current state of this rule.
    state String
    A filter to return only rules that match the lifecycle state in this parameter. Example: Creating
    streamId String
    The OCID of the stream to which messages are delivered.
    topicId String
    The OCID of the topic to which messages are delivered.

    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.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci