oracle.oci.oci_database_autonomous_container_database – Manage an AutonomousContainerDatabase 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_database_autonomous_container_database.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.

  • This resource has the following action operations in the oracle.oci.oci_database_autonomous_container_database_actions module: change_compartment, restart, rotate_autonomous_container_database_encryption_key.

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
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.
autonomous_container_database_id
string
The Autonomous Container Database OCID.
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
autonomous_exadata_infrastructure_id
string
**No longer used.** This parameter is no longer used for Autonomous Database on dedicated Exadata infrasture. Specify a `cloudAutonomousVmClusterId` instead. Using this parameter will cause the operation to fail.
autonomous_vm_cluster_id
string
The OCID of the Autonomous VM Cluster.
backup_config
dictionary
This parameter is updatable.
backup_destination_details
list / elements=dictionary
Backup destination details.
id
string
The OCID of the backup destination.
internet_proxy
string
Proxy URL to connect to object store.
type
string / required
    Choices:
  • NFS
  • RECOVERY_APPLIANCE
  • OBJECT_STORE
  • LOCAL
Type of the database backup destination.
vpc_password
string
For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpc_user
string
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
recovery_window_in_days
integer
Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
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.
cloud_autonomous_vm_cluster_id
string
The OCID of the cloud Autonomous Exadata VM Cluster.
compartment_id
string
The OCID of the compartment containing the Autonomous Container Database.
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.
db_unique_name
string
**Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
This parameter is updatable.
display_name
string
The display name for the Autonomous Container Database.
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.
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.
is_automatic_failover_enabled
boolean
    Choices:
  • no
  • yes
Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association
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.
key_store_id
string
The OCID of the key store.
kms_key_id
string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kms_key_version_id
string
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
maintenance_window_details
dictionary
This parameter is updatable.
custom_action_timeout_in_mins
integer
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
days_of_week
list / elements=dictionary
Days during the week when maintenance should be performed.
name
string / required
    Choices:
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY
Name of the day of the week.
hours_of_day
list / elements=integer
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
is_custom_action_timeout_enabled
boolean
    Choices:
  • no
  • yes
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
is_monthly_patching_enabled
boolean
    Choices:
  • no
  • yes
If true, enables the monthly patching option.
lead_time_in_weeks
integer
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
months
list / elements=dictionary
Months during the year when maintenance should be performed.
name
string / required
    Choices:
  • JANUARY
  • FEBRUARY
  • MARCH
  • APRIL
  • MAY
  • JUNE
  • JULY
  • AUGUST
  • SEPTEMBER
  • OCTOBER
  • NOVEMBER
  • DECEMBER
Name of the month of the year.
patching_mode
string
    Choices:
  • ROLLING
  • NONROLLING
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
*IMPORTANT*: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.
preference
string
    Choices:
  • NO_PREFERENCE
  • CUSTOM_PREFERENCE
The maintenance window scheduling preference.
weeks_of_month
list / elements=integer
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
patch_model
string
    Choices:
  • RELEASE_UPDATES
  • RELEASE_UPDATE_REVISIONS
Database Patch model preference.
Required for create using state=present.
This parameter is updatable.
peer_autonomous_container_database_backup_config
dictionary
backup_destination_details
list / elements=dictionary
Backup destination details.
id
string
The OCID of the backup destination.
internet_proxy
string
Proxy URL to connect to object store.
type
string / required
    Choices:
  • NFS
  • RECOVERY_APPLIANCE
  • OBJECT_STORE
  • LOCAL
Type of the database backup destination.
vpc_password
string
For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpc_user
string
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
recovery_window_in_days
integer
Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
peer_autonomous_container_database_compartment_id
string
The OCID of the compartment where the standby Autonomous Container Database will be created.
peer_autonomous_container_database_display_name
string
The display name for the peer Autonomous Container Database.
peer_autonomous_exadata_infrastructure_id
string
*No longer used.* This parameter is no longer used for Autonomous Database on dedicated Exadata infrasture. Specify a `peerCloudAutonomousVmClusterId` instead. Using this parameter will cause the operation to fail.
peer_autonomous_vm_cluster_id
string
The OCID of the peer Autonomous VM cluster for Autonomous Data Guard. Required to enable Data Guard.
peer_cloud_autonomous_vm_cluster_id
string
The OCID of the peer cloud Autonomous Exadata VM Cluster.
peer_db_unique_name
string
**Deprecated.** The `DB_UNIQUE_NAME` of the peer Autonomous Container Database in a Data Guard association is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.
protection_mode
string
    Choices:
  • MAXIMUM_AVAILABILITY
  • MAXIMUM_PERFORMANCE
The protection mode of this Autonomous Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
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.
service_level_agreement_type
string
    Choices:
  • STANDARD
  • AUTONOMOUS_DATAGUARD
The service level agreement type of the Autonomous Container Database. The default is STANDARD. For an autonomous dataguard Autonomous Container Database, the specified Autonomous Exadata Infrastructure must be associated with a remote Autonomous Exadata Infrastructure.
standby_maintenance_buffer_in_days
integer
The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the AutonomousContainerDatabase.
Use state=present to create or update an AutonomousContainerDatabase.
Use state=absent to delete an AutonomousContainerDatabase.
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
vault_id
string
The OCID of the Oracle Cloud Infrastructure vault.
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 autonomous_container_database
  oci_database_autonomous_container_database:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    patch_model: RELEASE_UPDATES

    # optional
    db_unique_name: db_unique_name_example
    service_level_agreement_type: STANDARD
    autonomous_exadata_infrastructure_id: "ocid1.autonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
    peer_autonomous_exadata_infrastructure_id: "ocid1.peerautonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
    peer_autonomous_container_database_display_name: peer_autonomous_container_database_display_name_example
    protection_mode: MAXIMUM_AVAILABILITY
    is_automatic_failover_enabled: true
    peer_cloud_autonomous_vm_cluster_id: "ocid1.peercloudautonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx"
    peer_autonomous_vm_cluster_id: "ocid1.peerautonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx"
    peer_autonomous_container_database_compartment_id: "ocid1.peerautonomouscontainerdatabasecompartment.oc1..xxxxxxEXAMPLExxxxxx"
    peer_autonomous_container_database_backup_config:
      # optional
      backup_destination_details:
      - # required
        type: NFS

        # optional
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
        vpc_user: vpc_user_example
        vpc_password: example-password
        internet_proxy: internet_proxy_example
      recovery_window_in_days: 56
    peer_db_unique_name: peer_db_unique_name_example
    autonomous_vm_cluster_id: "ocid1.autonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx"
    cloud_autonomous_vm_cluster_id: "ocid1.cloudautonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx"
    kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
    kms_key_version_id: "ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx"
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_store_id: "ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx"
    maintenance_window_details:
      # optional
      preference: NO_PREFERENCE
      patching_mode: ROLLING
      is_custom_action_timeout_enabled: true
      custom_action_timeout_in_mins: 56
      is_monthly_patching_enabled: true
      months:
      - # required
        name: JANUARY
      weeks_of_month: [ "weeks_of_month_example" ]
      days_of_week:
      - # required
        name: MONDAY
      hours_of_day: [ "hours_of_day_example" ]
      lead_time_in_weeks: 56
    standby_maintenance_buffer_in_days: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    backup_config:
      # optional
      backup_destination_details:
      - # required
        type: NFS

        # optional
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
        vpc_user: vpc_user_example
        vpc_password: example-password
        internet_proxy: internet_proxy_example
      recovery_window_in_days: 56

- name: Update autonomous_container_database
  oci_database_autonomous_container_database:
    # required
    autonomous_container_database_id: "ocid1.autonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    patch_model: RELEASE_UPDATES
    maintenance_window_details:
      # optional
      preference: NO_PREFERENCE
      patching_mode: ROLLING
      is_custom_action_timeout_enabled: true
      custom_action_timeout_in_mins: 56
      is_monthly_patching_enabled: true
      months:
      - # required
        name: JANUARY
      weeks_of_month: [ "weeks_of_month_example" ]
      days_of_week:
      - # required
        name: MONDAY
      hours_of_day: [ "hours_of_day_example" ]
      lead_time_in_weeks: 56
    standby_maintenance_buffer_in_days: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    backup_config:
      # optional
      backup_destination_details:
      - # required
        type: NFS

        # optional
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
        vpc_user: vpc_user_example
        vpc_password: example-password
        internet_proxy: internet_proxy_example
      recovery_window_in_days: 56

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

    # optional
    patch_model: RELEASE_UPDATES
    maintenance_window_details:
      # optional
      preference: NO_PREFERENCE
      patching_mode: ROLLING
      is_custom_action_timeout_enabled: true
      custom_action_timeout_in_mins: 56
      is_monthly_patching_enabled: true
      months:
      - # required
        name: JANUARY
      weeks_of_month: [ "weeks_of_month_example" ]
      days_of_week:
      - # required
        name: MONDAY
      hours_of_day: [ "hours_of_day_example" ]
      lead_time_in_weeks: 56
    standby_maintenance_buffer_in_days: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    backup_config:
      # optional
      backup_destination_details:
      - # required
        type: NFS

        # optional
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
        vpc_user: vpc_user_example
        vpc_password: example-password
        internet_proxy: internet_proxy_example
      recovery_window_in_days: 56

- name: Delete autonomous_container_database
  oci_database_autonomous_container_database:
    # required
    autonomous_container_database_id: "ocid1.autonomouscontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

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

Sample:
{'autonomous_exadata_infrastructure_id': 'ocid1.autonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx', 'autonomous_vm_cluster_id': 'ocid1.autonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx', 'availability_domain': 'Uocm:PHX-AD-1', 'available_cpus': 3.4, 'backup_config': {'backup_destination_details': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'internet_proxy': 'internet_proxy_example', 'type': 'NFS', 'vpc_password': 'example-password', 'vpc_user': 'vpc_user_example'}], 'recovery_window_in_days': 56}, 'cloud_autonomous_vm_cluster_id': 'ocid1.cloudautonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'db_unique_name': 'db_unique_name_example', 'db_version': 'db_version_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'infrastructure_type': 'CLOUD', 'key_history_entry': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'kms_key_version_id': 'ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx', 'time_activated': '2013-10-20T19:20:30+01:00', 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx'}], 'key_store_id': 'ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx', 'key_store_wallet_name': 'key_store_wallet_name_example', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'kms_key_version_id': 'ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx', 'last_maintenance_run_id': 'ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'maintenance_window': {'custom_action_timeout_in_mins': 56, 'days_of_week': [{'name': 'MONDAY'}], 'hours_of_day': [], 'is_custom_action_timeout_enabled': True, 'is_monthly_patching_enabled': True, 'lead_time_in_weeks': 56, 'months': [{'name': 'JANUARY'}], 'patching_mode': 'ROLLING', 'preference': 'NO_PREFERENCE', 'weeks_of_month': []}, 'memory_per_oracle_compute_unit_in_gbs': 56, 'next_maintenance_run_id': 'ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx', 'patch_id': 'ocid1.patch.oc1..xxxxxxEXAMPLExxxxxx', 'patch_model': 'RELEASE_UPDATES', 'provisionable_cpus': [], 'reclaimable_cpus': 3.4, 'role': 'PRIMARY', 'service_level_agreement_type': 'STANDARD', 'standby_maintenance_buffer_in_days': 56, 'time_created': '2013-10-20T19:20:30+01:00', 'total_cpus': 56, 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx'}
 
autonomous_exadata_infrastructure_id
string
on success
**No longer used.** For Autonomous Database on dedicated Exadata infrastructure, the container database is created within a specified `cloudAutonomousVmCluster`.

Sample:
ocid1.autonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
 
autonomous_vm_cluster_id
string
on success
The OCID of the Autonomous VM Cluster.

Sample:
ocid1.autonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx
 
availability_domain
string
on success
The availability domain of the Autonomous Container Database.

Sample:
Uocm:PHX-AD-1
 
available_cpus
float
on success
Sum of OCPUs available on the Autonomous VM Cluster + Sum of reclaimable OCPUs available in the Autonomous Container Database.

Sample:
3.4
 
backup_config
complex
on success

   
backup_destination_details
complex
on success
Backup destination details.

     
id
string
on success
The OCID of the backup destination.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
     
internet_proxy
string
on success
Proxy URL to connect to object store.

Sample:
internet_proxy_example
     
type
string
on success
Type of the database backup destination.

Sample:
NFS
     
vpc_password
string
on success
For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.

Sample:
example-password
     
vpc_user
string
on success
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

Sample:
vpc_user_example
   
recovery_window_in_days
integer
on success
Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

Sample:
56
 
cloud_autonomous_vm_cluster_id
string
on success
The OCID of the cloud Autonomous Exadata VM Cluster.

Sample:
ocid1.cloudautonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
db_unique_name
string
on success
**Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.

Sample:
db_unique_name_example
 
db_version
string
on success
Oracle Database version of the Autonomous Container Database.

Sample:
db_version_example
 
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.

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The user-provided name for the Autonomous Container Database.

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 Autonomous Container Database.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
infrastructure_type
string
on success
The infrastructure type this resource belongs to.

Sample:
CLOUD
 
key_history_entry
complex
on success
Key History Entry.

   
id
string
on success
The id of the Autonomous Database Vault service key management history entry.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
kms_key_version_id
string
on success
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

Sample:
ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx
   
time_activated
string
on success
The date and time the kms key activated.

Sample:
2013-10-20T19:20:30+01:00
   
vault_id
string
on success
The OCID of the Oracle Cloud Infrastructure vault.

Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
 
key_store_id
string
on success
The OCID of the key store.

Sample:
ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx
 
key_store_wallet_name
string
on success
The wallet name for Oracle Key Vault.

Sample:
key_store_wallet_name_example
 
kms_key_id
string
on success
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
kms_key_version_id
string
on success
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

Sample:
ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx
 
last_maintenance_run_id
string
on success
The OCID of the last maintenance run.

Sample:
ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Additional information about the current lifecycle state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the Autonomous Container Database.

Sample:
PROVISIONING
 
maintenance_window
complex
on success

   
custom_action_timeout_in_mins
integer
on success
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).

Sample:
56
   
days_of_week
complex
on success
Days during the week when maintenance should be performed.

     
name
string
on success
Name of the day of the week.

Sample:
MONDAY
   
hours_of_day
list / elements=string
on success
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

   
is_custom_action_timeout_enabled
boolean
on success
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

Sample:
True
   
is_monthly_patching_enabled
boolean
on success
If true, enables the monthly patching option.

Sample:
True
   
lead_time_in_weeks
integer
on success
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

Sample:
56
   
months
complex
on success
Months during the year when maintenance should be performed.

     
name
string
on success
Name of the month of the year.

Sample:
JANUARY
   
patching_mode
string
on success
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
*IMPORTANT*: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

Sample:
ROLLING
   
preference
string
on success
The maintenance window scheduling preference.

Sample:
NO_PREFERENCE
   
weeks_of_month
list / elements=string
on success
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.

 
memory_per_oracle_compute_unit_in_gbs
integer
on success
The amount of memory (in GBs) enabled per each OCPU core in Autonomous VM Cluster.

Sample:
56
 
next_maintenance_run_id
string
on success
The OCID of the next maintenance run.

Sample:
ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
 
patch_id
string
on success
The OCID of the last patch applied on the system.

Sample:
ocid1.patch.oc1..xxxxxxEXAMPLExxxxxx
 
patch_model
string
on success
Database patch model preference.

Sample:
RELEASE_UPDATES
 
provisionable_cpus
list / elements=string
on success
An array of CPU values that can be used to successfully provision a single Autonomous Database.

 
reclaimable_cpus
float
on success
CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database.

Sample:
3.4
 
role
string
on success
The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Sample:
PRIMARY
 
service_level_agreement_type
string
on success
The service level agreement type of the container database. The default is STANDARD.

Sample:
STANDARD
 
standby_maintenance_buffer_in_days
integer
on success
The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database.

Sample:
56
 
time_created
string
on success
The date and time the Autonomous Container Database was created.

Sample:
2013-10-20T19:20:30+01:00
 
total_cpus
integer
on success
The number of CPU cores allocated to the Autonomous VM cluster.

Sample:
56
 
vault_id
string
on success
The OCID of the Oracle Cloud Infrastructure vault.

Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)