oci_golden_gate_deployment_backup
This resource provides the Deployment Backup resource in Oracle Cloud Infrastructure Golden Gate service.
Creates a new DeploymentBackup.
Example Usage
resource "oci_golden_gate_deployment_backup" "test_deployment_backup" {
#Required
bucket = var.deployment_backup_bucket
compartment_id = var.compartment_id
deployment_id = oci_golden_gate_deployment.test_deployment.id
display_name = var.deployment_backup_display_name
namespace = var.deployment_backup_namespace
object = var.deployment_backup_object
#Optional
defined_tags = {"foo-namespace.bar-key"= "value"}
freeform_tags = {"bar-key"= "value"}
is_metadata_only = var.deployment_backup_is_metadata_only
locks {
#Required
type = var.deployment_backup_locks_type
#Optional
message = var.deployment_backup_locks_message
}
}
Argument Reference
The following arguments are supported:
bucket
- (Required) Name of the bucket where the object is to be uploaded in the object storagecompartment_id
- (Required) (Updatable) The OCID of the compartment being referenced.defined_tags
- (Optional) (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:{"foo-namespace.bar-key": "value"}
deployment_id
- (Required) The OCID of the deployment being referenced.display_name
- (Required) An object’s Display Name.freeform_tags
- (Optional) (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example:{"bar-key": "value"}
is_metadata_only
- (Optional) Parameter to allow users to create backup without trailslocks
- (Optional) Locks associated with this resource.message
- (Optional) A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.type
- (Required) Type of the lock.
namespace
- (Required) Name of namespace that serves as a container for all of your bucketsobject
- (Required) Name of the object to be uploaded to object storage
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Attributes Reference
The following attributes are exported:
backup_type
- Possible Deployment backup types.bucket
- Name of the bucket where the object is to be uploaded in the object storagecompartment_id
- The OCID of the compartment being referenced.defined_tags
- Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:{"foo-namespace.bar-key": "value"}
deployment_id
- The OCID of the deployment being referenced.deployment_type
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value ‘OGG’ is maintained for backward compatibility purposes. Its use is discouraged in favor of ‘DATABASE_ORACLE’.display_name
- An object’s Display Name.freeform_tags
- A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example:{"bar-key": "value"}
id
- The OCID of the backup being referenced.is_automatic
- True if this object is automatically createdis_metadata_only
- Parameter to allow users to create backup without trailslifecycle_details
- Describes the object’s current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.locks
- Locks associated with this resource.message
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.related_resource_id
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.time_created
- When the lock was created.type
- Type of the lock.
namespace
- Name of namespace that serves as a container for all of your bucketsobject
- Name of the object to be uploaded to object storageogg_version
- Version of OGGsize_in_bytes
- The size of the backup stored in object storage (in bytes)state
- Possible lifecycle states.system_tags
- The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example:{orcl-cloud: {free-tier-retain: true}}
time_backup_finished
- The time of the resource backup finish. The format is defined by RFC3339, such as2016-08-25T21:10:29.600Z
.time_created
- The time the resource was created. The format is defined by RFC3339, such as2016-08-25T21:10:29.600Z
.time_of_backup
- The time of the resource backup. The format is defined by RFC3339, such as2016-08-25T21:10:29.600Z
.time_updated
- The time the resource was last updated. The format is defined by RFC3339, such as2016-08-25T21:10:29.600Z
.
Timeouts
The timeouts
block allows you to specify timeouts for certain operations:
* create
- (Defaults to 20 minutes), when creating the Deployment Backup
* update
- (Defaults to 20 minutes), when updating the Deployment Backup
* delete
- (Defaults to 20 minutes), when destroying the Deployment Backup
Import
DeploymentBackups can be imported using the id
, e.g.
$ terraform import oci_golden_gate_deployment_backup.test_deployment_backup "id"