Docs Home
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.GoldenGate.DeploymentBackup
Explore with Pulumi AI
This resource provides the Deployment Backup resource in Oracle Cloud Infrastructure Golden Gate service.
Creates a new DeploymentBackup.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDeploymentBackup = new oci.goldengate.DeploymentBackup("test_deployment_backup", {
bucket: deploymentBackupBucket,
compartmentId: compartmentId,
deploymentId: testDeployment.id,
displayName: deploymentBackupDisplayName,
namespace: deploymentBackupNamespace,
object: deploymentBackupObject,
definedTags: {
"foo-namespace.bar-key": "value",
},
freeformTags: {
"bar-key": "value",
},
isMetadataOnly: deploymentBackupIsMetadataOnly,
locks: [{
type: deploymentBackupLocksType,
message: deploymentBackupLocksMessage,
}],
});
import pulumi
import pulumi_oci as oci
test_deployment_backup = oci.golden_gate.DeploymentBackup("test_deployment_backup",
bucket=deployment_backup_bucket,
compartment_id=compartment_id,
deployment_id=test_deployment["id"],
display_name=deployment_backup_display_name,
namespace=deployment_backup_namespace,
object=deployment_backup_object,
defined_tags={
"foo-namespace.bar-key": "value",
},
freeform_tags={
"bar-key": "value",
},
is_metadata_only=deployment_backup_is_metadata_only,
locks=[{
"type": deployment_backup_locks_type,
"message": deployment_backup_locks_message,
}])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/goldengate"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := goldengate.NewDeploymentBackup(ctx, "test_deployment_backup", &goldengate.DeploymentBackupArgs{
Bucket: pulumi.Any(deploymentBackupBucket),
CompartmentId: pulumi.Any(compartmentId),
DeploymentId: pulumi.Any(testDeployment.Id),
DisplayName: pulumi.Any(deploymentBackupDisplayName),
Namespace: pulumi.Any(deploymentBackupNamespace),
Object: pulumi.Any(deploymentBackupObject),
DefinedTags: pulumi.StringMap{
"foo-namespace.bar-key": pulumi.String("value"),
},
FreeformTags: pulumi.StringMap{
"bar-key": pulumi.String("value"),
},
IsMetadataOnly: pulumi.Any(deploymentBackupIsMetadataOnly),
Locks: goldengate.DeploymentBackupLockArray{
&goldengate.DeploymentBackupLockArgs{
Type: pulumi.Any(deploymentBackupLocksType),
Message: pulumi.Any(deploymentBackupLocksMessage),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testDeploymentBackup = new Oci.GoldenGate.DeploymentBackup("test_deployment_backup", new()
{
Bucket = deploymentBackupBucket,
CompartmentId = compartmentId,
DeploymentId = testDeployment.Id,
DisplayName = deploymentBackupDisplayName,
Namespace = deploymentBackupNamespace,
Object = deploymentBackupObject,
DefinedTags =
{
{ "foo-namespace.bar-key", "value" },
},
FreeformTags =
{
{ "bar-key", "value" },
},
IsMetadataOnly = deploymentBackupIsMetadataOnly,
Locks = new[]
{
new Oci.GoldenGate.Inputs.DeploymentBackupLockArgs
{
Type = deploymentBackupLocksType,
Message = deploymentBackupLocksMessage,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.DeploymentBackup;
import com.pulumi.oci.GoldenGate.DeploymentBackupArgs;
import com.pulumi.oci.GoldenGate.inputs.DeploymentBackupLockArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testDeploymentBackup = new DeploymentBackup("testDeploymentBackup", DeploymentBackupArgs.builder()
.bucket(deploymentBackupBucket)
.compartmentId(compartmentId)
.deploymentId(testDeployment.id())
.displayName(deploymentBackupDisplayName)
.namespace(deploymentBackupNamespace)
.object(deploymentBackupObject)
.definedTags(Map.of("foo-namespace.bar-key", "value"))
.freeformTags(Map.of("bar-key", "value"))
.isMetadataOnly(deploymentBackupIsMetadataOnly)
.locks(DeploymentBackupLockArgs.builder()
.type(deploymentBackupLocksType)
.message(deploymentBackupLocksMessage)
.build())
.build());
}
}
resources:
testDeploymentBackup:
type: oci:GoldenGate:DeploymentBackup
name: test_deployment_backup
properties:
bucket: ${deploymentBackupBucket}
compartmentId: ${compartmentId}
deploymentId: ${testDeployment.id}
displayName: ${deploymentBackupDisplayName}
namespace: ${deploymentBackupNamespace}
object: ${deploymentBackupObject}
definedTags:
foo-namespace.bar-key: value
freeformTags:
bar-key: value
isMetadataOnly: ${deploymentBackupIsMetadataOnly}
locks:
- type: ${deploymentBackupLocksType}
message: ${deploymentBackupLocksMessage}
Create DeploymentBackup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DeploymentBackup(name: string, args: DeploymentBackupArgs, opts?: CustomResourceOptions);@overload
def DeploymentBackup(resource_name: str,
args: DeploymentBackupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DeploymentBackup(resource_name: str,
opts: Optional[ResourceOptions] = None,
bucket: Optional[str] = None,
compartment_id: Optional[str] = None,
deployment_id: Optional[str] = None,
display_name: Optional[str] = None,
namespace: Optional[str] = None,
object: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
is_lock_override: Optional[bool] = None,
is_metadata_only: Optional[bool] = None,
locks: Optional[Sequence[DeploymentBackupLockArgs]] = None)func NewDeploymentBackup(ctx *Context, name string, args DeploymentBackupArgs, opts ...ResourceOption) (*DeploymentBackup, error)public DeploymentBackup(string name, DeploymentBackupArgs args, CustomResourceOptions? opts = null)
public DeploymentBackup(String name, DeploymentBackupArgs args)
public DeploymentBackup(String name, DeploymentBackupArgs args, CustomResourceOptions options)
type: oci:GoldenGate:DeploymentBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DeploymentBackupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DeploymentBackupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DeploymentBackupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeploymentBackupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DeploymentBackupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var deploymentBackupResource = new Oci.GoldenGate.DeploymentBackup("deploymentBackupResource", new()
{
Bucket = "string",
CompartmentId = "string",
DeploymentId = "string",
DisplayName = "string",
Namespace = "string",
Object = "string",
DefinedTags =
{
{ "string", "string" },
},
FreeformTags =
{
{ "string", "string" },
},
IsLockOverride = false,
IsMetadataOnly = false,
Locks = new[]
{
new Oci.GoldenGate.Inputs.DeploymentBackupLockArgs
{
Type = "string",
Message = "string",
RelatedResourceId = "string",
TimeCreated = "string",
},
},
});
example, err := goldengate.NewDeploymentBackup(ctx, "deploymentBackupResource", &goldengate.DeploymentBackupArgs{
Bucket: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
DeploymentId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Namespace: pulumi.String("string"),
Object: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
IsLockOverride: pulumi.Bool(false),
IsMetadataOnly: pulumi.Bool(false),
Locks: goldengate.DeploymentBackupLockArray{
&goldengate.DeploymentBackupLockArgs{
Type: pulumi.String("string"),
Message: pulumi.String("string"),
RelatedResourceId: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
},
},
})
var deploymentBackupResource = new DeploymentBackup("deploymentBackupResource", DeploymentBackupArgs.builder()
.bucket("string")
.compartmentId("string")
.deploymentId("string")
.displayName("string")
.namespace("string")
.object("string")
.definedTags(Map.of("string", "string"))
.freeformTags(Map.of("string", "string"))
.isLockOverride(false)
.isMetadataOnly(false)
.locks(DeploymentBackupLockArgs.builder()
.type("string")
.message("string")
.relatedResourceId("string")
.timeCreated("string")
.build())
.build());
deployment_backup_resource = oci.golden_gate.DeploymentBackup("deploymentBackupResource",
bucket="string",
compartment_id="string",
deployment_id="string",
display_name="string",
namespace="string",
object="string",
defined_tags={
"string": "string",
},
freeform_tags={
"string": "string",
},
is_lock_override=False,
is_metadata_only=False,
locks=[{
"type": "string",
"message": "string",
"related_resource_id": "string",
"time_created": "string",
}])
const deploymentBackupResource = new oci.goldengate.DeploymentBackup("deploymentBackupResource", {
bucket: "string",
compartmentId: "string",
deploymentId: "string",
displayName: "string",
namespace: "string",
object: "string",
definedTags: {
string: "string",
},
freeformTags: {
string: "string",
},
isLockOverride: false,
isMetadataOnly: false,
locks: [{
type: "string",
message: "string",
relatedResourceId: "string",
timeCreated: "string",
}],
});
type: oci:GoldenGate:DeploymentBackup
properties:
bucket: string
compartmentId: string
definedTags:
string: string
deploymentId: string
displayName: string
freeformTags:
string: string
isLockOverride: false
isMetadataOnly: false
locks:
- message: string
relatedResourceId: string
timeCreated: string
type: string
namespace: string
object: string
DeploymentBackup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DeploymentBackup resource accepts the following input properties:
- Bucket string
- Name of the bucket where the object is to be uploaded in the object storage
- Compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- Deployment
Id string - The OCID of the deployment being referenced.
- Display
Name string - An object's Display Name.
- Namespace string
- Name of namespace that serves as a container for all of your buckets
- Object string
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
- Dictionary<string, string>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Dictionary<string, string>
- (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
Lock boolOverride - Is
Metadata boolOnly - Parameter to allow users to create backup without trails
- Locks
List<Deployment
Backup Lock> - Locks associated with this resource.
- Bucket string
- Name of the bucket where the object is to be uploaded in the object storage
- Compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- Deployment
Id string - The OCID of the deployment being referenced.
- Display
Name string - An object's Display Name.
- Namespace string
- Name of namespace that serves as a container for all of your buckets
- Object string
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
- map[string]string
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - map[string]string
- (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
Lock boolOverride - Is
Metadata boolOnly - Parameter to allow users to create backup without trails
- Locks
[]Deployment
Backup Lock Args - Locks associated with this resource.
- bucket String
- Name of the bucket where the object is to be uploaded in the object storage
- compartment
Id String - (Updatable) The OCID of the compartment being referenced.
- deployment
Id String - The OCID of the deployment being referenced.
- display
Name String - An object's Display Name.
- namespace String
- Name of namespace that serves as a container for all of your buckets
- object String
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
- Map<String,String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Map<String,String>
- (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
Lock BooleanOverride - is
Metadata BooleanOnly - Parameter to allow users to create backup without trails
- locks
List<Deployment
Backup Lock> - Locks associated with this resource.
- bucket string
- Name of the bucket where the object is to be uploaded in the object storage
- compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- deployment
Id string - The OCID of the deployment being referenced.
- display
Name string - An object's Display Name.
- namespace string
- Name of namespace that serves as a container for all of your buckets
- object string
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
- {[key: string]: string}
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - {[key: string]: string}
- (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
Lock booleanOverride - is
Metadata booleanOnly - Parameter to allow users to create backup without trails
- locks
Deployment
Backup Lock[] - Locks associated with this resource.
- bucket str
- Name of the bucket where the object is to be uploaded in the object storage
- compartment_
id str - (Updatable) The OCID of the compartment being referenced.
- deployment_
id str - The OCID of the deployment being referenced.
- display_
name str - An object's Display Name.
- namespace str
- Name of namespace that serves as a container for all of your buckets
- object str
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
- Mapping[str, str]
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Mapping[str, str]
- (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_
lock_ booloverride - is_
metadata_ boolonly - Parameter to allow users to create backup without trails
- locks
Sequence[Deployment
Backup Lock Args] - Locks associated with this resource.
- bucket String
- Name of the bucket where the object is to be uploaded in the object storage
- compartment
Id String - (Updatable) The OCID of the compartment being referenced.
- deployment
Id String - The OCID of the deployment being referenced.
- display
Name String - An object's Display Name.
- namespace String
- Name of namespace that serves as a container for all of your buckets
- object String
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
- Map<String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Map<String>
- (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
Lock BooleanOverride - is
Metadata BooleanOnly - Parameter to allow users to create backup without trails
- locks List<Property Map>
- Locks associated with this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the DeploymentBackup resource produces the following output properties:
- Backup
Source stringType - Possible deployment backup source types.
- Backup
Type string - Possible Deployment backup types.
- Deployment
Type string - 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'.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Automatic bool - True if this object is automatically created
- Lifecycle
Details string - 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.
- Ogg
Version string - Version of OGG
- Size
In doubleBytes - The size of the backup stored in object storage (in bytes)
- State string
- Possible lifecycle states.
- Dictionary<string, string>
- 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 stringFinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Of stringBackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- Backup
Source stringType - Possible deployment backup source types.
- Backup
Type string - Possible Deployment backup types.
- Deployment
Type string - 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'.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Automatic bool - True if this object is automatically created
- Lifecycle
Details string - 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.
- Ogg
Version string - Version of OGG
- Size
In float64Bytes - The size of the backup stored in object storage (in bytes)
- State string
- Possible lifecycle states.
- map[string]string
- 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 stringFinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Of stringBackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- backup
Source StringType - Possible deployment backup source types.
- backup
Type String - Possible Deployment backup types.
- deployment
Type String - 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'.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Automatic Boolean - True if this object is automatically created
- lifecycle
Details String - 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.
- ogg
Version String - Version of OGG
- size
In DoubleBytes - The size of the backup stored in object storage (in bytes)
- state String
- Possible lifecycle states.
- Map<String,String>
- 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 StringFinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Of StringBackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated String - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- backup
Source stringType - Possible deployment backup source types.
- backup
Type string - Possible Deployment backup types.
- deployment
Type string - 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'.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Automatic boolean - True if this object is automatically created
- lifecycle
Details string - 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.
- ogg
Version string - Version of OGG
- size
In numberBytes - The size of the backup stored in object storage (in bytes)
- state string
- Possible lifecycle states.
- {[key: string]: string}
- 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 stringFinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Of stringBackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- backup_
source_ strtype - Possible deployment backup source types.
- backup_
type str - Possible Deployment backup types.
- deployment_
type str - 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'.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
automatic bool - True if this object is automatically created
- lifecycle_
details str - 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.
- ogg_
version str - Version of OGG
- size_
in_ floatbytes - The size of the backup stored in object storage (in bytes)
- state str
- Possible lifecycle states.
- Mapping[str, str]
- 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_ strfinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time_
created str - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time_
of_ strbackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time_
updated str - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- backup
Source StringType - Possible deployment backup source types.
- backup
Type String - Possible Deployment backup types.
- deployment
Type String - 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'.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Automatic Boolean - True if this object is automatically created
- lifecycle
Details String - 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.
- ogg
Version String - Version of OGG
- size
In NumberBytes - The size of the backup stored in object storage (in bytes)
- state String
- Possible lifecycle states.
- Map<String>
- 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 StringFinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Of StringBackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated String - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
Look up Existing DeploymentBackup Resource
Get an existing DeploymentBackup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DeploymentBackupState, opts?: CustomResourceOptions): DeploymentBackup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
backup_source_type: Optional[str] = None,
backup_type: Optional[str] = None,
bucket: Optional[str] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
deployment_id: Optional[str] = None,
deployment_type: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
is_automatic: Optional[bool] = None,
is_lock_override: Optional[bool] = None,
is_metadata_only: Optional[bool] = None,
lifecycle_details: Optional[str] = None,
locks: Optional[Sequence[DeploymentBackupLockArgs]] = None,
namespace: Optional[str] = None,
object: Optional[str] = None,
ogg_version: Optional[str] = None,
size_in_bytes: Optional[float] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_backup_finished: Optional[str] = None,
time_created: Optional[str] = None,
time_of_backup: Optional[str] = None,
time_updated: Optional[str] = None) -> DeploymentBackupfunc GetDeploymentBackup(ctx *Context, name string, id IDInput, state *DeploymentBackupState, opts ...ResourceOption) (*DeploymentBackup, error)public static DeploymentBackup Get(string name, Input<string> id, DeploymentBackupState? state, CustomResourceOptions? opts = null)public static DeploymentBackup get(String name, Output<String> id, DeploymentBackupState state, CustomResourceOptions options)resources: _: type: oci:GoldenGate:DeploymentBackup get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Backup
Source stringType - Possible deployment backup source types.
- Backup
Type string - Possible Deployment backup types.
- Bucket string
- Name of the bucket where the object is to be uploaded in the object storage
- Compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- Dictionary<string, string>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Deployment
Id string - The OCID of the deployment being referenced.
- Deployment
Type string - 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 string - An object's Display Name.
- Dictionary<string, string>
- (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
Automatic bool - True if this object is automatically created
- Is
Lock boolOverride - Is
Metadata boolOnly - Parameter to allow users to create backup without trails
- Lifecycle
Details string - 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
List<Deployment
Backup Lock> - Locks associated with this resource.
- Namespace string
- Name of namespace that serves as a container for all of your buckets
- Object string
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
- Ogg
Version string - Version of OGG
- Size
In doubleBytes - The size of the backup stored in object storage (in bytes)
- State string
- Possible lifecycle states.
- Dictionary<string, string>
- 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 stringFinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Of stringBackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- Backup
Source stringType - Possible deployment backup source types.
- Backup
Type string - Possible Deployment backup types.
- Bucket string
- Name of the bucket where the object is to be uploaded in the object storage
- Compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- map[string]string
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Deployment
Id string - The OCID of the deployment being referenced.
- Deployment
Type string - 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 string - An object's Display Name.
- map[string]string
- (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
Automatic bool - True if this object is automatically created
- Is
Lock boolOverride - Is
Metadata boolOnly - Parameter to allow users to create backup without trails
- Lifecycle
Details string - 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
[]Deployment
Backup Lock Args - Locks associated with this resource.
- Namespace string
- Name of namespace that serves as a container for all of your buckets
- Object string
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
- Ogg
Version string - Version of OGG
- Size
In float64Bytes - The size of the backup stored in object storage (in bytes)
- State string
- Possible lifecycle states.
- map[string]string
- 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 stringFinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Of stringBackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- backup
Source StringType - Possible deployment backup source types.
- backup
Type String - Possible Deployment backup types.
- bucket String
- Name of the bucket where the object is to be uploaded in the object storage
- compartment
Id String - (Updatable) The OCID of the compartment being referenced.
- Map<String,String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment
Id String - The OCID of the deployment being referenced.
- deployment
Type String - 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 String - An object's Display Name.
- Map<String,String>
- (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
Automatic Boolean - True if this object is automatically created
- is
Lock BooleanOverride - is
Metadata BooleanOnly - Parameter to allow users to create backup without trails
- lifecycle
Details String - 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
List<Deployment
Backup Lock> - Locks associated with this resource.
- namespace String
- Name of namespace that serves as a container for all of your buckets
- object String
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
- ogg
Version String - Version of OGG
- size
In DoubleBytes - The size of the backup stored in object storage (in bytes)
- state String
- Possible lifecycle states.
- Map<String,String>
- 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 StringFinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Of StringBackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated String - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- backup
Source stringType - Possible deployment backup source types.
- backup
Type string - Possible Deployment backup types.
- bucket string
- Name of the bucket where the object is to be uploaded in the object storage
- compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- {[key: string]: string}
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment
Id string - The OCID of the deployment being referenced.
- deployment
Type string - 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 string - An object's Display Name.
- {[key: string]: string}
- (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
Automatic boolean - True if this object is automatically created
- is
Lock booleanOverride - is
Metadata booleanOnly - Parameter to allow users to create backup without trails
- lifecycle
Details string - 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
Deployment
Backup Lock[] - Locks associated with this resource.
- namespace string
- Name of namespace that serves as a container for all of your buckets
- object string
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
- ogg
Version string - Version of OGG
- size
In numberBytes - The size of the backup stored in object storage (in bytes)
- state string
- Possible lifecycle states.
- {[key: string]: string}
- 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 stringFinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Of stringBackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- backup_
source_ strtype - Possible deployment backup source types.
- backup_
type str - Possible Deployment backup types.
- bucket str
- Name of the bucket where the object is to be uploaded in the object storage
- compartment_
id str - (Updatable) The OCID of the compartment being referenced.
- Mapping[str, str]
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment_
id str - The OCID of the deployment being referenced.
- deployment_
type str - 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 str - An object's Display Name.
- Mapping[str, str]
- (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_
automatic bool - True if this object is automatically created
- is_
lock_ booloverride - is_
metadata_ boolonly - Parameter to allow users to create backup without trails
- lifecycle_
details str - 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
Sequence[Deployment
Backup Lock Args] - Locks associated with this resource.
- namespace str
- Name of namespace that serves as a container for all of your buckets
- object str
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
- ogg_
version str - Version of OGG
- size_
in_ floatbytes - The size of the backup stored in object storage (in bytes)
- state str
- Possible lifecycle states.
- Mapping[str, str]
- 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_ strfinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time_
created str - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time_
of_ strbackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time_
updated str - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- backup
Source StringType - Possible deployment backup source types.
- backup
Type String - Possible Deployment backup types.
- bucket String
- Name of the bucket where the object is to be uploaded in the object storage
- compartment
Id String - (Updatable) The OCID of the compartment being referenced.
- Map<String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment
Id String - The OCID of the deployment being referenced.
- deployment
Type String - 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 String - An object's Display Name.
- Map<String>
- (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
Automatic Boolean - True if this object is automatically created
- is
Lock BooleanOverride - is
Metadata BooleanOnly - Parameter to allow users to create backup without trails
- lifecycle
Details String - 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 List<Property Map>
- Locks associated with this resource.
- namespace String
- Name of namespace that serves as a container for all of your buckets
- object String
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
- ogg
Version String - Version of OGG
- size
In NumberBytes - The size of the backup stored in object storage (in bytes)
- state String
- Possible lifecycle states.
- Map<String>
- 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 StringFinished - The time of the resource backup finish. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Of StringBackup - The time of the resource backup. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated String - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
Supporting Types
DeploymentBackupLock, DeploymentBackupLockArgs
- Type string
- Type of the lock.
- Message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- Type string
- Type of the lock.
- Message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- type String
- Type of the lock.
- message String
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- String
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- type string
- Type of the lock.
- message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- type str
- Type of the lock.
- message str
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- str
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time_
created str - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- type String
- Type of the lock.
- message String
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- String
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
Import
DeploymentBackups can be imported using the id, e.g.
$ pulumi import oci:GoldenGate/deploymentBackup:DeploymentBackup test_deployment_backup "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.