oracle.oci.oci_events_rule – Manage a Rule resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_events_rule.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Rule resource in Oracle Cloud Infrastructure

  • For state=present, creates a new rule.

  • This resource has the following action operations in the oracle.oci.oci_events_rule_actions module: change_compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
actions
dictionary
Required for create using state=present.
This parameter is updatable.
actions
list / elements=dictionary / required
A list of one or more ActionDetails objects.
action_type
string / required
    Choices:
  • OSS
  • FAAS
  • ONS
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 action. It does not have to be unique, and you can change it. Avoid entering confidential information.
function_id
string
The OCID of a Function hosted by Oracle Functions Service.
Applicable when action_type is 'FAAS'
is_enabled
boolean / required
    Choices:
  • no
  • yes
Whether or not this action is currently enabled.
Example: `true`
stream_id
string
The OCID of the stream to which messages are delivered.
Required when action_type is 'OSS'
topic_id
string
The OCID of the topic to which messages are delivered.
Applicable when action_type is 'ONS'
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment to which this rule belongs.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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: `{}`
For more examples, see Matching Events with Filters. * For a condition with fields to match an event, the event must contain all the field names listed in the condition. Field names must appear in the condition with the same nesting structure used in the event.
For a list of reference events, see Services that Produce Events. * Rules apply to events in the compartment in which you create them and any child compartments. This means that a condition specified by a rule only matches events emitted from resources in the compartment or any of its child compartments. * Wildcard matching is supported with the asterisk (*) character.
For examples of wildcard matching, see Matching Events with Filters
Example: `\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"`
Required for create using state=present.
This parameter is updatable.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
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.
This parameter is updatable.
display_name
string
A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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"}`
This parameter is updatable.
is_enabled
boolean
    Choices:
  • no
  • yes
Whether or not this rule is currently enabled.
Example: `true`
Required for create using state=present.
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
rule_id
string
The OCID of this rule.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
state
string
    Choices:
  • present ←
  • absent
The state of the Rule.
Use state=present to create or update a Rule.
Use state=absent to delete a Rule.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create rule
  oci_events_rule:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    is_enabled: true
    condition: condition_example
    actions:
      # required
      actions:
      - # required
        stream_id: "ocid1.stream.oc1..xxxxxxEXAMPLExxxxxx"
        action_type: OSS
        is_enabled: true

        # optional
        description: description_example

    # optional
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update rule
  oci_events_rule:
    # required
    rule_id: "ocid1.rule.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    is_enabled: true
    condition: condition_example
    actions:
      # required
      actions:
      - # required
        stream_id: "ocid1.stream.oc1..xxxxxxEXAMPLExxxxxx"
        action_type: OSS
        is_enabled: true

        # optional
        description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update rule using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_events_rule:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    description: description_example
    is_enabled: true
    condition: condition_example
    actions:
      # required
      actions:
      - # required
        stream_id: "ocid1.stream.oc1..xxxxxxEXAMPLExxxxxx"
        action_type: OSS
        is_enabled: true

        # optional
        description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete rule
  oci_events_rule:
    # required
    rule_id: "ocid1.rule.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete rule using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_events_rule:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
rule
complex
on success
Details of the Rule resource acted upon by the current operation

Sample:
{'actions': {'actions': [{'action_type': 'ONS', 'description': 'description_example', 'function_id': 'ocid1.function.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_enabled': True, 'lifecycle_message': 'lifecycle_message_example', 'lifecycle_state': 'CREATING', 'stream_id': 'ocid1.stream.oc1..xxxxxxEXAMPLExxxxxx', 'topic_id': 'ocid1.topic.oc1..xxxxxxEXAMPLExxxxxx'}]}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'condition': 'condition_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_enabled': True, 'lifecycle_message': 'lifecycle_message_example', 'lifecycle_state': 'CREATING', 'time_created': '2013-10-20T19:20:30+01:00'}
 
actions
complex
on success

   
actions
complex
on success
A list of one or more Action objects.
     
action_type
string
on success
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.

Sample:
ONS
     
description
string
on success
A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering confidential information.

Sample:
description_example
     
function_id
string
on success
The OCID of a Function hosted by Oracle Functions Service.

Sample:
ocid1.function.oc1..xxxxxxEXAMPLExxxxxx
     
id
string
on success
The OCID of the action.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
     
is_enabled
boolean
on success
Whether or not this action is currently enabled.
Example: `true`

Sample:
True
     
lifecycle_message
string
on success
A message generated by the Events service about the current state of this action.

Sample:
lifecycle_message_example
     
lifecycle_state
string
on success
The current state of the rule.

Sample:
CREATING
     
stream_id
string
on success
The OCID of the stream to which messages are delivered.

Sample:
ocid1.stream.oc1..xxxxxxEXAMPLExxxxxx
     
topic_id
string
on success
The OCID of the topic to which messages are delivered.

Sample:
ocid1.topic.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the compartment to which this rule belongs.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
condition
string
on success
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: `{}`
For more examples, see Matching Events with Filters. * For a condition with fields to match an event, the event must contain all the field names listed in the condition. Field names must appear in the condition with the same nesting structure used in the event.
For a list of reference events, see Services that Produce Events. * Rules apply to events in the compartment in which you create them and any child compartments. This means that a condition specified by a rule only matches events emitted from resources in the compartment or any of its child compartments. * Wildcard matching is supported with the asterisk (*) character.
For examples of wildcard matching, see Matching Events with Filters
Example: `\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"`

Sample:
condition_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
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.

Sample:
description_example
 
display_name
string
on success
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."`

Sample:
display_name_example
 
freeform_tags
dictionary
on success
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"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of this rule.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_enabled
boolean
on success
Whether or not this rule is currently enabled.
Example: `true`

Sample:
True
 
lifecycle_message
string
on success
A message generated by the Events service about the current state of this rule.

Sample:
lifecycle_message_example
 
lifecycle_state
string
on success
The current state of the rule.

Sample:
CREATING
 
time_created
string
on success
The time this rule was created, expressed in RFC 3339 timestamp format.
Example: `2018-09-12T22:47:12.613Z`

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)