oracle / oracle.oci / 4.21.0 / module / oci_object_storage_retention_rule Manage a RetentionRule resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_object_storage_retention_rule (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
This module allows the user to create, update and delete a RetentionRule resource in Oracle Cloud Infrastructure
For I(state=present), creates a new retention rule in the specified bucket. The new rule will take effect typically within 30 seconds. Note that a maximum of 100 rules are supported on a bucket.
- name: Create retention_rule oci_object_storage_retention_rule: # required namespace_name: namespace_name_example bucket_name: bucket_name_example # optional display_name: display_name_example duration: # required time_amount: 56 time_unit: YEARS time_rule_locked: time_rule_locked_example
- name: Update retention_rule oci_object_storage_retention_rule: # required namespace_name: namespace_name_example bucket_name: bucket_name_example retention_rule_id: "ocid1.retentionrule.oc1..xxxxxxEXAMPLExxxxxx" # optional display_name: display_name_example duration: # required time_amount: 56 time_unit: YEARS time_rule_locked: time_rule_locked_example
- name: Update retention_rule using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_object_storage_retention_rule: # required display_name: display_name_example namespace_name: namespace_name_example bucket_name: bucket_name_example # optional duration: # required time_amount: 56 time_unit: YEARS time_rule_locked: time_rule_locked_example
- name: Delete retention_rule oci_object_storage_retention_rule: # required namespace_name: namespace_name_example bucket_name: bucket_name_example retention_rule_id: "ocid1.retentionrule.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete retention_rule using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_object_storage_retention_rule: # required display_name: display_name_example namespace_name: namespace_name_example bucket_name: bucket_name_example state: absent
state: choices: - present - absent default: present description: - The state of the RetentionRule. - Use I(state=present) to create or update a RetentionRule. - Use I(state=absent) to delete a RetentionRule. required: false type: str key_by: description: 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. elements: str type: list region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str duration: description: - '' - This parameter is updatable. suboptions: time_amount: description: - The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation to each object's Last-Modified timestamp. required: true type: int time_unit: choices: - YEARS - DAYS description: - The unit that should be used to interpret timeAmount. required: true type: str type: dict auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str bucket_name: description: - 'The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1`' required: true type: str cert_bundle: description: - 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. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str display_name: aliases: - name description: - A user-specified name for the retention rule. Names can be helpful in identifying retention rules. Avoid entering confidential information. - Required for create, update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str force_create: default: false description: 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 I(key_by). type: bool namespace_name: description: - The Object Storage namespace used for the request. required: true type: str time_rule_locked: description: - The date and time as per L(RFC 3339,https://tools.ietf.org/html/rfc3339) after which this rule is locked and can only be deleted by deleting the bucket. Once a rule is locked, only increases in the duration are allowed and no other properties can be changed. This property cannot be updated for rules that are in a locked state. Specifying it when a duration is not specified is considered an error. - This parameter is updatable. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str retention_rule_id: aliases: - id description: - The ID of the retention rule. - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - 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. type: bool
retention_rule: contains: display_name: description: - User specified name for the retention rule. returned: on success sample: display_name_example type: str duration: contains: time_amount: description: - The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation to each object's Last-Modified timestamp. returned: on success sample: 56 type: int time_unit: description: - The unit that should be used to interpret timeAmount. returned: on success sample: YEARS type: str description: - '' returned: on success type: complex etag: description: - The entity tag (ETag) for the retention rule. returned: on success sample: etag_example type: str id: description: - Unique identifier for the retention rule. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str time_created: description: - The date and time that the retention rule was created as per L(RFC3339,https://tools.ietf.org/html/rfc3339). returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_modified: description: - The date and time that the retention rule was modified as per L(RFC3339,https://tools.ietf.org/html/rfc3339). returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_rule_locked: description: - The date and time as per L(RFC 3339,https://tools.ietf.org/html/rfc3339) after which this rule becomes locked. and can only be deleted by deleting the bucket. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - Details of the RetentionRule resource acted upon by the current operation returned: on success sample: display_name: display_name_example duration: time_amount: 56 time_unit: YEARS etag: etag_example id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx time_created: '2013-10-20T19:20:30+01:00' time_modified: '2013-10-20T19:20:30+01:00' time_rule_locked: '2013-10-20T19:20:30+01:00' type: complex