oracle.oci.oci_budget – Manage a Budget 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_budget.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new budget.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
amount
float
The amount of the budget expressed as a whole number in the currency of the customer's rate card.
Required for create using state=present.
This parameter is updatable.
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.
budget_id
string
The unique budget OCID.
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
budget_processing_period_start_offset
integer
The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.
This parameter is updatable.
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.
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.
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
The description of the budget.
This parameter is updatable.
display_name
string
The displayName of the budget. Avoid entering confidential information.
Required for create, 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
end_date
string
The date when the one-time budget concludes. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
This parameter is updatable.
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"}`
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.
processing_period_type
string
    Choices:
  • INVOICE
  • MONTH
  • SINGLE_USE
The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE.
This parameter is updatable.
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.
reset_period
string
    Choices:
  • MONTHLY
The reset period for the budget.
Required for create using state=present.
This parameter is updatable.
start_date
string
The date when the one-time budget begins. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the Budget.
Use state=present to create or update a Budget.
Use state=absent to delete a Budget.
target_compartment_id
string
This is DEPRECATED. Set the target compartment ID in targets instead.
target_type
string
    Choices:
  • COMPARTMENT
  • TAG
The type of target on which the budget is applied.
targets
list / elements=string
The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.
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 budget
  oci_budget:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    amount: 3.4
    reset_period: MONTHLY

    # optional
    target_compartment_id: "ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx"
    target_type: COMPARTMENT
    targets: [ "targets_example" ]
    display_name: display_name_example
    description: description_example
    budget_processing_period_start_offset: 56
    processing_period_type: INVOICE
    start_date: start_date_example
    end_date: end_date_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update budget
  oci_budget:
    # required
    budget_id: "ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    amount: 3.4
    budget_processing_period_start_offset: 56
    processing_period_type: INVOICE
    start_date: start_date_example
    end_date: end_date_example
    reset_period: MONTHLY
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

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

    # optional
    description: description_example
    amount: 3.4
    budget_processing_period_start_offset: 56
    processing_period_type: INVOICE
    start_date: start_date_example
    end_date: end_date_example
    reset_period: MONTHLY
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete budget
  oci_budget:
    # required
    budget_id: "ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete budget using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_budget:
    # 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
budget
complex
on success
Details of the Budget resource acted upon by the current operation

Sample:
{'actual_spend': 10, 'alert_rule_count': 56, 'amount': 10, 'budget_processing_period_start_offset': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'end_date': '2013-10-20T19:20:30+01:00', 'forecasted_spend': 10, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'processing_period_type': 'INVOICE', 'reset_period': 'MONTHLY', 'start_date': '2013-10-20T19:20:30+01:00', 'target_compartment_id': 'ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'target_type': 'COMPARTMENT', 'targets': [], 'time_created': '2013-10-20T19:20:30+01:00', 'time_spend_computed': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 56}
 
actual_spend
float
on success
The actual spend in currency for the current budget cycle.

Sample:
10
 
alert_rule_count
integer
on success
The total number of alert rules in the budget.

Sample:
56
 
amount
float
on success
The amount of the budget expressed in the currency of the customer's rate card.

Sample:
10
 
budget_processing_period_start_offset
integer
on success
The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

Sample:
56
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.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 budget.

Sample:
description_example
 
display_name
string
on success
The display name of the budget. Avoid entering confidential information.

Sample:
display_name_example
 
end_date
string
on success
The time when the one-time budget concludes. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.

Sample:
2013-10-20T19:20:30+01:00
 
forecasted_spend
float
on success
The forecasted spend in currency by the end of the current budget cycle.

Sample:
10
 
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 budget.

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

Sample:
ACTIVE
 
processing_period_type
string
on success
The budget processing period type. Valid values are INVOICE, MONTH, and SINGLE_USE.

Sample:
INVOICE
 
reset_period
string
on success
The reset period for the budget.

Sample:
MONTHLY
 
start_date
string
on success
The date when the one-time budget begins. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.

Sample:
2013-10-20T19:20:30+01:00
 
target_compartment_id
string
on success
This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty.

Sample:
ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx
 
target_type
string
on success
The type of target on which the budget is applied.

Sample:
COMPARTMENT
 
targets
list / elements=string
on success
The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".
 
time_created
string
on success
The time that the budget was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_spend_computed
string
on success
The time that the budget spend was last computed.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time that the budget was updated.

Sample:
2013-10-20T19:20:30+01:00
 
version
integer
on success
The version of the budget. Starts from 1 and increments by 1.

Sample:
56


Authors

  • Oracle (@oracle)