Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsBackupPolicy
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsBackupPolicy

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Provides a resource for BackupPolicy. This allows BackupPolicy to be created, updated and deleted. For more information, about backup policy in your IBM Cloud VPC, see Backup policy.

Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

provider.tf

import * as pulumi from "@pulumi/pulumi";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}
Copy
{}
Copy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = new ibm.IsBackupPolicy("example", {matchUserTags: ["tag1"]});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.IsBackupPolicy("example", match_user_tags=["tag1"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsBackupPolicy(ctx, "example", &ibm.IsBackupPolicyArgs{
			MatchUserTags: pulumi.StringArray{
				pulumi.String("tag1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsBackupPolicy("example", new()
    {
        MatchUserTags = new[]
        {
            "tag1",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsBackupPolicy;
import com.pulumi.ibm.IsBackupPolicyArgs;
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 example = new IsBackupPolicy("example", IsBackupPolicyArgs.builder()
            .matchUserTags("tag1")
            .build());

    }
}
Copy
resources:
  example:
    type: ibm:IsBackupPolicy
    properties:
      matchUserTags:
        - tag1
Copy

Enterprise Baas)

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const ent_baas_example1 = new ibm.IsBackupPolicy("ent-baas-example1", {
    matchUserTags: ["tag1"],
    scope: {
        crn: "crn:v1:bluemix:public:is:us-south:a/123456::reservation:7187-ba49df72-37b8-43ac-98da-f8e029de0e63",
    },
});
Copy
import pulumi
import pulumi_ibm as ibm

ent_baas_example1 = ibm.IsBackupPolicy("ent-baas-example1",
    match_user_tags=["tag1"],
    scope={
        "crn": "crn:v1:bluemix:public:is:us-south:a/123456::reservation:7187-ba49df72-37b8-43ac-98da-f8e029de0e63",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsBackupPolicy(ctx, "ent-baas-example1", &ibm.IsBackupPolicyArgs{
			MatchUserTags: pulumi.StringArray{
				pulumi.String("tag1"),
			},
			Scope: &ibm.IsBackupPolicyScopeArgs{
				Crn: pulumi.String("crn:v1:bluemix:public:is:us-south:a/123456::reservation:7187-ba49df72-37b8-43ac-98da-f8e029de0e63"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var ent_baas_example1 = new Ibm.IsBackupPolicy("ent-baas-example1", new()
    {
        MatchUserTags = new[]
        {
            "tag1",
        },
        Scope = new Ibm.Inputs.IsBackupPolicyScopeArgs
        {
            Crn = "crn:v1:bluemix:public:is:us-south:a/123456::reservation:7187-ba49df72-37b8-43ac-98da-f8e029de0e63",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsBackupPolicy;
import com.pulumi.ibm.IsBackupPolicyArgs;
import com.pulumi.ibm.inputs.IsBackupPolicyScopeArgs;
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 ent_baas_example1 = new IsBackupPolicy("ent-baas-example1", IsBackupPolicyArgs.builder()
            .matchUserTags("tag1")
            .scope(IsBackupPolicyScopeArgs.builder()
                .crn("crn:v1:bluemix:public:is:us-south:a/123456::reservation:7187-ba49df72-37b8-43ac-98da-f8e029de0e63")
                .build())
            .build());

    }
}
Copy
resources:
  ent-baas-example1:
    type: ibm:IsBackupPolicy
    properties:
      matchUserTags:
        - tag1
      scope:
        crn: crn:v1:bluemix:public:is:us-south:a/123456::reservation:7187-ba49df72-37b8-43ac-98da-f8e029de0e63
Copy

Create IsBackupPolicy Resource

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

Constructor syntax

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

@overload
def IsBackupPolicy(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   match_user_tags: Optional[Sequence[str]] = None,
                   included_contents: Optional[Sequence[str]] = None,
                   is_backup_policy_id: Optional[str] = None,
                   match_resource_type: Optional[str] = None,
                   match_resource_types: Optional[Sequence[str]] = None,
                   name: Optional[str] = None,
                   resource_group: Optional[str] = None,
                   scope: Optional[IsBackupPolicyScopeArgs] = None)
func NewIsBackupPolicy(ctx *Context, name string, args IsBackupPolicyArgs, opts ...ResourceOption) (*IsBackupPolicy, error)
public IsBackupPolicy(string name, IsBackupPolicyArgs args, CustomResourceOptions? opts = null)
public IsBackupPolicy(String name, IsBackupPolicyArgs args)
public IsBackupPolicy(String name, IsBackupPolicyArgs args, CustomResourceOptions options)

type: ibm:IsBackupPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IsBackupPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IsBackupPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IsBackupPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IsBackupPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IsBackupPolicyArgs
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 isBackupPolicyResource = new Ibm.IsBackupPolicy("isBackupPolicyResource", new()
{
    MatchUserTags = new[]
    {
        "string",
    },
    IncludedContents = new[]
    {
        "string",
    },
    IsBackupPolicyId = "string",
    MatchResourceType = "string",
    Name = "string",
    ResourceGroup = "string",
    Scope = new Ibm.Inputs.IsBackupPolicyScopeArgs
    {
        Crn = "string",
        Id = "string",
        ResourceType = "string",
    },
});
Copy
example, err := ibm.NewIsBackupPolicy(ctx, "isBackupPolicyResource", &ibm.IsBackupPolicyArgs{
MatchUserTags: pulumi.StringArray{
pulumi.String("string"),
},
IncludedContents: pulumi.StringArray{
pulumi.String("string"),
},
IsBackupPolicyId: pulumi.String("string"),
MatchResourceType: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
Scope: &.IsBackupPolicyScopeArgs{
Crn: pulumi.String("string"),
Id: pulumi.String("string"),
ResourceType: pulumi.String("string"),
},
})
Copy
var isBackupPolicyResource = new IsBackupPolicy("isBackupPolicyResource", IsBackupPolicyArgs.builder()
    .matchUserTags("string")
    .includedContents("string")
    .isBackupPolicyId("string")
    .matchResourceType("string")
    .name("string")
    .resourceGroup("string")
    .scope(IsBackupPolicyScopeArgs.builder()
        .crn("string")
        .id("string")
        .resourceType("string")
        .build())
    .build());
Copy
is_backup_policy_resource = ibm.IsBackupPolicy("isBackupPolicyResource",
    match_user_tags=["string"],
    included_contents=["string"],
    is_backup_policy_id="string",
    match_resource_type="string",
    name="string",
    resource_group="string",
    scope={
        "crn": "string",
        "id": "string",
        "resource_type": "string",
    })
Copy
const isBackupPolicyResource = new ibm.IsBackupPolicy("isBackupPolicyResource", {
    matchUserTags: ["string"],
    includedContents: ["string"],
    isBackupPolicyId: "string",
    matchResourceType: "string",
    name: "string",
    resourceGroup: "string",
    scope: {
        crn: "string",
        id: "string",
        resourceType: "string",
    },
});
Copy
type: ibm:IsBackupPolicy
properties:
    includedContents:
        - string
    isBackupPolicyId: string
    matchResourceType: string
    matchUserTags:
        - string
    name: string
    resourceGroup: string
    scope:
        crn: string
        id: string
        resourceType: string
Copy

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

MatchUserTags This property is required. List<string>
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
IncludedContents List<string>

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

IsBackupPolicyId string
(String) The unique identifier for this enterprise.
MatchResourceType string
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
MatchResourceTypes List<string>

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

Name string
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
ResourceGroup string

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

Scope IsBackupPolicyScope
If present, the scope for this backup policy. Nested scope blocks have the following structure:
MatchUserTags This property is required. []string
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
IncludedContents []string

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

IsBackupPolicyId string
(String) The unique identifier for this enterprise.
MatchResourceType string
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
MatchResourceTypes []string

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

Name string
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
ResourceGroup string

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

Scope IsBackupPolicyScopeArgs
If present, the scope for this backup policy. Nested scope blocks have the following structure:
matchUserTags This property is required. List<String>
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
includedContents List<String>

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

isBackupPolicyId String
(String) The unique identifier for this enterprise.
matchResourceType String
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
matchResourceTypes List<String>

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

name String
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
resourceGroup String

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

scope IsBackupPolicyScope
If present, the scope for this backup policy. Nested scope blocks have the following structure:
matchUserTags This property is required. string[]
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
includedContents string[]

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

isBackupPolicyId string
(String) The unique identifier for this enterprise.
matchResourceType string
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
matchResourceTypes string[]

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

name string
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
resourceGroup string

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

scope IsBackupPolicyScope
If present, the scope for this backup policy. Nested scope blocks have the following structure:
match_user_tags This property is required. Sequence[str]
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
included_contents Sequence[str]

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

is_backup_policy_id str
(String) The unique identifier for this enterprise.
match_resource_type str
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
match_resource_types Sequence[str]

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

name str
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
resource_group str

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

scope IsBackupPolicyScopeArgs
If present, the scope for this backup policy. Nested scope blocks have the following structure:
matchUserTags This property is required. List<String>
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
includedContents List<String>

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

isBackupPolicyId String
(String) The unique identifier for this enterprise.
matchResourceType String
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
matchResourceTypes List<String>

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

name String
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
resourceGroup String

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

scope Property Map
If present, the scope for this backup policy. Nested scope blocks have the following structure:

Outputs

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

CreatedAt string
(String) The date and time that the backup policy was created.
Crn string
(String) The CRN for this enterprise.
HealthReasons List<IsBackupPolicyHealthReason>
(List) The reasons for the current health_state (if any).
HealthState string
(String) The health of this resource.
Href string
(String) The URL for this backup policy.
Id string
The provider-assigned unique ID for this managed resource.
LastJobCompletedAt string
(String) The date and time that the most recent job for this backup policy completed.
LifecycleState string
(String) The lifecycle state of the backup policy.
ResourceType string
(String) The resource type.
Version string
Version of the BackupPolicy.
CreatedAt string
(String) The date and time that the backup policy was created.
Crn string
(String) The CRN for this enterprise.
HealthReasons []IsBackupPolicyHealthReason
(List) The reasons for the current health_state (if any).
HealthState string
(String) The health of this resource.
Href string
(String) The URL for this backup policy.
Id string
The provider-assigned unique ID for this managed resource.
LastJobCompletedAt string
(String) The date and time that the most recent job for this backup policy completed.
LifecycleState string
(String) The lifecycle state of the backup policy.
ResourceType string
(String) The resource type.
Version string
Version of the BackupPolicy.
createdAt String
(String) The date and time that the backup policy was created.
crn String
(String) The CRN for this enterprise.
healthReasons List<IsBackupPolicyHealthReason>
(List) The reasons for the current health_state (if any).
healthState String
(String) The health of this resource.
href String
(String) The URL for this backup policy.
id String
The provider-assigned unique ID for this managed resource.
lastJobCompletedAt String
(String) The date and time that the most recent job for this backup policy completed.
lifecycleState String
(String) The lifecycle state of the backup policy.
resourceType String
(String) The resource type.
version String
Version of the BackupPolicy.
createdAt string
(String) The date and time that the backup policy was created.
crn string
(String) The CRN for this enterprise.
healthReasons IsBackupPolicyHealthReason[]
(List) The reasons for the current health_state (if any).
healthState string
(String) The health of this resource.
href string
(String) The URL for this backup policy.
id string
The provider-assigned unique ID for this managed resource.
lastJobCompletedAt string
(String) The date and time that the most recent job for this backup policy completed.
lifecycleState string
(String) The lifecycle state of the backup policy.
resourceType string
(String) The resource type.
version string
Version of the BackupPolicy.
created_at str
(String) The date and time that the backup policy was created.
crn str
(String) The CRN for this enterprise.
health_reasons Sequence[IsBackupPolicyHealthReason]
(List) The reasons for the current health_state (if any).
health_state str
(String) The health of this resource.
href str
(String) The URL for this backup policy.
id str
The provider-assigned unique ID for this managed resource.
last_job_completed_at str
(String) The date and time that the most recent job for this backup policy completed.
lifecycle_state str
(String) The lifecycle state of the backup policy.
resource_type str
(String) The resource type.
version str
Version of the BackupPolicy.
createdAt String
(String) The date and time that the backup policy was created.
crn String
(String) The CRN for this enterprise.
healthReasons List<Property Map>
(List) The reasons for the current health_state (if any).
healthState String
(String) The health of this resource.
href String
(String) The URL for this backup policy.
id String
The provider-assigned unique ID for this managed resource.
lastJobCompletedAt String
(String) The date and time that the most recent job for this backup policy completed.
lifecycleState String
(String) The lifecycle state of the backup policy.
resourceType String
(String) The resource type.
version String
Version of the BackupPolicy.

Look up Existing IsBackupPolicy Resource

Get an existing IsBackupPolicy 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?: IsBackupPolicyState, opts?: CustomResourceOptions): IsBackupPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        health_reasons: Optional[Sequence[IsBackupPolicyHealthReasonArgs]] = None,
        health_state: Optional[str] = None,
        href: Optional[str] = None,
        included_contents: Optional[Sequence[str]] = None,
        is_backup_policy_id: Optional[str] = None,
        last_job_completed_at: Optional[str] = None,
        lifecycle_state: Optional[str] = None,
        match_resource_type: Optional[str] = None,
        match_resource_types: Optional[Sequence[str]] = None,
        match_user_tags: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_type: Optional[str] = None,
        scope: Optional[IsBackupPolicyScopeArgs] = None,
        version: Optional[str] = None) -> IsBackupPolicy
func GetIsBackupPolicy(ctx *Context, name string, id IDInput, state *IsBackupPolicyState, opts ...ResourceOption) (*IsBackupPolicy, error)
public static IsBackupPolicy Get(string name, Input<string> id, IsBackupPolicyState? state, CustomResourceOptions? opts = null)
public static IsBackupPolicy get(String name, Output<String> id, IsBackupPolicyState state, CustomResourceOptions options)
resources:  _:    type: ibm:IsBackupPolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreatedAt string
(String) The date and time that the backup policy was created.
Crn string
(String) The CRN for this enterprise.
HealthReasons List<IsBackupPolicyHealthReason>
(List) The reasons for the current health_state (if any).
HealthState string
(String) The health of this resource.
Href string
(String) The URL for this backup policy.
IncludedContents List<string>

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

IsBackupPolicyId string
(String) The unique identifier for this enterprise.
LastJobCompletedAt string
(String) The date and time that the most recent job for this backup policy completed.
LifecycleState string
(String) The lifecycle state of the backup policy.
MatchResourceType string
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
MatchResourceTypes List<string>

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

MatchUserTags List<string>
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
Name string
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
ResourceGroup string

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

ResourceType string
(String) The resource type.
Scope IsBackupPolicyScope
If present, the scope for this backup policy. Nested scope blocks have the following structure:
Version string
Version of the BackupPolicy.
CreatedAt string
(String) The date and time that the backup policy was created.
Crn string
(String) The CRN for this enterprise.
HealthReasons []IsBackupPolicyHealthReasonArgs
(List) The reasons for the current health_state (if any).
HealthState string
(String) The health of this resource.
Href string
(String) The URL for this backup policy.
IncludedContents []string

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

IsBackupPolicyId string
(String) The unique identifier for this enterprise.
LastJobCompletedAt string
(String) The date and time that the most recent job for this backup policy completed.
LifecycleState string
(String) The lifecycle state of the backup policy.
MatchResourceType string
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
MatchResourceTypes []string

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

MatchUserTags []string
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
Name string
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
ResourceGroup string

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

ResourceType string
(String) The resource type.
Scope IsBackupPolicyScopeArgs
If present, the scope for this backup policy. Nested scope blocks have the following structure:
Version string
Version of the BackupPolicy.
createdAt String
(String) The date and time that the backup policy was created.
crn String
(String) The CRN for this enterprise.
healthReasons List<IsBackupPolicyHealthReason>
(List) The reasons for the current health_state (if any).
healthState String
(String) The health of this resource.
href String
(String) The URL for this backup policy.
includedContents List<String>

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

isBackupPolicyId String
(String) The unique identifier for this enterprise.
lastJobCompletedAt String
(String) The date and time that the most recent job for this backup policy completed.
lifecycleState String
(String) The lifecycle state of the backup policy.
matchResourceType String
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
matchResourceTypes List<String>

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

matchUserTags List<String>
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
name String
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
resourceGroup String

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

resourceType String
(String) The resource type.
scope IsBackupPolicyScope
If present, the scope for this backup policy. Nested scope blocks have the following structure:
version String
Version of the BackupPolicy.
createdAt string
(String) The date and time that the backup policy was created.
crn string
(String) The CRN for this enterprise.
healthReasons IsBackupPolicyHealthReason[]
(List) The reasons for the current health_state (if any).
healthState string
(String) The health of this resource.
href string
(String) The URL for this backup policy.
includedContents string[]

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

isBackupPolicyId string
(String) The unique identifier for this enterprise.
lastJobCompletedAt string
(String) The date and time that the most recent job for this backup policy completed.
lifecycleState string
(String) The lifecycle state of the backup policy.
matchResourceType string
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
matchResourceTypes string[]

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

matchUserTags string[]
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
name string
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
resourceGroup string

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

resourceType string
(String) The resource type.
scope IsBackupPolicyScope
If present, the scope for this backup policy. Nested scope blocks have the following structure:
version string
Version of the BackupPolicy.
created_at str
(String) The date and time that the backup policy was created.
crn str
(String) The CRN for this enterprise.
health_reasons Sequence[IsBackupPolicyHealthReasonArgs]
(List) The reasons for the current health_state (if any).
health_state str
(String) The health of this resource.
href str
(String) The URL for this backup policy.
included_contents Sequence[str]

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

is_backup_policy_id str
(String) The unique identifier for this enterprise.
last_job_completed_at str
(String) The date and time that the most recent job for this backup policy completed.
lifecycle_state str
(String) The lifecycle state of the backup policy.
match_resource_type str
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
match_resource_types Sequence[str]

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

match_user_tags Sequence[str]
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
name str
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
resource_group str

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

resource_type str
(String) The resource type.
scope IsBackupPolicyScopeArgs
If present, the scope for this backup policy. Nested scope blocks have the following structure:
version str
Version of the BackupPolicy.
createdAt String
(String) The date and time that the backup policy was created.
crn String
(String) The CRN for this enterprise.
healthReasons List<Property Map>
(List) The reasons for the current health_state (if any).
healthState String
(String) The health of this resource.
href String
(String) The URL for this backup policy.
includedContents List<String>

The included content for backups created using this policy. Allowed values are boot_volume, data_volumes.

Note boot_volume: Include the instance's boot volume. data_volumes: Include the instance's data volumes.

isBackupPolicyId String
(String) The unique identifier for this enterprise.
lastJobCompletedAt String
(String) The date and time that the most recent job for this backup policy completed.
lifecycleState String
(String) The lifecycle state of the backup policy.
matchResourceType String
The resource type this backup policy will apply to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"]. Allowed values are volume,instance,share.
matchResourceTypes List<String>

A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is ["volume"].

Note match_resource_types is deprecated. Please use match_resource_type instead.

Deprecated: Deprecated

matchUserTags List<String>
The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
name String
The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
resourceGroup String

The resource group id, to use. If unspecified, the account's default resource group is used.

Nested scheme for resource_group:

resourceType String
(String) The resource type.
scope Property Map
If present, the scope for this backup policy. Nested scope blocks have the following structure:
version String
Version of the BackupPolicy.

Supporting Types

IsBackupPolicyHealthReason
, IsBackupPolicyHealthReasonArgs

Code This property is required. string
(String) A snake case string succinctly identifying the reason for this health state.
Message This property is required. string
(String) An explanation of the reason for this health state.
MoreInfo This property is required. string
(String) Link to documentation about the reason for this health state.
Code This property is required. string
(String) A snake case string succinctly identifying the reason for this health state.
Message This property is required. string
(String) An explanation of the reason for this health state.
MoreInfo This property is required. string
(String) Link to documentation about the reason for this health state.
code This property is required. String
(String) A snake case string succinctly identifying the reason for this health state.
message This property is required. String
(String) An explanation of the reason for this health state.
moreInfo This property is required. String
(String) Link to documentation about the reason for this health state.
code This property is required. string
(String) A snake case string succinctly identifying the reason for this health state.
message This property is required. string
(String) An explanation of the reason for this health state.
moreInfo This property is required. string
(String) Link to documentation about the reason for this health state.
code This property is required. str
(String) A snake case string succinctly identifying the reason for this health state.
message This property is required. str
(String) An explanation of the reason for this health state.
more_info This property is required. str
(String) Link to documentation about the reason for this health state.
code This property is required. String
(String) A snake case string succinctly identifying the reason for this health state.
message This property is required. String
(String) An explanation of the reason for this health state.
moreInfo This property is required. String
(String) Link to documentation about the reason for this health state.

IsBackupPolicyScope
, IsBackupPolicyScopeArgs

Crn string
The CRN for this enterprise.
Id string
(String) The unique identifier for this enterprise.
ResourceType string
(String) The resource type.
Crn string
The CRN for this enterprise.
Id string
(String) The unique identifier for this enterprise.
ResourceType string
(String) The resource type.
crn String
The CRN for this enterprise.
id String
(String) The unique identifier for this enterprise.
resourceType String
(String) The resource type.
crn string
The CRN for this enterprise.
id string
(String) The unique identifier for this enterprise.
resourceType string
(String) The resource type.
crn str
The CRN for this enterprise.
id str
(String) The unique identifier for this enterprise.
resource_type str
(String) The resource type.
crn String
The CRN for this enterprise.
id String
(String) The unique identifier for this enterprise.
resourceType String
(String) The resource type.

Import

You can import the ibm_is_backup_policy resource by using id. The unique identifier for this backup policy.

Syntax

$ pulumi import ibm:index/isBackupPolicy:IsBackupPolicy is_backup_policy <id>
Copy

Example

$ pulumi import ibm:index/isBackupPolicy:IsBackupPolicy is_backup_policy 0fe9e5d8-0a4d-4818-96ec-e99708644a58
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm