configurations
Creates, updates, deletes, gets or lists a configurations resource.
Overview​
| Name | configurations |
| Type | Resource |
| Id | oci.audit.configurations |
Fields​
The following fields are returned by SELECT queries:
- get
The configuration properties
| Name | Datatype | Description |
|---|---|---|
retentionPeriodDays | integer | The retention period setting, specified in days. The minimum is 90, the maximum 365. Example: 90 |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | compartmentId, region | Get the configuration | |
update | update | compartmentId, region, retentionPeriodDays | Update the configuration |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
compartmentId | string | ID of the root compartment (tenancy) |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
SELECT examples​
- get
Get the configuration
SELECT
retentionPeriodDays
FROM oci.audit.configurations
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples​
- update
Update the configuration
UPDATE oci.audit.configurations
SET
retentionPeriodDays = {{ retentionPeriodDays }}
WHERE
compartmentId = '{{ compartmentId }}' --required
AND region = '{{ region }}' --required
AND retentionPeriodDays = '{{ retentionPeriodDays }}' --required;