1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. BackupCancelManagement
Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi

oci.Database.BackupCancelManagement

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi

    This resource provides the Backup Cancel Management resource in Oracle Cloud Infrastructure Database service.

    Cancel automatic full/incremental create backup workrequests specified by the backup Id. This cannot be used on manual backups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testBackupCancelManagement = new oci.database.BackupCancelManagement("test_backup_cancel_management", {
        backupId: testBackup.id,
        cancelBackupTrigger: 1,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_backup_cancel_management = oci.database.BackupCancelManagement("test_backup_cancel_management",
        backup_id=test_backup["id"],
        cancel_backup_trigger=1)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Database"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Database.NewBackupCancelManagement(ctx, "test_backup_cancel_management", &Database.BackupCancelManagementArgs{
    			BackupId:            pulumi.Any(testBackup.Id),
    			CancelBackupTrigger: pulumi.Int(1),
    		})
    		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 testBackupCancelManagement = new Oci.Database.BackupCancelManagement("test_backup_cancel_management", new()
        {
            BackupId = testBackup.Id,
            CancelBackupTrigger = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Database.BackupCancelManagement;
    import com.pulumi.oci.Database.BackupCancelManagementArgs;
    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 testBackupCancelManagement = new BackupCancelManagement("testBackupCancelManagement", BackupCancelManagementArgs.builder()
                .backupId(testBackup.id())
                .cancelBackupTrigger(1)
                .build());
    
        }
    }
    
    resources:
      testBackupCancelManagement:
        type: oci:Database:BackupCancelManagement
        name: test_backup_cancel_management
        properties:
          backupId: ${testBackup.id}
          cancelBackupTrigger: 1
    

    Create BackupCancelManagement Resource

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

    Constructor syntax

    new BackupCancelManagement(name: string, args: BackupCancelManagementArgs, opts?: CustomResourceOptions);
    @overload
    def BackupCancelManagement(resource_name: str,
                               args: BackupCancelManagementArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def BackupCancelManagement(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               backup_id: Optional[str] = None,
                               cancel_backup_trigger: Optional[int] = None)
    func NewBackupCancelManagement(ctx *Context, name string, args BackupCancelManagementArgs, opts ...ResourceOption) (*BackupCancelManagement, error)
    public BackupCancelManagement(string name, BackupCancelManagementArgs args, CustomResourceOptions? opts = null)
    public BackupCancelManagement(String name, BackupCancelManagementArgs args)
    public BackupCancelManagement(String name, BackupCancelManagementArgs args, CustomResourceOptions options)
    
    type: oci:Database:BackupCancelManagement
    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 BackupCancelManagementArgs
    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 BackupCancelManagementArgs
    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 BackupCancelManagementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupCancelManagementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupCancelManagementArgs
    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 backupCancelManagementResource = new Oci.Database.BackupCancelManagement("backupCancelManagementResource", new()
    {
        BackupId = "string",
        CancelBackupTrigger = 0,
    });
    
    example, err := Database.NewBackupCancelManagement(ctx, "backupCancelManagementResource", &Database.BackupCancelManagementArgs{
    	BackupId:            pulumi.String("string"),
    	CancelBackupTrigger: pulumi.Int(0),
    })
    
    var backupCancelManagementResource = new BackupCancelManagement("backupCancelManagementResource", BackupCancelManagementArgs.builder()
        .backupId("string")
        .cancelBackupTrigger(0)
        .build());
    
    backup_cancel_management_resource = oci.database.BackupCancelManagement("backupCancelManagementResource",
        backup_id="string",
        cancel_backup_trigger=0)
    
    const backupCancelManagementResource = new oci.database.BackupCancelManagement("backupCancelManagementResource", {
        backupId: "string",
        cancelBackupTrigger: 0,
    });
    
    type: oci:Database:BackupCancelManagement
    properties:
        backupId: string
        cancelBackupTrigger: 0
    

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

    BackupId string
    The backup OCID.
    CancelBackupTrigger int

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    BackupId string
    The backup OCID.
    CancelBackupTrigger int

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    backupId String
    The backup OCID.
    cancelBackupTrigger Integer

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    backupId string
    The backup OCID.
    cancelBackupTrigger number

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    backup_id str
    The backup OCID.
    cancel_backup_trigger int

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    backupId String
    The backup OCID.
    cancelBackupTrigger Number

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

    ** 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 BackupCancelManagement resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BackupCancelManagement Resource

    Get an existing BackupCancelManagement 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?: BackupCancelManagementState, opts?: CustomResourceOptions): BackupCancelManagement
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_id: Optional[str] = None,
            cancel_backup_trigger: Optional[int] = None) -> BackupCancelManagement
    func GetBackupCancelManagement(ctx *Context, name string, id IDInput, state *BackupCancelManagementState, opts ...ResourceOption) (*BackupCancelManagement, error)
    public static BackupCancelManagement Get(string name, Input<string> id, BackupCancelManagementState? state, CustomResourceOptions? opts = null)
    public static BackupCancelManagement get(String name, Output<String> id, BackupCancelManagementState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    BackupId string
    The backup OCID.
    CancelBackupTrigger int

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    BackupId string
    The backup OCID.
    CancelBackupTrigger int

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    backupId String
    The backup OCID.
    cancelBackupTrigger Integer

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    backupId string
    The backup OCID.
    cancelBackupTrigger number

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    backup_id str
    The backup OCID.
    cancel_backup_trigger int

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    backupId String
    The backup OCID.
    cancelBackupTrigger Number

    When changed to a different integer, re-triggers cancel backup on the backup specified by the backup_id

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

    Import

    Import is not supported for this resource.

    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.18.0 published on Friday, Nov 22, 2024 by Pulumi