1. Packages
  2. Ibm Provider
  3. API Docs
  4. CosBackupPolicy
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.CosBackupPolicy

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Create CosBackupPolicy Resource

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

    Constructor syntax

    new CosBackupPolicy(name: string, args: CosBackupPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def CosBackupPolicy(resource_name: str,
                        args: CosBackupPolicyArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def CosBackupPolicy(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        backup_type: Optional[str] = None,
                        bucket_crn: Optional[str] = None,
                        policy_name: Optional[str] = None,
                        target_backup_vault_crn: Optional[str] = None,
                        cos_backup_policy_id: Optional[str] = None,
                        timeouts: Optional[CosBackupPolicyTimeoutsArgs] = None)
    func NewCosBackupPolicy(ctx *Context, name string, args CosBackupPolicyArgs, opts ...ResourceOption) (*CosBackupPolicy, error)
    public CosBackupPolicy(string name, CosBackupPolicyArgs args, CustomResourceOptions? opts = null)
    public CosBackupPolicy(String name, CosBackupPolicyArgs args)
    public CosBackupPolicy(String name, CosBackupPolicyArgs args, CustomResourceOptions options)
    
    type: ibm:CosBackupPolicy
    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 CosBackupPolicyArgs
    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 CosBackupPolicyArgs
    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 CosBackupPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CosBackupPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CosBackupPolicyArgs
    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 cosBackupPolicyResource = new Ibm.CosBackupPolicy("cosBackupPolicyResource", new()
    {
        BackupType = "string",
        BucketCrn = "string",
        PolicyName = "string",
        TargetBackupVaultCrn = "string",
        CosBackupPolicyId = "string",
        Timeouts = new Ibm.Inputs.CosBackupPolicyTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
    });
    
    example, err := ibm.NewCosBackupPolicy(ctx, "cosBackupPolicyResource", &ibm.CosBackupPolicyArgs{
    	BackupType:           pulumi.String("string"),
    	BucketCrn:            pulumi.String("string"),
    	PolicyName:           pulumi.String("string"),
    	TargetBackupVaultCrn: pulumi.String("string"),
    	CosBackupPolicyId:    pulumi.String("string"),
    	Timeouts: &ibm.CosBackupPolicyTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    var cosBackupPolicyResource = new CosBackupPolicy("cosBackupPolicyResource", CosBackupPolicyArgs.builder()
        .backupType("string")
        .bucketCrn("string")
        .policyName("string")
        .targetBackupVaultCrn("string")
        .cosBackupPolicyId("string")
        .timeouts(CosBackupPolicyTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .build());
    
    cos_backup_policy_resource = ibm.CosBackupPolicy("cosBackupPolicyResource",
        backup_type="string",
        bucket_crn="string",
        policy_name="string",
        target_backup_vault_crn="string",
        cos_backup_policy_id="string",
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        })
    
    const cosBackupPolicyResource = new ibm.CosBackupPolicy("cosBackupPolicyResource", {
        backupType: "string",
        bucketCrn: "string",
        policyName: "string",
        targetBackupVaultCrn: "string",
        cosBackupPolicyId: "string",
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
    });
    
    type: ibm:CosBackupPolicy
    properties:
        backupType: string
        bucketCrn: string
        cosBackupPolicyId: string
        policyName: string
        targetBackupVaultCrn: string
        timeouts:
            create: string
            delete: string
            update: string
    

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

    BackupType string
    The type of backup to support.
    BucketCrn string
    Bucket Crn of the source bucket.
    PolicyName string
    Name of the backup policy to be applied on the source bucket.
    TargetBackupVaultCrn string
    The CRN for a COS BackupVault.
    CosBackupPolicyId string
    Timeouts CosBackupPolicyTimeouts
    BackupType string
    The type of backup to support.
    BucketCrn string
    Bucket Crn of the source bucket.
    PolicyName string
    Name of the backup policy to be applied on the source bucket.
    TargetBackupVaultCrn string
    The CRN for a COS BackupVault.
    CosBackupPolicyId string
    Timeouts CosBackupPolicyTimeoutsArgs
    backupType String
    The type of backup to support.
    bucketCrn String
    Bucket Crn of the source bucket.
    policyName String
    Name of the backup policy to be applied on the source bucket.
    targetBackupVaultCrn String
    The CRN for a COS BackupVault.
    cosBackupPolicyId String
    timeouts CosBackupPolicyTimeouts
    backupType string
    The type of backup to support.
    bucketCrn string
    Bucket Crn of the source bucket.
    policyName string
    Name of the backup policy to be applied on the source bucket.
    targetBackupVaultCrn string
    The CRN for a COS BackupVault.
    cosBackupPolicyId string
    timeouts CosBackupPolicyTimeouts
    backup_type str
    The type of backup to support.
    bucket_crn str
    Bucket Crn of the source bucket.
    policy_name str
    Name of the backup policy to be applied on the source bucket.
    target_backup_vault_crn str
    The CRN for a COS BackupVault.
    cos_backup_policy_id str
    timeouts CosBackupPolicyTimeoutsArgs
    backupType String
    The type of backup to support.
    bucketCrn String
    Bucket Crn of the source bucket.
    policyName String
    Name of the backup policy to be applied on the source bucket.
    targetBackupVaultCrn String
    The CRN for a COS BackupVault.
    cosBackupPolicyId String
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    Id of the backup policy applied on the source bucket
    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    Id of the backup policy applied on the source bucket
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    Id of the backup policy applied on the source bucket
    id string
    The provider-assigned unique ID for this managed resource.
    policyId string
    Id of the backup policy applied on the source bucket
    id str
    The provider-assigned unique ID for this managed resource.
    policy_id str
    Id of the backup policy applied on the source bucket
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    Id of the backup policy applied on the source bucket

    Look up Existing CosBackupPolicy Resource

    Get an existing CosBackupPolicy 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?: CosBackupPolicyState, opts?: CustomResourceOptions): CosBackupPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_type: Optional[str] = None,
            bucket_crn: Optional[str] = None,
            cos_backup_policy_id: Optional[str] = None,
            policy_id: Optional[str] = None,
            policy_name: Optional[str] = None,
            target_backup_vault_crn: Optional[str] = None,
            timeouts: Optional[CosBackupPolicyTimeoutsArgs] = None) -> CosBackupPolicy
    func GetCosBackupPolicy(ctx *Context, name string, id IDInput, state *CosBackupPolicyState, opts ...ResourceOption) (*CosBackupPolicy, error)
    public static CosBackupPolicy Get(string name, Input<string> id, CosBackupPolicyState? state, CustomResourceOptions? opts = null)
    public static CosBackupPolicy get(String name, Output<String> id, CosBackupPolicyState state, CustomResourceOptions options)
    resources:  _:    type: ibm:CosBackupPolicy    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:
    BackupType string
    The type of backup to support.
    BucketCrn string
    Bucket Crn of the source bucket.
    CosBackupPolicyId string
    PolicyId string
    Id of the backup policy applied on the source bucket
    PolicyName string
    Name of the backup policy to be applied on the source bucket.
    TargetBackupVaultCrn string
    The CRN for a COS BackupVault.
    Timeouts CosBackupPolicyTimeouts
    BackupType string
    The type of backup to support.
    BucketCrn string
    Bucket Crn of the source bucket.
    CosBackupPolicyId string
    PolicyId string
    Id of the backup policy applied on the source bucket
    PolicyName string
    Name of the backup policy to be applied on the source bucket.
    TargetBackupVaultCrn string
    The CRN for a COS BackupVault.
    Timeouts CosBackupPolicyTimeoutsArgs
    backupType String
    The type of backup to support.
    bucketCrn String
    Bucket Crn of the source bucket.
    cosBackupPolicyId String
    policyId String
    Id of the backup policy applied on the source bucket
    policyName String
    Name of the backup policy to be applied on the source bucket.
    targetBackupVaultCrn String
    The CRN for a COS BackupVault.
    timeouts CosBackupPolicyTimeouts
    backupType string
    The type of backup to support.
    bucketCrn string
    Bucket Crn of the source bucket.
    cosBackupPolicyId string
    policyId string
    Id of the backup policy applied on the source bucket
    policyName string
    Name of the backup policy to be applied on the source bucket.
    targetBackupVaultCrn string
    The CRN for a COS BackupVault.
    timeouts CosBackupPolicyTimeouts
    backup_type str
    The type of backup to support.
    bucket_crn str
    Bucket Crn of the source bucket.
    cos_backup_policy_id str
    policy_id str
    Id of the backup policy applied on the source bucket
    policy_name str
    Name of the backup policy to be applied on the source bucket.
    target_backup_vault_crn str
    The CRN for a COS BackupVault.
    timeouts CosBackupPolicyTimeoutsArgs
    backupType String
    The type of backup to support.
    bucketCrn String
    Bucket Crn of the source bucket.
    cosBackupPolicyId String
    policyId String
    Id of the backup policy applied on the source bucket
    policyName String
    Name of the backup policy to be applied on the source bucket.
    targetBackupVaultCrn String
    The CRN for a COS BackupVault.
    timeouts Property Map

    Supporting Types

    CosBackupPolicyTimeouts, CosBackupPolicyTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud