oracle.oci.oci_data_catalog_custom_property – Manage a CustomProperty resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_data_catalog_custom_property.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, create a new Custom Property

Requirements

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

Parameters

Parameter Choices/Defaults Comments
allowed_values
list / elements=string
Allowed values for the custom property if any
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
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.
catalog_id
string / required
Unique catalog identifier.
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.
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.
custom_property_key
string
Unique Custom Property key
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.
data_type
string
    Choices:
  • TEXT
  • RICH_TEXT
  • BOOLEAN
  • NUMBER
  • DATE
The data type of the custom property
description
string
Detailed description of the custom property.
This parameter is updatable.
display_name
string
A user-friendly display name. Does not have to be unique, and it's changeable. 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.
is_editable
boolean
    Choices:
  • no
  • yes
If this field is a editable field
This parameter is updatable.
is_event_enabled
boolean
    Choices:
  • no
  • yes
If an OCI Event will be emitted when the custom property is modified.
This parameter is updatable.
is_filterable
boolean
    Choices:
  • no
  • yes
If this field allows to filter or create facets from UI
This parameter is updatable.
is_hidden
boolean
    Choices:
  • no
  • yes
If this field is a hidden field
This parameter is updatable.
is_hidden_in_search
boolean
    Choices:
  • no
  • yes
If this field is allowed to pop in search results
This parameter is updatable.
is_multi_valued
boolean
    Choices:
  • no
  • yes
If this field allows multiple values to be set
This parameter is updatable.
is_shown_in_list
boolean
    Choices:
  • no
  • yes
If this field is displayed in a list view of applicable objects.
This parameter is updatable.
is_sortable
boolean
    Choices:
  • no
  • yes
If this field allows to sort from UI
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.
namespace_id
string / required
Unique namespace identifier.
properties
dictionary
A map of maps that contains the properties which are specific to the data asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. To determine the set of optional and required properties for a data asset type, a query can be done on '/types?type=dataAsset' that returns a collection of all data asset types. The appropriate data asset type, which includes definitions of all of it's properties, can be identified from this collection. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
This parameter is updatable.
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
    Choices:
  • present ←
  • absent
The state of the CustomProperty.
Use state=present to create or update a CustomProperty.
Use state=absent to delete a CustomProperty.
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 custom_property
  oci_data_catalog_custom_property:
    # required
    display_name: display_name_example
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    namespace_id: "ocid1.namespace.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    data_type: TEXT
    description: description_example
    is_sortable: true
    is_filterable: true
    is_multi_valued: true
    is_hidden: true
    is_editable: true
    is_shown_in_list: true
    is_hidden_in_search: true
    is_event_enabled: true
    allowed_values: [ "allowed_values_example" ]
    properties: null

- name: Update custom_property
  oci_data_catalog_custom_property:
    # required
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    namespace_id: "ocid1.namespace.oc1..xxxxxxEXAMPLExxxxxx"
    custom_property_key: custom_property_key_example

    # optional
    display_name: display_name_example
    description: description_example
    is_sortable: true
    is_filterable: true
    is_multi_valued: true
    is_hidden: true
    is_editable: true
    is_shown_in_list: true
    is_hidden_in_search: true
    is_event_enabled: true
    allowed_values: [ "allowed_values_example" ]
    properties: null

- name: Update custom_property using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_data_catalog_custom_property:
    # required
    display_name: display_name_example
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    namespace_id: "ocid1.namespace.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    description: description_example
    is_sortable: true
    is_filterable: true
    is_multi_valued: true
    is_hidden: true
    is_editable: true
    is_shown_in_list: true
    is_hidden_in_search: true
    is_event_enabled: true
    allowed_values: [ "allowed_values_example" ]
    properties: null

- name: Delete custom_property
  oci_data_catalog_custom_property:
    # required
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    namespace_id: "ocid1.namespace.oc1..xxxxxxEXAMPLExxxxxx"
    custom_property_key: custom_property_key_example
    state: absent

- name: Delete custom_property using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_data_catalog_custom_property:
    # required
    display_name: display_name_example
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    namespace_id: "ocid1.namespace.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
custom_property
complex
on success
Details of the CustomProperty resource acted upon by the current operation

Sample:
{'allowed_values': [], 'created_by_id': 'ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx', 'data_type': 'TEXT', 'description': 'description_example', 'display_name': 'display_name_example', 'events': [{'created_by_id': 'ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx', 'event_config_status': 'ENABLED', 'property_id': 'ocid1.property.oc1..xxxxxxEXAMPLExxxxxx', 'property_name': 'property_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type_id': 'ocid1.type.oc1..xxxxxxEXAMPLExxxxxx', 'type_name': 'type_name_example', 'updated_by_id': 'ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx'}], 'is_editable': True, 'is_event_enabled': True, 'is_filterable': True, 'is_hidden': True, 'is_hidden_in_search': True, 'is_list_type': True, 'is_multi_valued': True, 'is_service_defined': True, 'is_shown_in_list': True, 'is_sortable': True, 'key': 'key_example', 'lifecycle_state': 'CREATING', 'namespace_name': 'namespace_name_example', 'properties': {}, 'scope': [{'count': 56, 'is_event_enabled': True, 'type_id': 'ocid1.type.oc1..xxxxxxEXAMPLExxxxxx', 'type_name': 'type_name_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'updated_by_id': 'ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx', 'usage_count': 56}
 
allowed_values
list / elements=string
on success
Allowed values for the custom property if any

 
created_by_id
string
on success
OCID of the user who created the custom property.

Sample:
ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx
 
data_type
string
on success
Data type of the custom property

Sample:
TEXT
 
description
string
on success
Description for the custom property

Sample:
description_example
 
display_name
string
on success
Display name of the custom property

Sample:
display_name_example
 
events
complex
on success
Event configuration for this custom property, against the desired subset of object types to which the property applies.

   
created_by_id
string
on success
OCID of the user who created the configuration.

Sample:
ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx
   
event_config_status
string
on success
Status of the configuration.

Sample:
ENABLED
   
property_id
string
on success
Unique property key identifier.

Sample:
ocid1.property.oc1..xxxxxxEXAMPLExxxxxx
   
property_name
string
on success
Name of the property.

Sample:
property_name_example
   
time_created
string
on success
The date and time the event was configured, in the format defined by RFC3339. Example: `2019-03-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
   
time_updated
string
on success
The last time that any change was made to the configuration. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
   
type_id
string
on success
Unique type key identifier.

Sample:
ocid1.type.oc1..xxxxxxEXAMPLExxxxxx
   
type_name
string
on success
Name of the type.

Sample:
type_name_example
   
updated_by_id
string
on success
OCID of the user who last modified the configuration.

Sample:
ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx
 
is_editable
boolean
on success
If this field is a editable field

Sample:
True
 
is_event_enabled
boolean
on success
If an OCI Event will be emitted when the custom property is modified.

Sample:
True
 
is_filterable
boolean
on success
If this field allows to filter or create facets from UI

Sample:
True
 
is_hidden
boolean
on success
If this field is a hidden field

Sample:
True
  is_hidden_in_search
boolean
on success
If this field is allowed to pop in search results

Sample:
True
 
is_list_type
boolean
on success
Is this property allowed to have list of values

Sample:
True
 
is_multi_valued
boolean
on success
If this field allows multiple values to be set

Sample:
True
 
is_service_defined
boolean
on success
If this field is defined by service or by a user

Sample:
True
 
is_shown_in_list
boolean
on success
If this field is displayed in a list view of applicable objects.

Sample:
True
 
is_sortable
boolean
on success
If this field allows to sort from UI

Sample:
True
 
key
string
on success
Unique data asset key that is immutable.

Sample:
key_example
 
lifecycle_state
string
on success
The current state of the custom property.

Sample:
CREATING
 
namespace_name
string
on success
Namespace name of the custom property

Sample:
namespace_name_example
 
properties
dictionary
on success
A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

 
scope
complex
on success
The set of object types to which the custom property applies.

   
count
integer
on success
Number of objects associated with this type

Sample:
56
   
is_event_enabled
boolean
on success
If an OCI Event will be emitted when the custom property is modified.

Sample:
True
   
type_id
string
on success
Unique type key identifier

Sample:
ocid1.type.oc1..xxxxxxEXAMPLExxxxxx
   
type_name
string
on success
Name of the type associated with

Sample:
type_name_example
 
time_created
string
on success
The date and time the custom property was created, in the format defined by RFC3339. Example: `2019-03-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The last time that any change was made to the custom property. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
updated_by_id
string
on success
OCID of the user who last modified the custom property.

Sample:
ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx
 
usage_count
integer
on success
Total number of first class objects using this custom property

Sample:
56


Authors

  • Oracle (@oracle)