Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseMigration
  5. Job
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.DatabaseMigration.Job

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

    Example Usage

    Create Job Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Job(name: string, args: JobArgs, opts?: CustomResourceOptions);
    @overload
def Job(resource_name: str,
        args: JobArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Job(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        job_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        suspend_trigger: Optional[int] = None)
    func NewJob(ctx *Context, name string, args JobArgs, opts ...ResourceOption) (*Job, error)
    public Job(string name, JobArgs args, CustomResourceOptions? opts = null)
    public Job(String name, JobArgs args)
public Job(String name, JobArgs args, CustomResourceOptions options)

    type: oci:DatabaseMigration:Job
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 JobArgs
    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 JobArgs
    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 JobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JobArgs
    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 ociJobResource = new Oci.DatabaseMigration.Job("ociJobResource", new()
{
    JobId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    SuspendTrigger = 0,
});

    example, err := DatabaseMigration.NewJob(ctx, "ociJobResource", &DatabaseMigration.JobArgs{
	JobId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SuspendTrigger: pulumi.Int(0),
})

    var ociJobResource = new Job("ociJobResource", JobArgs.builder()
    .jobId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .suspendTrigger(0)
    .build());

    oci_job_resource = oci.database_migration.Job("ociJobResource",
    job_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    suspend_trigger=0)

    const ociJobResource = new oci.databasemigration.Job("ociJobResource", {
    jobId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    suspendTrigger: 0,
});

    type: oci:DatabaseMigration:Job
properties:
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    jobId: string
    suspendTrigger: 0

    Job 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 Job resource accepts the following input properties:

    JobId string
    The OCID of the job
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Name of the job.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    SuspendTrigger int

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    JobId string
    The OCID of the job
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Name of the job.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    SuspendTrigger int

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    jobId String
    The OCID of the job
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Name of the job.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    suspendTrigger Integer

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    jobId string
    The OCID of the job
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) Name of the job.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    suspendTrigger number

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    job_id str
    The OCID of the job
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    (Updatable) Name of the job.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    suspend_trigger int

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    jobId String
    The OCID of the job
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Name of the job.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    suspendTrigger Number

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Job resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    MigrationId string
    The OCID of the Migration that this job belongs to.
    ParameterFileVersions List<JobParameterFileVersion>
    A list of parameter file versions that can be viewed or edited for the current job.
    Progresses List<JobProgress>
    Percent progress of job phase.
    State string
    The current state of the migration job.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Migration Job was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    Type string
    Type of unsupported object
    UnsupportedObjects List<JobUnsupportedObject>
    Database objects not supported.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    MigrationId string
    The OCID of the Migration that this job belongs to.
    ParameterFileVersions []JobParameterFileVersion
    A list of parameter file versions that can be viewed or edited for the current job.
    Progresses []JobProgress
    Percent progress of job phase.
    State string
    The current state of the migration job.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Migration Job was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    Type string
    Type of unsupported object
    UnsupportedObjects []JobUnsupportedObject
    Database objects not supported.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    migrationId String
    The OCID of the Migration that this job belongs to.
    parameterFileVersions List<JobParameterFileVersion>
    A list of parameter file versions that can be viewed or edited for the current job.
    progresses List<JobProgress>
    Percent progress of job phase.
    state String
    The current state of the migration job.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Migration Job was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    type String
    Type of unsupported object
    unsupportedObjects List<JobUnsupportedObject>
    Database objects not supported.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    migrationId string
    The OCID of the Migration that this job belongs to.
    parameterFileVersions JobParameterFileVersion[]
    A list of parameter file versions that can be viewed or edited for the current job.
    progresses JobProgress[]
    Percent progress of job phase.
    state string
    The current state of the migration job.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the Migration Job was created. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    type string
    Type of unsupported object
    unsupportedObjects JobUnsupportedObject[]
    Database objects not supported.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    migration_id str
    The OCID of the Migration that this job belongs to.
    parameter_file_versions Sequence[databasemigration.JobParameterFileVersion]
    A list of parameter file versions that can be viewed or edited for the current job.
    progresses Sequence[databasemigration.JobProgress]
    Percent progress of job phase.
    state str
    The current state of the migration job.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the Migration Job was created. An RFC3339 formatted datetime string
    time_updated str
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    type str
    Type of unsupported object
    unsupported_objects Sequence[databasemigration.JobUnsupportedObject]
    Database objects not supported.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    migrationId String
    The OCID of the Migration that this job belongs to.
    parameterFileVersions List<Property Map>
    A list of parameter file versions that can be viewed or edited for the current job.
    progresses List<Property Map>
    Percent progress of job phase.
    state String
    The current state of the migration job.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Migration Job was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    type String
    Type of unsupported object
    unsupportedObjects List<Property Map>
    Database objects not supported.

    Look up Existing Job Resource

    Get an existing Job 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?: JobState, opts?: CustomResourceOptions): Job
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        job_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        migration_id: Optional[str] = None,
        parameter_file_versions: Optional[Sequence[_databasemigration.JobParameterFileVersionArgs]] = None,
        progresses: Optional[Sequence[_databasemigration.JobProgressArgs]] = None,
        state: Optional[str] = None,
        suspend_trigger: Optional[int] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        type: Optional[str] = None,
        unsupported_objects: Optional[Sequence[_databasemigration.JobUnsupportedObjectArgs]] = None) -> Job
    func GetJob(ctx *Context, name string, id IDInput, state *JobState, opts ...ResourceOption) (*Job, error)
    public static Job Get(string name, Input<string> id, JobState? state, CustomResourceOptions? opts = null)
    public static Job get(String name, Output<String> id, JobState state, CustomResourceOptions options)
    resources:  _:    type: oci:DatabaseMigration:Job    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.
    The following state arguments are supported:
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Name of the job.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    JobId string
    The OCID of the job
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    MigrationId string
    The OCID of the Migration that this job belongs to.
    ParameterFileVersions List<JobParameterFileVersion>
    A list of parameter file versions that can be viewed or edited for the current job.
    Progresses List<JobProgress>
    Percent progress of job phase.
    State string
    The current state of the migration job.
    SuspendTrigger int

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Migration Job was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    Type string
    Type of unsupported object
    UnsupportedObjects List<JobUnsupportedObject>
    Database objects not supported.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Name of the job.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    JobId string
    The OCID of the job
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    MigrationId string
    The OCID of the Migration that this job belongs to.
    ParameterFileVersions []JobParameterFileVersionArgs
    A list of parameter file versions that can be viewed or edited for the current job.
    Progresses []JobProgressArgs
    Percent progress of job phase.
    State string
    The current state of the migration job.
    SuspendTrigger int

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Migration Job was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    Type string
    Type of unsupported object
    UnsupportedObjects []JobUnsupportedObjectArgs
    Database objects not supported.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Name of the job.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    jobId String
    The OCID of the job
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    migrationId String
    The OCID of the Migration that this job belongs to.
    parameterFileVersions List<JobParameterFileVersion>
    A list of parameter file versions that can be viewed or edited for the current job.
    progresses List<JobProgress>
    Percent progress of job phase.
    state String
    The current state of the migration job.
    suspendTrigger Integer

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Migration Job was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    type String
    Type of unsupported object
    unsupportedObjects List<JobUnsupportedObject>
    Database objects not supported.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) Name of the job.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    jobId string
    The OCID of the job
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    migrationId string
    The OCID of the Migration that this job belongs to.
    parameterFileVersions JobParameterFileVersion[]
    A list of parameter file versions that can be viewed or edited for the current job.
    progresses JobProgress[]
    Percent progress of job phase.
    state string
    The current state of the migration job.
    suspendTrigger number

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the Migration Job was created. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    type string
    Type of unsupported object
    unsupportedObjects JobUnsupportedObject[]
    Database objects not supported.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    (Updatable) Name of the job.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    job_id str
    The OCID of the job
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    migration_id str
    The OCID of the Migration that this job belongs to.
    parameter_file_versions Sequence[databasemigration.JobParameterFileVersionArgs]
    A list of parameter file versions that can be viewed or edited for the current job.
    progresses Sequence[databasemigration.JobProgressArgs]
    Percent progress of job phase.
    state str
    The current state of the migration job.
    suspend_trigger int

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the Migration Job was created. An RFC3339 formatted datetime string
    time_updated str
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    type str
    Type of unsupported object
    unsupported_objects Sequence[databasemigration.JobUnsupportedObjectArgs]
    Database objects not supported.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Name of the job.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    jobId String
    The OCID of the job
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    migrationId String
    The OCID of the Migration that this job belongs to.
    parameterFileVersions List<Property Map>
    A list of parameter file versions that can be viewed or edited for the current job.
    progresses List<Property Map>
    Percent progress of job phase.
    state String
    The current state of the migration job.
    suspendTrigger Number

    (Updatable) An optional property when incremented triggers Suspend. Could be set to any integer value.

    ** 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

    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Migration Job was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Migration Job was last updated. An RFC3339 formatted datetime string
    type String
    Type of unsupported object
    unsupportedObjects List<Property Map>
    Database objects not supported.

    Supporting Types

    JobParameterFileVersion, JobParameterFileVersionArgs

    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    A description to discribe the current parameter file version
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsCurrent bool
    Return boolean true/false for the currently in-use parameter file (factory or a versioned file)
    IsFactory bool
    Return true/false for whether the parameter file is oracle provided (Factory)
    Kind string
    Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT)
    Name string
    Phase name
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Migration Job was created. An RFC3339 formatted datetime string
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    A description to discribe the current parameter file version
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsCurrent bool
    Return boolean true/false for the currently in-use parameter file (factory or a versioned file)
    IsFactory bool
    Return true/false for whether the parameter file is oracle provided (Factory)
    Kind string
    Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT)
    Name string
    Phase name
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Migration Job was created. An RFC3339 formatted datetime string
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    A description to discribe the current parameter file version
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCurrent Boolean
    Return boolean true/false for the currently in-use parameter file (factory or a versioned file)
    isFactory Boolean
    Return true/false for whether the parameter file is oracle provided (Factory)
    kind String
    Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT)
    name String
    Phase name
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Migration Job was created. An RFC3339 formatted datetime string
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    A description to discribe the current parameter file version
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCurrent boolean
    Return boolean true/false for the currently in-use parameter file (factory or a versioned file)
    isFactory boolean
    Return true/false for whether the parameter file is oracle provided (Factory)
    kind string
    Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT)
    name string
    Phase name
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the Migration Job was created. An RFC3339 formatted datetime string
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    A description to discribe the current parameter file version
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    is_current bool
    Return boolean true/false for the currently in-use parameter file (factory or a versioned file)
    is_factory bool
    Return true/false for whether the parameter file is oracle provided (Factory)
    kind str
    Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT)
    name str
    Phase name
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the Migration Job was created. An RFC3339 formatted datetime string
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    A description to discribe the current parameter file version
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCurrent Boolean
    Return boolean true/false for the currently in-use parameter file (factory or a versioned file)
    isFactory Boolean
    Return true/false for whether the parameter file is oracle provided (Factory)
    kind String
    Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT)
    name String
    Phase name
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Migration Job was created. An RFC3339 formatted datetime string

    JobProgress, JobProgressArgs

    CurrentPhase string
    Current phase of the job.
    CurrentStatus string
    Current status of the job.
    Phases List<JobProgressPhase>
    List of phase status for the job.
    CurrentPhase string
    Current phase of the job.
    CurrentStatus string
    Current status of the job.
    Phases []JobProgressPhase
    List of phase status for the job.
    currentPhase String
    Current phase of the job.
    currentStatus String
    Current status of the job.
    phases List<JobProgressPhase>
    List of phase status for the job.
    currentPhase string
    Current phase of the job.
    currentStatus string
    Current status of the job.
    phases JobProgressPhase[]
    List of phase status for the job.
    current_phase str
    Current phase of the job.
    current_status str
    Current status of the job.
    phases Sequence[databasemigration.JobProgressPhase]
    List of phase status for the job.
    currentPhase String
    Current phase of the job.
    currentStatus String
    Current status of the job.
    phases List<Property Map>
    List of phase status for the job.

    JobProgressPhase, JobProgressPhaseArgs

    Action string
    The text describing the action required to fix the issue
    DurationInMs int
    Duration of the phase in milliseconds
    EditableParameterFiles List<string>
    Attribute that returns an array of names and types of GoldenGate configuration files that are available for read or update.
    Extracts List<JobProgressPhaseExtract>
    Summary of phase status results.
    IsAdvisorReportAvailable bool
    True if a Pre-Migration Advisor report is available for this phase. False or null if no report is available.
    IsSuspendAvailable bool
    This is returned as true if the current phase can be suspended.
    Issue string
    The text describing the root cause of the reported issue
    LogLocations List<JobProgressPhaseLogLocation>
    Details to access log file in the specified Object Storage bucket, if any.
    Name string
    Phase name
    Progress int
    Percent progress of job phase.
    Status string
    Phase status
    Action string
    The text describing the action required to fix the issue
    DurationInMs int
    Duration of the phase in milliseconds
    EditableParameterFiles []string
    Attribute that returns an array of names and types of GoldenGate configuration files that are available for read or update.
    Extracts []JobProgressPhaseExtract
    Summary of phase status results.
    IsAdvisorReportAvailable bool
    True if a Pre-Migration Advisor report is available for this phase. False or null if no report is available.
    IsSuspendAvailable bool
    This is returned as true if the current phase can be suspended.
    Issue string
    The text describing the root cause of the reported issue
    LogLocations []JobProgressPhaseLogLocation
    Details to access log file in the specified Object Storage bucket, if any.
    Name string
    Phase name
    Progress int
    Percent progress of job phase.
    Status string
    Phase status
    action String
    The text describing the action required to fix the issue
    durationInMs Integer
    Duration of the phase in milliseconds
    editableParameterFiles List<String>
    Attribute that returns an array of names and types of GoldenGate configuration files that are available for read or update.
    extracts List<JobProgressPhaseExtract>
    Summary of phase status results.
    isAdvisorReportAvailable Boolean
    True if a Pre-Migration Advisor report is available for this phase. False or null if no report is available.
    isSuspendAvailable Boolean
    This is returned as true if the current phase can be suspended.
    issue String
    The text describing the root cause of the reported issue
    logLocations List<JobProgressPhaseLogLocation>
    Details to access log file in the specified Object Storage bucket, if any.
    name String
    Phase name
    progress Integer
    Percent progress of job phase.
    status String
    Phase status
    action string
    The text describing the action required to fix the issue
    durationInMs number
    Duration of the phase in milliseconds
    editableParameterFiles string[]
    Attribute that returns an array of names and types of GoldenGate configuration files that are available for read or update.
    extracts JobProgressPhaseExtract[]
    Summary of phase status results.
    isAdvisorReportAvailable boolean
    True if a Pre-Migration Advisor report is available for this phase. False or null if no report is available.
    isSuspendAvailable boolean
    This is returned as true if the current phase can be suspended.
    issue string
    The text describing the root cause of the reported issue
    logLocations JobProgressPhaseLogLocation[]
    Details to access log file in the specified Object Storage bucket, if any.
    name string
    Phase name
    progress number
    Percent progress of job phase.
    status string
    Phase status
    action str
    The text describing the action required to fix the issue
    duration_in_ms int
    Duration of the phase in milliseconds
    editable_parameter_files Sequence[str]
    Attribute that returns an array of names and types of GoldenGate configuration files that are available for read or update.
    extracts Sequence[databasemigration.JobProgressPhaseExtract]
    Summary of phase status results.
    is_advisor_report_available bool
    True if a Pre-Migration Advisor report is available for this phase. False or null if no report is available.
    is_suspend_available bool
    This is returned as true if the current phase can be suspended.
    issue str
    The text describing the root cause of the reported issue
    log_locations Sequence[databasemigration.JobProgressPhaseLogLocation]
    Details to access log file in the specified Object Storage bucket, if any.
    name str
    Phase name
    progress int
    Percent progress of job phase.
    status str
    Phase status
    action String
    The text describing the action required to fix the issue
    durationInMs Number
    Duration of the phase in milliseconds
    editableParameterFiles List<String>
    Attribute that returns an array of names and types of GoldenGate configuration files that are available for read or update.
    extracts List<Property Map>
    Summary of phase status results.
    isAdvisorReportAvailable Boolean
    True if a Pre-Migration Advisor report is available for this phase. False or null if no report is available.
    isSuspendAvailable Boolean
    This is returned as true if the current phase can be suspended.
    issue String
    The text describing the root cause of the reported issue
    logLocations List<Property Map>
    Details to access log file in the specified Object Storage bucket, if any.
    name String
    Phase name
    progress Number
    Percent progress of job phase.
    status String
    Phase status

    JobProgressPhaseExtract, JobProgressPhaseExtractArgs

    Message string
    Message in entry.
    Type string
    Type of unsupported object
    Message string
    Message in entry.
    Type string
    Type of unsupported object
    message String
    Message in entry.
    type String
    Type of unsupported object
    message string
    Message in entry.
    type string
    Type of unsupported object
    message str
    Message in entry.
    type str
    Type of unsupported object
    message String
    Message in entry.
    type String
    Type of unsupported object

    JobProgressPhaseLogLocation, JobProgressPhaseLogLocationArgs

    Bucket string
    Name of the bucket containing the log file.
    Namespace string
    Object Storage namespace.
    Object string
    Name of the object (regular expression is allowed)
    Bucket string
    Name of the bucket containing the log file.
    Namespace string
    Object Storage namespace.
    Object string
    Name of the object (regular expression is allowed)
    bucket String
    Name of the bucket containing the log file.
    namespace String
    Object Storage namespace.
    object String
    Name of the object (regular expression is allowed)
    bucket string
    Name of the bucket containing the log file.
    namespace string
    Object Storage namespace.
    object string
    Name of the object (regular expression is allowed)
    bucket str
    Name of the bucket containing the log file.
    namespace str
    Object Storage namespace.
    object str
    Name of the object (regular expression is allowed)
    bucket String
    Name of the bucket containing the log file.
    namespace String
    Object Storage namespace.
    object String
    Name of the object (regular expression is allowed)

    JobUnsupportedObject, JobUnsupportedObjectArgs

    Object string
    Name of the object (regular expression is allowed)
    Owner string
    Owner of the object (regular expression is allowed)
    Type string
    Type of unsupported object
    Object string
    Name of the object (regular expression is allowed)
    Owner string
    Owner of the object (regular expression is allowed)
    Type string
    Type of unsupported object
    object String
    Name of the object (regular expression is allowed)
    owner String
    Owner of the object (regular expression is allowed)
    type String
    Type of unsupported object
    object string
    Name of the object (regular expression is allowed)
    owner string
    Owner of the object (regular expression is allowed)
    type string
    Type of unsupported object
    object str
    Name of the object (regular expression is allowed)
    owner str
    Owner of the object (regular expression is allowed)
    type str
    Type of unsupported object
    object String
    Name of the object (regular expression is allowed)
    owner String
    Owner of the object (regular expression is allowed)
    type String
    Type of unsupported object

    Import

    Jobs can be imported using the id, e.g.

    $ pulumi import oci:DatabaseMigration/job:Job test_job "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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
    pulumi/pulumi-oci