oci_budget_alert_rule – Manage a BudgetAlertRule resource in Oracle Cloud Infrastructure

New in version 2.5.

Synopsis

  • This module allows the user to create, update and delete a BudgetAlertRule resource in Oracle Cloud Infrastructure
  • For state=present, creates a new Alert Rule.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
alert_rule_id
-
The unique Alert Rule OCID
Required for update using state=present, state=absent.

aliases: id
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_OCID 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_type
string
    Choices:
  • api_key ←
  • instance_principal
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.
budget_id
- / required
The unique Budget OCID
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"}}`
description
-
The description of the alert rule.
display_name
-
The name of the alert rule.

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. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
key_by
list
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
message
-
The message to be sent to the recipients when alert rule is triggered.
recipients
-
The audience that will received the alert when it triggers.
Required for create using state=present.
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.
state
-
    Choices:
  • present ←
  • absent
The state of the BudgetAlertRule.
Use state=present to create or update a BudgetAlertRule.
Use state=absent to delete a BudgetAlertRule.
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
threshold
float
The threshold for triggering the alert expressed as a whole number or decimal value. If thresholdType is ABSOLUTE, threshold can have at most 12 digits before the decimal point and up to 2 digits after the decimal point. If thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to 2 digits after the decimal point.
Required for create using state=present.
threshold_type
-
    Choices:
  • PERCENTAGE
  • ABSOLUTE
The type of threshold.
Required for create using state=present.
type
-
    Choices:
  • ACTUAL
  • FORECAST
Type of alert. Valid values are ACTUAL (the alert will trigger based on actual usage) or FORECAST (the alert will trigger based on predicted usage).
Required for create using state=present.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
string
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

- name: Create budget_alert_rule
  oci_budget_alert_rule:
    budget_id: ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx
    type: ACTUAL
    threshold: 10
    threshold_type: PERCENTAGE
    recipients: recipients_example

- name: Update budget_alert_rule
  oci_budget_alert_rule:
    budget_id: ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx
    display_name: display_name_example
    alert_rule_id: ocid1.alertrule.oc1..xxxxxxEXAMPLExxxxxx

- name: Delete budget_alert_rule
  oci_budget_alert_rule:
    budget_id: ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx
    alert_rule_id: ocid1.alertrule.oc1..xxxxxxEXAMPLExxxxxx
    state: absent

Return Values

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

Key Returned Description
budget_alert_rule
complex
on success
Details of the BudgetAlertRule resource acted upon by the current operation

Sample:
{'lifecycle_state': 'ACTIVE', 'time_updated': '2013-10-20T19:20:30+01:00', 'display_name': 'display_name_example', 'description': 'description_example', 'recipients': 'recipients_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'threshold_type': 'PERCENTAGE', 'freeform_tags': {'Department': 'Finance'}, 'time_created': '2013-10-20T19:20:30+01:00', 'version': 56, 'budget_id': 'ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx', 'threshold': 10, 'message': 'message_example', 'type': 'ACTUAL', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}
  budget_id
string
on success
The OCID of the budget

Sample:
ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx
  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
The description of the alert rule.

Sample:
description_example
  display_name
string
on success
The name of the alert rule.

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. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
  id
string
on success
The OCID of the alert rule

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
  lifecycle_state
string
on success
The current state of the alert rule.

Sample:
ACTIVE
  message
string
on success
Custom message sent when alert is triggered

Sample:
message_example
  recipients
string
on success
Delimited list of email addresses to receive the alert when it triggers. Delimiter character can be comma, space, TAB, or semicolon.

Sample:
recipients_example
  threshold
float
on success
The threshold for triggering the alert. If thresholdType is PERCENTAGE, the maximum value is 10000.

Sample:
10
  threshold_type
string
on success
The type of threshold.

Sample:
PERCENTAGE
  time_created
string
on success
Time budget was created

Sample:
2013-10-20 18:20:30
  time_updated
string
on success
Time budget was updated

Sample:
2013-10-20 18:20:30
  type
string
on success
The type of alert. Valid values are ACTUAL (the alert will trigger based on actual usage) or FORECAST (the alert will trigger based on predicted usage).

Sample:
ACTUAL
  version
integer
on success
Version of the alert rule. Starts from 1 and increments by 1.

Sample:
56


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Manoj Meda (@manojmeda)
  • Mike Ross (@mross22)
  • Nabeel Al-Saber (@nalsaber)

Hint

If you notice any issues in this documentation you can edit this document to improve it.