oracle.oci.oci_apigateway_usage_plan – Manage an UsagePlan 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_apigateway_usage_plan.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new usage plan.

  • This resource has the following action operations in the oracle.oci.oci_apigateway_usage_plan_actions module: change_compartment.

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).
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.
compartment_id
string
The OCID of the compartment in which the resource is created.
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.
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Example: `My new resource`
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
entitlements
list / elements=dictionary
A collection of entitlements to assign to the newly created usage plan.
Required for create using state=present.
This parameter is updatable.
description
string
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
name
string / required
An entitlement name, unique within a usage plan.
quota
dictionary
operation_on_breach
string / required
    Choices:
  • REJECT
  • ALLOW
What the usage plan will do when a quota is breached: `REJECT` will allow no further requests `ALLOW` will continue to allow further requests
reset_policy
string / required
    Choices:
  • CALENDAR
The policy that controls when quotas will reset. Example: `CALENDAR`
unit
string / required
    Choices:
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
The unit of time over which quotas are calculated. Example: `MINUTE` or `MONTH`
value
integer / required
The number of requests that can be made per time period.
rate_limit
dictionary
unit
string / required
    Choices:
  • SECOND
The unit of time over which rate limits are calculated. Example: `SECOND`
value
integer / required
The number of requests that can be made per time period.
targets
list / elements=dictionary
A collection of targeted deployments that the entitlement will be applied to.
deployment_id
string / required
The OCID of a deployment resource.
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.
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.
state
string
    Choices:
  • present ←
  • absent
The state of the UsagePlan.
Use state=present to create or update an UsagePlan.
Use state=absent to delete an UsagePlan.
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
usage_plan_id
string
The ocid of the usage plan.
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
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 usage_plan
  oci_apigateway_usage_plan:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    entitlements:
    - # required
      name: name_example

      # optional
      description: description_example
      rate_limit:
        # required
        value: 56
        unit: SECOND
      quota:
        # required
        value: 56
        unit: MINUTE
        reset_policy: CALENDAR
        operation_on_breach: REJECT
      targets:
      - # required
        deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update usage_plan
  oci_apigateway_usage_plan:
    # required
    usage_plan_id: "ocid1.usageplan.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    entitlements:
    - # required
      name: name_example

      # optional
      description: description_example
      rate_limit:
        # required
        value: 56
        unit: SECOND
      quota:
        # required
        value: 56
        unit: MINUTE
        reset_policy: CALENDAR
        operation_on_breach: REJECT
      targets:
      - # required
        deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

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

    # optional
    entitlements:
    - # required
      name: name_example

      # optional
      description: description_example
      rate_limit:
        # required
        value: 56
        unit: SECOND
      quota:
        # required
        value: 56
        unit: MINUTE
        reset_policy: CALENDAR
        operation_on_breach: REJECT
      targets:
      - # required
        deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete usage_plan
  oci_apigateway_usage_plan:
    # required
    usage_plan_id: "ocid1.usageplan.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

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

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'entitlements': [{'description': 'description_example', 'name': 'name_example', 'quota': {'operation_on_breach': 'REJECT', 'reset_policy': 'CALENDAR', 'unit': 'MINUTE', 'value': 56}, 'rate_limit': {'unit': 'SECOND', 'value': 56}, 'targets': [{'deployment_id': 'ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx'}]}], 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
The OCID of the compartment in which the resource is created.

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'}}
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Example: `My new resource`

Sample:
display_name_example
 
entitlements
complex
on success
A collection of entitlements currently assigned to the usage plan.
   
description
string
on success
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Sample:
description_example
   
name
string
on success
An entitlement name, unique within a usage plan.

Sample:
name_example
   
quota
complex
on success

     
operation_on_breach
string
on success
What the usage plan will do when a quota is breached: `REJECT` will allow no further requests `ALLOW` will continue to allow further requests

Sample:
REJECT
     
reset_policy
string
on success
The policy that controls when quotas will reset. Example: `CALENDAR`

Sample:
CALENDAR
     
unit
string
on success
The unit of time over which quotas are calculated. Example: `MINUTE` or `MONTH`

Sample:
MINUTE
     
value
integer
on success
The number of requests that can be made per time period.

Sample:
56
   
rate_limit
complex
on success

     
unit
string
on success
The unit of time over which rate limits are calculated. Example: `SECOND`

Sample:
SECOND
     
value
integer
on success
The number of requests that can be made per time period.

Sample:
56
   
targets
complex
on success
A collection of targeted deployments that the entitlement will be applied to.
     
deployment_id
string
on success
The OCID of a deployment resource.

Sample:
ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx
 
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 a usage plan resource.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the usage plan.

Sample:
CREATING
 
time_created
string
on success
The time this resource was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time this resource was last updated. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)