Try SpotterManage an AutonomousContainerDatabase resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0This module allows the user to create, update and delete an AutonomousContainerDatabase resource in Oracle Cloud Infrastructure
For I(state=present), creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.
This resource has the following action operations in the M(oracle.oci.oci_database_autonomous_container_database_actions) module: change_compartment, change_dataguard_role, restart, rotate_autonomous_container_database_encryption_key.
- 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
db_name: db_name_example
service_level_agreement_type: STANDARD
autonomous_exadata_infrastructure_id: "ocid1.autonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
db_version: db_version_example
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
fast_start_fail_over_lag_limit_in_seconds: 56
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
dbrs_policy_id: "ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx"
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
version_preference: NEXT_RELEASE_UPDATE
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
dbrs_policy_id: "ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx"
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
version_preference: NEXT_RELEASE_UPDATE
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
dbrs_policy_id: "ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx"
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
version_preference: NEXT_RELEASE_UPDATE
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
dbrs_policy_id: "ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx"
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
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
state:
choices:
- present
- absent
default: present
description:
- The state of the AutonomousContainerDatabase.
- Use I(state=present) to create or update an AutonomousContainerDatabase.
- Use I(state=absent) to delete an AutonomousContainerDatabase.
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
db_name:
description:
- The Database name for the Autonomous Container Database. The name must be unique
within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed
by 1 to 7 alphanumeric characters.
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
vault_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Oracle Cloud Infrastructure L(vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts).
This parameter and `secretId` are required for Customer Managed Keys.
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
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
db_version:
description:
- The base version for the Autonomous Container Database.
type: str
kms_key_id:
description:
- The OCID of the key container that is used as the master encryption key in database
transparent data encryption (TDE) operations.
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
patch_model:
choices:
- RELEASE_UPDATES
- RELEASE_UPDATE_REVISIONS
description:
- Database Patch model preference.
- Required for create using I(state=present).
- This parameter is updatable.
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
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- This parameter is updatable.
type: dict
display_name:
aliases:
- name
description:
- The display name for the Autonomous Container Database.
- Required for create using I(state=present).
- Required for 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
key_store_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the key store of Oracle Vault.
type: str
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
backup_config:
description:
- ''
- This parameter is updatable.
suboptions:
backup_destination_details:
description:
- Backup destination details.
elements: dict
suboptions:
dbrs_policy_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the DBRS policy used for backup.
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the backup destination.
type: str
internet_proxy:
description:
- Proxy URL to connect to object store.
type: str
type:
choices:
- NFS
- RECOVERY_APPLIANCE
- OBJECT_STORE
- LOCAL
- DBRS
description:
- Type of the database backup destination.
required: true
type: str
vpc_password:
description:
- For a RECOVERY_APPLIANCE backup destination, the password for the VPC user
that is used to access the Recovery Appliance.
type: str
vpc_user:
description:
- For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog
(VPC) user that is used to access the Recovery Appliance.
type: str
type: list
recovery_window_in_days:
description:
- 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.
type: int
type: dict
freeform_tags:
description:
- 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
- This parameter is updatable.
type: dict
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment containing the Autonomous Container Database.
- Required for create using I(state=present).
- Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
- Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
type: str
db_unique_name:
description:
- '**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.'
type: str
protection_mode:
choices:
- MAXIMUM_AVAILABILITY
- MAXIMUM_PERFORMANCE
description:
- The protection mode of this Autonomous Data Guard association. For more information,
see L(Oracle Data Guard Protection Modes,http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000)
in the Oracle Data Guard documentation.
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
kms_key_version_id:
description:
- 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. Autonomous
Database Serverless does not use key versions, hence is not applicable for Autonomous
Database Serverless instances.
type: str
version_preference:
choices:
- NEXT_RELEASE_UPDATE
- LATEST_RELEASE_UPDATE
description:
- The next maintenance version preference.
- This parameter is updatable.
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
peer_db_unique_name:
description:
- '**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.'
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
autonomous_vm_cluster_id:
description:
- The OCID of the Autonomous VM Cluster.
type: str
maintenance_window_details:
description:
- ''
- This parameter is updatable.
suboptions:
custom_action_timeout_in_mins:
description:
- 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).
type: int
days_of_week:
description:
- Days during the week when maintenance should be performed.
elements: dict
suboptions:
name:
choices:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
description:
- Name of the day of the week.
required: true
type: str
type: list
hours_of_day:
description:
- 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
elements: int
type: list
is_custom_action_timeout_enabled:
description:
- If true, enables the configuration of a custom action timeout (waiting period)
between database server patching operations.
type: bool
is_monthly_patching_enabled:
description:
- If true, enables the monthly patching option.
type: bool
lead_time_in_weeks:
description:
- 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.
type: int
months:
description:
- Months during the year when maintenance should be performed.
elements: dict
suboptions:
name:
choices:
- JANUARY
- FEBRUARY
- MARCH
- APRIL
- MAY
- JUNE
- JULY
- AUGUST
- SEPTEMBER
- OCTOBER
- NOVEMBER
- DECEMBER
description:
- Name of the month of the year.
required: true
type: str
type: list
patching_mode:
choices:
- ROLLING
- NONROLLING
description:
- Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING".
Default value is ROLLING.
- '*IMPORTANT*: Non-rolling infrastructure patching involves system down time.
See L(Oracle-Managed Infrastructure Maintenance Updates,https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle)
for more information.'
type: str
preference:
choices:
- NO_PREFERENCE
- CUSTOM_PREFERENCE
description:
- The maintenance window scheduling preference.
type: str
weeks_of_month:
description:
- 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.
elements: int
type: list
type: dict
service_level_agreement_type:
choices:
- STANDARD
- AUTONOMOUS_DATAGUARD
description:
- 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.
type: str
is_automatic_failover_enabled:
description:
- Indicates whether Automatic Failover is enabled for Autonomous Container Database
Dataguard Association
type: bool
peer_autonomous_vm_cluster_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the peer Autonomous VM cluster for Autonomous Data Guard. Required to enable
Data Guard.
type: str
cloud_autonomous_vm_cluster_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the cloud Autonomous Exadata VM Cluster.
type: str
autonomous_container_database_id:
aliases:
- id
description:
- The Autonomous Container Database L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- 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
standby_maintenance_buffer_in_days:
description:
- 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.
type: int
peer_cloud_autonomous_vm_cluster_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the peer cloud Autonomous Exadata VM Cluster.
type: str
autonomous_exadata_infrastructure_id:
description:
- '**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.'
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
fast_start_fail_over_lag_limit_in_seconds:
description:
- The lag time for my preference based on data loss tolerance in seconds.
type: int
peer_autonomous_exadata_infrastructure_id:
description:
- '*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.'
type: str
peer_autonomous_container_database_display_name:
description:
- The display name for the peer Autonomous Container Database.
type: str
peer_autonomous_container_database_backup_config:
description:
- ''
suboptions:
backup_destination_details:
description:
- Backup destination details.
elements: dict
suboptions:
dbrs_policy_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the DBRS policy used for backup.
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the backup destination.
type: str
internet_proxy:
description:
- Proxy URL to connect to object store.
type: str
type:
choices:
- NFS
- RECOVERY_APPLIANCE
- OBJECT_STORE
- LOCAL
- DBRS
description:
- Type of the database backup destination.
required: true
type: str
vpc_password:
description:
- For a RECOVERY_APPLIANCE backup destination, the password for the VPC user
that is used to access the Recovery Appliance.
type: str
vpc_user:
description:
- For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog
(VPC) user that is used to access the Recovery Appliance.
type: str
type: list
recovery_window_in_days:
description:
- 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.
type: int
type: dict
peer_autonomous_container_database_compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment where the standby Autonomous Container Database will be created.
type: str
autonomous_container_database:
contains:
autonomous_exadata_infrastructure_id:
description:
- '**No longer used.** For Autonomous Database on dedicated Exadata infrastructure,
the container database is created within a specified `cloudAutonomousVmCluster`.'
returned: on success
sample: ocid1.autonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
type: str
autonomous_vm_cluster_id:
description:
- The OCID of the Autonomous VM Cluster.
returned: on success
sample: ocid1.autonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx
type: str
availability_domain:
description:
- The availability domain of the Autonomous Container Database.
returned: on success
sample: Uocm:PHX-AD-1
type: str
available_cpus:
description:
- Sum of CPUs available on the Autonomous VM Cluster + Sum of reclaimable CPUs
available in the Autonomous Container Database.
returned: on success
sample: 3.4
type: float
backup_config:
contains:
backup_destination_details:
contains:
dbrs_policy_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the DBRS policy used for backup.
returned: on success
sample: ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the backup destination.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
internet_proxy:
description:
- Proxy URL to connect to object store.
returned: on success
sample: internet_proxy_example
type: str
type:
description:
- Type of the database backup destination.
returned: on success
sample: NFS
type: str
vpc_password:
description:
- For a RECOVERY_APPLIANCE backup destination, the password for the
VPC user that is used to access the Recovery Appliance.
returned: on success
sample: example-password
type: str
vpc_user:
description:
- For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog
(VPC) user that is used to access the Recovery Appliance.
returned: on success
sample: vpc_user_example
type: str
description:
- Backup destination details.
returned: on success
type: complex
recovery_window_in_days:
description:
- 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.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
cloud_autonomous_vm_cluster_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the cloud Autonomous Exadata VM Cluster.
returned: on success
sample: ocid1.cloudautonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx
type: str
compartment_id:
description:
- The OCID of the compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
compute_model:
description:
- The compute model of the Autonomous Container Database. For Autonomous Database
on Dedicated Exadata Infrastructure, the CPU type (ECPUs or OCPUs) is determined
by the parent Autonomous Exadata VM Cluster's compute model. ECPU compute
model is the recommended model and OCPU compute model is legacy. See L(Compute
Models in Autonomous Database on Dedicated Exadata Infrastructure,https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak)
for more details.
returned: on success
sample: ECPU
type: str
db_name:
description:
- The Database name for the Autonomous Container Database. The name must be
unique within the Cloud Autonomous VM Cluster, starting with an alphabetic
character, followed by 1 to 7 alphanumeric characters.
returned: on success
sample: db_name_example
type: str
db_unique_name:
description:
- '**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.'
returned: on success
sample: db_unique_name_example
type: str
db_version:
description:
- Oracle Database version of the Autonomous Container Database.
returned: on success
sample: db_version_example
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- The user-provided name for the Autonomous Container Database.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The OCID of the Autonomous Container Database.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
infrastructure_type:
description:
- The infrastructure type this resource belongs to.
returned: on success
sample: CLOUD
type: str
key_history_entry:
contains:
id:
description:
- The id of the Autonomous Database L(Vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts)
service key management history entry.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
kms_key_version_id:
description:
- 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. Autonomous Database Serverless does not use key
versions, hence is not applicable for Autonomous Database Serverless instances.
returned: on success
sample: ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_activated:
description:
- The date and time the kms key activated.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
vault_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Oracle Cloud Infrastructure L(vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts).
This parameter and `secretId` are required for Customer Managed Keys.
returned: on success
sample: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- Key History Entry.
returned: on success
type: complex
key_store_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the key store of Oracle Vault.
returned: on success
sample: ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx
type: str
key_store_wallet_name:
description:
- The wallet name for Oracle Key Vault.
returned: on success
sample: key_store_wallet_name_example
type: str
kms_key_id:
description:
- The OCID of the key container that is used as the master encryption key in
database transparent data encryption (TDE) operations.
returned: on success
sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
type: str
kms_key_version_id:
description:
- 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. Autonomous Database Serverless does not use key versions,
hence is not applicable for Autonomous Database Serverless instances.
returned: on success
sample: ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx
type: str
last_maintenance_run_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the last maintenance run.
returned: on success
sample: ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_details:
description:
- Additional information about the current lifecycle state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of the Autonomous Container Database.
returned: on success
sample: PROVISIONING
type: str
maintenance_window:
contains:
custom_action_timeout_in_mins:
description:
- 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).
returned: on success
sample: 56
type: int
days_of_week:
contains:
name:
description:
- Name of the day of the week.
returned: on success
sample: MONDAY
type: str
description:
- Days during the week when maintenance should be performed.
returned: on success
type: complex
hours_of_day:
description:
- 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
returned: on success
sample: []
type: list
is_custom_action_timeout_enabled:
description:
- If true, enables the configuration of a custom action timeout (waiting
period) between database server patching operations.
returned: on success
sample: true
type: bool
is_monthly_patching_enabled:
description:
- If true, enables the monthly patching option.
returned: on success
sample: true
type: bool
lead_time_in_weeks:
description:
- 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.
returned: on success
sample: 56
type: int
months:
contains:
name:
description:
- Name of the month of the year.
returned: on success
sample: JANUARY
type: str
description:
- Months during the year when maintenance should be performed.
returned: on success
type: complex
patching_mode:
description:
- Cloud Exadata infrastructure node patching method, either "ROLLING" or
"NONROLLING". Default value is ROLLING.
- '*IMPORTANT*: Non-rolling infrastructure patching involves system down
time. See L(Oracle-Managed Infrastructure Maintenance Updates,https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle)
for more information.'
returned: on success
sample: ROLLING
type: str
preference:
description:
- The maintenance window scheduling preference.
returned: on success
sample: NO_PREFERENCE
type: str
weeks_of_month:
description:
- 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.
returned: on success
sample: []
type: list
description:
- ''
returned: on success
type: complex
memory_per_oracle_compute_unit_in_gbs:
description:
- The amount of memory (in GBs) enabled per ECPU or OCPU in the Autonomous VM
Cluster.
returned: on success
sample: 56
type: int
next_maintenance_run_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the next maintenance run.
returned: on success
sample: ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
type: str
patch_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the last patch applied on the system.
returned: on success
sample: ocid1.patch.oc1..xxxxxxEXAMPLExxxxxx
type: str
patch_model:
description:
- Database patch model preference.
returned: on success
sample: RELEASE_UPDATES
type: str
provisionable_cpus:
description:
- An array of CPU values that can be used to successfully provision a single
Autonomous Database.
returned: on success
sample: []
type: list
reclaimable_cpus:
description:
- CPUs that continue to be included in the count of CPUs 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 CPUs at its parent Autonomous
VM Cluster level by restarting the Autonomous Container Database.
returned: on success
sample: 3.4
type: float
role:
description:
- The Data Guard role of the Autonomous Container Database or Autonomous Database,
if Autonomous Data Guard is enabled.
returned: on success
sample: PRIMARY
type: str
service_level_agreement_type:
description:
- The service level agreement type of the container database. The default is
STANDARD.
returned: on success
sample: STANDARD
type: str
standby_maintenance_buffer_in_days:
description:
- 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.
returned: on success
sample: 56
type: int
time_created:
description:
- The date and time the Autonomous Container Database was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_snapshot_standby_revert:
description:
- The date and time the Autonomous Container Database will be reverted to Standby
from Snapshot Standby.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
total_cpus:
description:
- The number of CPUs allocated to the Autonomous VM cluster.
returned: on success
sample: 56
type: int
vault_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Oracle Cloud Infrastructure L(vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts).
This parameter and `secretId` are required for Customer Managed Keys.
returned: on success
sample: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
type: str
version_preference:
description:
- The next maintenance version preference.
returned: on success
sample: NEXT_RELEASE_UPDATE
type: str
description:
- Details of the AutonomousContainerDatabase resource acted upon by the current
operation
returned: on success
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:
- dbrs_policy_id: ocid1.dbrspolicy.oc1..xxxxxxEXAMPLExxxxxx
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
compute_model: ECPU
db_name: db_name_example
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'
time_snapshot_standby_revert: '2013-10-20T19:20:30+01:00'
total_cpus: 56
vault_id: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
version_preference: NEXT_RELEASE_UPDATE
type: complex