oracle.oci.oci_functions_function – Manage a Function 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_functions_function.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new function.

  • This resource has the following action operations in the oracle.oci.oci_functions_function_actions module: invoke.

Requirements

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

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).
application_id
string
The OCID of the application this function belongs to.
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.
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.
config
dictionary
Function configuration. These values are passed on to the function as environment variables, this overrides application configuration values. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.
Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}`
The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.
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.
display_name
string
The display name of the function. The display name must be unique within the application containing the function. Avoid entering confidential information.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is 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. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
function_id
string
The OCID of this function.
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
image
string
The qualified name of the Docker image to use in the function, including the image tag. The image should be in the OCI Registry that is in the same region as the function itself. Example: `phx.ocir.io/ten/functions/function:0.0.1`
This parameter is updatable.
image_digest
string
The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the OCI Registry will be used. Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7`
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.
memory_in_mbs
integer
Maximum usable memory for the function (MiB).
Required for create using state=present.
This parameter is updatable.
provisioned_concurrency_config
dictionary
This parameter is updatable.
count
integer
Configuration specifying a constant amount of provisioned concurrency.
Required when strategy is 'CONSTANT'
strategy
string / required
    Choices:
  • NONE
  • CONSTANT
The strategy for provisioned concurrency to be used.
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.
source_details
dictionary
pbf_listing_id
string / required
The OCID of the PbfListing this function is sourced from.
source_type
string / required
    Choices:
  • PRE_BUILT_FUNCTIONS
Type of the Function Source. Possible values: PBF.
state
string
    Choices:
  • present ←
  • absent
The state of the Function.
Use state=present to create or update a Function.
Use state=absent to delete a Function.
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
timeout_in_seconds
integer
Timeout for executions of the function. Value in seconds.
This parameter is updatable.
trace_config
dictionary
This parameter is updatable.
is_enabled
boolean
    Choices:
  • no
  • yes
Define if tracing is enabled for the resource.
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 function
  oci_functions_function:
    # required
    display_name: display_name_example
    application_id: "ocid1.application.oc1..xxxxxxEXAMPLExxxxxx"
    memory_in_mbs: 56

    # optional
    source_details:
      # required
      source_type: PRE_BUILT_FUNCTIONS
      pbf_listing_id: "ocid1.pbflisting.oc1..xxxxxxEXAMPLExxxxxx"
    image: image_example
    image_digest: image_digest_example
    config: null
    timeout_in_seconds: 56
    provisioned_concurrency_config:
      # required
      strategy: NONE
    trace_config:
      # optional
      is_enabled: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update function
  oci_functions_function:
    # required
    function_id: "ocid1.function.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    image: image_example
    image_digest: image_digest_example
    memory_in_mbs: 56
    config: null
    timeout_in_seconds: 56
    provisioned_concurrency_config:
      # required
      strategy: NONE
    trace_config:
      # optional
      is_enabled: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update function using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_functions_function:
    # required
    display_name: display_name_example
    application_id: "ocid1.application.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    image: image_example
    image_digest: image_digest_example
    memory_in_mbs: 56
    config: null
    timeout_in_seconds: 56
    provisioned_concurrency_config:
      # required
      strategy: NONE
    trace_config:
      # optional
      is_enabled: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete function
  oci_functions_function:
    # required
    function_id: "ocid1.function.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete function using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_functions_function:
    # required
    display_name: display_name_example
    application_id: "ocid1.application.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
function
complex
on success
Details of the Function resource acted upon by the current operation

Sample:
{'application_id': 'ocid1.application.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'config': {}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'image': 'image_example', 'image_digest': 'image_digest_example', 'invoke_endpoint': 'invoke_endpoint_example', 'lifecycle_state': 'CREATING', 'memory_in_mbs': 56, 'provisioned_concurrency_config': {'count': 56, 'strategy': 'CONSTANT'}, 'shape': 'GENERIC_X86', 'source_details': {'pbf_listing_id': 'ocid1.pbflisting.oc1..xxxxxxEXAMPLExxxxxx', 'source_type': 'PRE_BUILT_FUNCTIONS'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'timeout_in_seconds': 56, 'trace_config': {'is_enabled': True}}
 
application_id
string
on success
The OCID of the application the function belongs to.

Sample:
ocid1.application.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the compartment that contains the function.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
config
dictionary
on success
Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.
Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}`
The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.
 
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'}}
 
display_name
string
on success
The display name of the function. The display name is unique within the application containing the function.

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 function.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
image
string
on success
The qualified name of the Docker image to use in the function, including the image tag. The image should be in the OCI Registry that is in the same region as the function itself. Example: `phx.ocir.io/ten/functions/function:0.0.1`

Sample:
image_example
 
image_digest
string
on success
The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the OCI Registry will be used. Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7`

Sample:
image_digest_example
 
invoke_endpoint
string
on success
The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.

Sample:
invoke_endpoint_example
 
lifecycle_state
string
on success
The current state of the function.

Sample:
CREATING
 
memory_in_mbs
integer
on success
Maximum usable memory for the function (MiB).

Sample:
56
 
provisioned_concurrency_config
complex
on success

   
count
integer
on success
Configuration specifying a constant amount of provisioned concurrency.

Sample:
56
   
strategy
string
on success
The strategy for provisioned concurrency to be used.

Sample:
CONSTANT
 
shape
string
on success
The processor shape (`GENERIC_X86`/`GENERIC_ARM`) on which to run functions in the application, extracted from the image manifest.

Sample:
GENERIC_X86
 
source_details
complex
on success

   
pbf_listing_id
string
on success
The OCID of the PbfListing this function is sourced from.

Sample:
ocid1.pbflisting.oc1..xxxxxxEXAMPLExxxxxx
   
source_type
string
on success
Type of the Function Source. Possible values: PBF.

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

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the function was updated, expressed in RFC 3339 timestamp format.
Example: `2018-09-12T22:47:12.613Z`

Sample:
2013-10-20T19:20:30+01:00
 
timeout_in_seconds
integer
on success
Timeout for executions of the function. Value in seconds.

Sample:
56
 
trace_config
complex
on success

   
is_enabled
boolean
on success
Define if tracing is enabled for the resource.

Sample:
True


Authors

  • Oracle (@oracle)