oracle.oci.oci_ai_anomaly_detection_data_asset – Manage a DataAsset resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_ai_anomaly_detection_data_asset
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a DataAsset resource in Oracle Cloud Infrastructure
For state=present, creates a new DataAsset.
This resource has the following action operations in the oracle.oci.oci_ai_anomaly_detection_data_asset_actions module: change_compartment.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
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
|
|
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
|
|
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 for the data asset's 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 . |
|||
data_asset_id
string
|
The OCID of the Data Asset.
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 |
|||
data_source_details
dictionary
|
Required for create using state=present.
|
|||
atp_password_secret_id
string
|
atp db password Secret Id
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
atp_user_name
string
|
atp db user name
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
bucket_name
string
|
Object storage bucket name
Applicable when data_source_type is 'ORACLE_OBJECT_STORAGE'
|
|||
cwallet_file_secret_id
string
|
OCID of the secret containing the containers certificates of ATP wallet
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
data_source_type
string
/ required
|
|
Data source type where actually data asset is being stored
|
||
database_name
string
|
atp database name
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
ewallet_file_secret_id
string
|
OCID of the secret containing the PDB'S certificates of ATP wallet
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
key_store_file_secret_id
string
|
OCID of the secret containing Keystore.jks file of the ATP wallet
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
measurement_name
string
|
Measurement name for influx
Required when data_source_type is 'INFLUX'
|
|||
namespace
string
|
Object storage namespace
Applicable when data_source_type is 'ORACLE_OBJECT_STORAGE'
|
|||
object_name
string
|
File name
Applicable when data_source_type is 'ORACLE_OBJECT_STORAGE'
|
|||
ojdbc_file_secret_id
string
|
OCID of the secret that contains jdbc properties file of ATP wallet
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
password_secret_id
string
|
Password Secret Id for the influx connection
Required when data_source_type is 'INFLUX'
|
|||
table_name
string
|
atp database table name
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
tnsnames_file_secret_id
string
|
OCID of the secret that contains the tnsnames file of ATP wallet
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
truststore_file_secret_id
string
|
OCID of the secret containing truststore.jks file of the ATP wallet
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
url
string
|
public IP address and port to influx DB
Required when data_source_type is 'INFLUX'
|
|||
user_name
string
|
Username for connection to Influx
Required when data_source_type is 'INFLUX'
|
|||
version_specific_details
dictionary
|
Required when data_source_type is 'INFLUX'
|
|||
bucket_name
string
|
Bucket Name for influx connection
Required when influx_version is 'V_2_0'
|
|||
database_name
string
|
DB Name for influx connection
Required when influx_version is 'V_1_8'
|
|||
influx_version
string
/ required
|
|
Data source type where actually data asset is being stored
|
||
organization_name
string
|
Org name for the influx db
Required when influx_version is 'V_2_0'
|
|||
retention_policy_name
string
|
retention policy is how long the bucket would last
Applicable when influx_version is 'V_1_8'
|
|||
wallet_password_secret_id
string
|
wallet password Secret ID in String format
Applicable when data_source_type is 'ORACLE_ATP'
|
|||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
|||
description
string
|
A short description of the Ai data asset
This parameter is updatable.
|
|||
display_name
string
|
A user-friendly display name for the resource. It does not have to be unique and can be modified. 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 |
|||
force_create
boolean
|
|
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
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
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.
|
|||
private_endpoint_id
string
|
OCID of Private Endpoint.
|
|||
project_id
string
|
The OCID of the project to associate with the data asset.
Required for create using state=present.
|
|||
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
|||
state
string
|
|
The state of the DataAsset.
Use state=present to create or update a DataAsset.
Use state=absent to delete a DataAsset.
|
||
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
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create data_asset
oci_ai_anomaly_detection_data_asset:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
data_source_details:
# required
data_source_type: ORACLE_OBJECT_STORAGE
# optional
namespace: namespace_example
bucket_name: bucket_name_example
object_name: object_name_example
# optional
private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update data_asset
oci_ai_anomaly_detection_data_asset:
# required
data_asset_id: "ocid1.dataasset.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update data_asset using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_ai_anomaly_detection_data_asset:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete data_asset
oci_ai_anomaly_detection_data_asset:
# required
data_asset_id: "ocid1.dataasset.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete data_asset using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_ai_anomaly_detection_data_asset:
# 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:
Authors¶
Oracle (@oracle)