Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsSnapshotConsistencyGroup
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsSnapshotConsistencyGroup

Explore with Pulumi AI

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

    Create, update, and delete SnapshotConsistencyGroups with this resource. For more information, about snapshot consistency group, see creating snapshot consistency group.

    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";

    import pulumi

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

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

    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) {
    }
}

    {}

    Example Usage

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

const isSnapshotConsistencyGroup = new ibm.IsSnapshotConsistencyGroup("isSnapshotConsistencyGroup", {
    deleteSnapshotsOnDelete: true,
    snapshots: [{
        name: "example-snapshot",
        sourceVolume: ibm_is_instance.testacc_instance.volume_attachments[0].volume_id,
    }],
});

    import pulumi
import pulumi_ibm as ibm

is_snapshot_consistency_group = ibm.IsSnapshotConsistencyGroup("isSnapshotConsistencyGroup",
    delete_snapshots_on_delete=True,
    snapshots=[{
        "name": "example-snapshot",
        "source_volume": ibm_is_instance["testacc_instance"]["volume_attachments"][0]["volume_id"],
    }])

    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.NewIsSnapshotConsistencyGroup(ctx, "isSnapshotConsistencyGroup", &ibm.IsSnapshotConsistencyGroupArgs{
			DeleteSnapshotsOnDelete: pulumi.Bool(true),
			Snapshots: ibm.IsSnapshotConsistencyGroupSnapshotArray{
				&ibm.IsSnapshotConsistencyGroupSnapshotArgs{
					Name:         pulumi.String("example-snapshot"),
					SourceVolume: pulumi.Any(ibm_is_instance.Testacc_instance.Volume_attachments[0].Volume_id),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var isSnapshotConsistencyGroup = new Ibm.IsSnapshotConsistencyGroup("isSnapshotConsistencyGroup", new()
    {
        DeleteSnapshotsOnDelete = true,
        Snapshots = new[]
        {
            new Ibm.Inputs.IsSnapshotConsistencyGroupSnapshotArgs
            {
                Name = "example-snapshot",
                SourceVolume = ibm_is_instance.Testacc_instance.Volume_attachments[0].Volume_id,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsSnapshotConsistencyGroup;
import com.pulumi.ibm.IsSnapshotConsistencyGroupArgs;
import com.pulumi.ibm.inputs.IsSnapshotConsistencyGroupSnapshotArgs;
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 isSnapshotConsistencyGroup = new IsSnapshotConsistencyGroup("isSnapshotConsistencyGroup", IsSnapshotConsistencyGroupArgs.builder()
            .deleteSnapshotsOnDelete(true)
            .snapshots(IsSnapshotConsistencyGroupSnapshotArgs.builder()
                .name("example-snapshot")
                .sourceVolume(ibm_is_instance.testacc_instance().volume_attachments()[0].volume_id())
                .build())
            .build());

    }
}

    resources:
  isSnapshotConsistencyGroup:
    type: ibm:IsSnapshotConsistencyGroup
    properties:
      deleteSnapshotsOnDelete: true
      snapshots:
        - name: example-snapshot
          sourceVolume: ${ibm_is_instance.testacc_instance.volume_attachments[0].volume_id}

    Create IsSnapshotConsistencyGroup Resource

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

    Constructor syntax

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

@overload
def IsSnapshotConsistencyGroup(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               snapshots: Optional[Sequence[IsSnapshotConsistencyGroupSnapshotArgs]] = None,
                               access_tags: Optional[Sequence[str]] = None,
                               delete_snapshots_on_delete: Optional[bool] = None,
                               is_snapshot_consistency_group_id: Optional[str] = None,
                               name: Optional[str] = None,
                               resource_group: Optional[str] = None,
                               tags: Optional[Sequence[str]] = None)
    func NewIsSnapshotConsistencyGroup(ctx *Context, name string, args IsSnapshotConsistencyGroupArgs, opts ...ResourceOption) (*IsSnapshotConsistencyGroup, error)
    public IsSnapshotConsistencyGroup(string name, IsSnapshotConsistencyGroupArgs args, CustomResourceOptions? opts = null)
    public IsSnapshotConsistencyGroup(String name, IsSnapshotConsistencyGroupArgs args)
public IsSnapshotConsistencyGroup(String name, IsSnapshotConsistencyGroupArgs args, CustomResourceOptions options)

    type: ibm:IsSnapshotConsistencyGroup
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 IsSnapshotConsistencyGroupArgs
    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 IsSnapshotConsistencyGroupArgs
    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 IsSnapshotConsistencyGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsSnapshotConsistencyGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsSnapshotConsistencyGroupArgs
    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 isSnapshotConsistencyGroupResource = new Ibm.IsSnapshotConsistencyGroup("isSnapshotConsistencyGroupResource", new()
{
    Snapshots = new[]
    {
        new Ibm.Inputs.IsSnapshotConsistencyGroupSnapshotArgs
        {
            SourceVolume = "string",
            Name = "string",
            Tags = new[]
            {
                "string",
            },
        },
    },
    AccessTags = new[]
    {
        "string",
    },
    DeleteSnapshotsOnDelete = false,
    IsSnapshotConsistencyGroupId = "string",
    Name = "string",
    ResourceGroup = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := ibm.NewIsSnapshotConsistencyGroup(ctx, "isSnapshotConsistencyGroupResource", &ibm.IsSnapshotConsistencyGroupArgs{
	Snapshots: ibm.IsSnapshotConsistencyGroupSnapshotArray{
		&ibm.IsSnapshotConsistencyGroupSnapshotArgs{
			SourceVolume: pulumi.String("string"),
			Name:         pulumi.String("string"),
			Tags: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	AccessTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	DeleteSnapshotsOnDelete:      pulumi.Bool(false),
	IsSnapshotConsistencyGroupId: pulumi.String("string"),
	Name:                         pulumi.String("string"),
	ResourceGroup:                pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var isSnapshotConsistencyGroupResource = new IsSnapshotConsistencyGroup("isSnapshotConsistencyGroupResource", IsSnapshotConsistencyGroupArgs.builder()
    .snapshots(IsSnapshotConsistencyGroupSnapshotArgs.builder()
        .sourceVolume("string")
        .name("string")
        .tags("string")
        .build())
    .accessTags("string")
    .deleteSnapshotsOnDelete(false)
    .isSnapshotConsistencyGroupId("string")
    .name("string")
    .resourceGroup("string")
    .tags("string")
    .build());

    is_snapshot_consistency_group_resource = ibm.IsSnapshotConsistencyGroup("isSnapshotConsistencyGroupResource",
    snapshots=[{
        "source_volume": "string",
        "name": "string",
        "tags": ["string"],
    }],
    access_tags=["string"],
    delete_snapshots_on_delete=False,
    is_snapshot_consistency_group_id="string",
    name="string",
    resource_group="string",
    tags=["string"])

    const isSnapshotConsistencyGroupResource = new ibm.IsSnapshotConsistencyGroup("isSnapshotConsistencyGroupResource", {
    snapshots: [{
        sourceVolume: "string",
        name: "string",
        tags: ["string"],
    }],
    accessTags: ["string"],
    deleteSnapshotsOnDelete: false,
    isSnapshotConsistencyGroupId: "string",
    name: "string",
    resourceGroup: "string",
    tags: ["string"],
});

    type: ibm:IsSnapshotConsistencyGroup
properties:
    accessTags:
        - string
    deleteSnapshotsOnDelete: false
    isSnapshotConsistencyGroupId: string
    name: string
    resourceGroup: string
    snapshots:
        - name: string
          sourceVolume: string
          tags:
            - string
    tags:
        - string

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

    Snapshots List<IsSnapshotConsistencyGroupSnapshot>

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    AccessTags List<string>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    DeleteSnapshotsOnDelete bool
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    IsSnapshotConsistencyGroupId string
    (String) The unique identifier for the source snapshot.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    ResourceGroup string
    The resource group ID where the snapshot consistency group is to be created.
    Tags List<string>
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    Snapshots []IsSnapshotConsistencyGroupSnapshotArgs

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    AccessTags []string

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    DeleteSnapshotsOnDelete bool
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    IsSnapshotConsistencyGroupId string
    (String) The unique identifier for the source snapshot.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    ResourceGroup string
    The resource group ID where the snapshot consistency group is to be created.
    Tags []string
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    snapshots List<IsSnapshotConsistencyGroupSnapshot>

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    accessTags List<String>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    deleteSnapshotsOnDelete Boolean
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    isSnapshotConsistencyGroupId String
    (String) The unique identifier for the source snapshot.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    resourceGroup String
    The resource group ID where the snapshot consistency group is to be created.
    tags List<String>
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    snapshots IsSnapshotConsistencyGroupSnapshot[]

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    accessTags string[]

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    deleteSnapshotsOnDelete boolean
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    isSnapshotConsistencyGroupId string
    (String) The unique identifier for the source snapshot.
    name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    resourceGroup string
    The resource group ID where the snapshot consistency group is to be created.
    tags string[]
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    snapshots Sequence[IsSnapshotConsistencyGroupSnapshotArgs]

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    access_tags Sequence[str]

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    delete_snapshots_on_delete bool
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    is_snapshot_consistency_group_id str
    (String) The unique identifier for the source snapshot.
    name str
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    resource_group str
    The resource group ID where the snapshot consistency group is to be created.
    tags Sequence[str]
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    snapshots List<Property Map>

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    accessTags List<String>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    deleteSnapshotsOnDelete Boolean
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    isSnapshotConsistencyGroupId String
    (String) The unique identifier for the source snapshot.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    resourceGroup String
    The resource group ID where the snapshot consistency group is to be created.
    tags List<String>
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

    Outputs

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

    BackupPolicyPlans List<IsSnapshotConsistencyGroupBackupPolicyPlan>
    (List) If present, the backup policy plan which created this snapshot consistency group.
    CreatedAt string
    (String) The date and time that this snapshot consistency group was created.
    Crn string
    (String) The CRN of the source snapshot.
    Href string
    (String) The URL for this region.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleState string
    (String) The lifecycle state of this snapshot consistency group.
    ResourceType string
    (String) The resource type.
    ServiceTags List<string>
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    SnapshotReferences List<IsSnapshotConsistencyGroupSnapshotReference>
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    BackupPolicyPlans []IsSnapshotConsistencyGroupBackupPolicyPlan
    (List) If present, the backup policy plan which created this snapshot consistency group.
    CreatedAt string
    (String) The date and time that this snapshot consistency group was created.
    Crn string
    (String) The CRN of the source snapshot.
    Href string
    (String) The URL for this region.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleState string
    (String) The lifecycle state of this snapshot consistency group.
    ResourceType string
    (String) The resource type.
    ServiceTags []string
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    SnapshotReferences []IsSnapshotConsistencyGroupSnapshotReference
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    backupPolicyPlans List<IsSnapshotConsistencyGroupBackupPolicyPlan>
    (List) If present, the backup policy plan which created this snapshot consistency group.
    createdAt String
    (String) The date and time that this snapshot consistency group was created.
    crn String
    (String) The CRN of the source snapshot.
    href String
    (String) The URL for this region.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleState String
    (String) The lifecycle state of this snapshot consistency group.
    resourceType String
    (String) The resource type.
    serviceTags List<String>
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    snapshotReferences List<IsSnapshotConsistencyGroupSnapshotReference>
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    backupPolicyPlans IsSnapshotConsistencyGroupBackupPolicyPlan[]
    (List) If present, the backup policy plan which created this snapshot consistency group.
    createdAt string
    (String) The date and time that this snapshot consistency group was created.
    crn string
    (String) The CRN of the source snapshot.
    href string
    (String) The URL for this region.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleState string
    (String) The lifecycle state of this snapshot consistency group.
    resourceType string
    (String) The resource type.
    serviceTags string[]
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    snapshotReferences IsSnapshotConsistencyGroupSnapshotReference[]
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    backup_policy_plans Sequence[IsSnapshotConsistencyGroupBackupPolicyPlan]
    (List) If present, the backup policy plan which created this snapshot consistency group.
    created_at str
    (String) The date and time that this snapshot consistency group was created.
    crn str
    (String) The CRN of the source snapshot.
    href str
    (String) The URL for this region.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_state str
    (String) The lifecycle state of this snapshot consistency group.
    resource_type str
    (String) The resource type.
    service_tags Sequence[str]
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    snapshot_references Sequence[IsSnapshotConsistencyGroupSnapshotReference]
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    backupPolicyPlans List<Property Map>
    (List) If present, the backup policy plan which created this snapshot consistency group.
    createdAt String
    (String) The date and time that this snapshot consistency group was created.
    crn String
    (String) The CRN of the source snapshot.
    href String
    (String) The URL for this region.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleState String
    (String) The lifecycle state of this snapshot consistency group.
    resourceType String
    (String) The resource type.
    serviceTags List<String>
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    snapshotReferences List<Property Map>
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Look up Existing IsSnapshotConsistencyGroup Resource

    Get an existing IsSnapshotConsistencyGroup 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?: IsSnapshotConsistencyGroupState, opts?: CustomResourceOptions): IsSnapshotConsistencyGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tags: Optional[Sequence[str]] = None,
        backup_policy_plans: Optional[Sequence[IsSnapshotConsistencyGroupBackupPolicyPlanArgs]] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        delete_snapshots_on_delete: Optional[bool] = None,
        href: Optional[str] = None,
        is_snapshot_consistency_group_id: Optional[str] = None,
        lifecycle_state: Optional[str] = None,
        name: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_type: Optional[str] = None,
        service_tags: Optional[Sequence[str]] = None,
        snapshot_references: Optional[Sequence[IsSnapshotConsistencyGroupSnapshotReferenceArgs]] = None,
        snapshots: Optional[Sequence[IsSnapshotConsistencyGroupSnapshotArgs]] = None,
        tags: Optional[Sequence[str]] = None) -> IsSnapshotConsistencyGroup
    func GetIsSnapshotConsistencyGroup(ctx *Context, name string, id IDInput, state *IsSnapshotConsistencyGroupState, opts ...ResourceOption) (*IsSnapshotConsistencyGroup, error)
    public static IsSnapshotConsistencyGroup Get(string name, Input<string> id, IsSnapshotConsistencyGroupState? state, CustomResourceOptions? opts = null)
    public static IsSnapshotConsistencyGroup get(String name, Output<String> id, IsSnapshotConsistencyGroupState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsSnapshotConsistencyGroup    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:
    AccessTags List<string>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    BackupPolicyPlans List<IsSnapshotConsistencyGroupBackupPolicyPlan>
    (List) If present, the backup policy plan which created this snapshot consistency group.
    CreatedAt string
    (String) The date and time that this snapshot consistency group was created.
    Crn string
    (String) The CRN of the source snapshot.
    DeleteSnapshotsOnDelete bool
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    Href string
    (String) The URL for this region.
    IsSnapshotConsistencyGroupId string
    (String) The unique identifier for the source snapshot.
    LifecycleState string
    (String) The lifecycle state of this snapshot consistency group.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    ResourceGroup string
    The resource group ID where the snapshot consistency group is to be created.
    ResourceType string
    (String) The resource type.
    ServiceTags List<string>
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    SnapshotReferences List<IsSnapshotConsistencyGroupSnapshotReference>
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    Snapshots List<IsSnapshotConsistencyGroupSnapshot>

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    Tags List<string>
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    AccessTags []string

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    BackupPolicyPlans []IsSnapshotConsistencyGroupBackupPolicyPlanArgs
    (List) If present, the backup policy plan which created this snapshot consistency group.
    CreatedAt string
    (String) The date and time that this snapshot consistency group was created.
    Crn string
    (String) The CRN of the source snapshot.
    DeleteSnapshotsOnDelete bool
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    Href string
    (String) The URL for this region.
    IsSnapshotConsistencyGroupId string
    (String) The unique identifier for the source snapshot.
    LifecycleState string
    (String) The lifecycle state of this snapshot consistency group.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    ResourceGroup string
    The resource group ID where the snapshot consistency group is to be created.
    ResourceType string
    (String) The resource type.
    ServiceTags []string
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    SnapshotReferences []IsSnapshotConsistencyGroupSnapshotReferenceArgs
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    Snapshots []IsSnapshotConsistencyGroupSnapshotArgs

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    Tags []string
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    accessTags List<String>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    backupPolicyPlans List<IsSnapshotConsistencyGroupBackupPolicyPlan>
    (List) If present, the backup policy plan which created this snapshot consistency group.
    createdAt String
    (String) The date and time that this snapshot consistency group was created.
    crn String
    (String) The CRN of the source snapshot.
    deleteSnapshotsOnDelete Boolean
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    href String
    (String) The URL for this region.
    isSnapshotConsistencyGroupId String
    (String) The unique identifier for the source snapshot.
    lifecycleState String
    (String) The lifecycle state of this snapshot consistency group.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    resourceGroup String
    The resource group ID where the snapshot consistency group is to be created.
    resourceType String
    (String) The resource type.
    serviceTags List<String>
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    snapshotReferences List<IsSnapshotConsistencyGroupSnapshotReference>
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    snapshots List<IsSnapshotConsistencyGroupSnapshot>

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    tags List<String>
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    accessTags string[]

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    backupPolicyPlans IsSnapshotConsistencyGroupBackupPolicyPlan[]
    (List) If present, the backup policy plan which created this snapshot consistency group.
    createdAt string
    (String) The date and time that this snapshot consistency group was created.
    crn string
    (String) The CRN of the source snapshot.
    deleteSnapshotsOnDelete boolean
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    href string
    (String) The URL for this region.
    isSnapshotConsistencyGroupId string
    (String) The unique identifier for the source snapshot.
    lifecycleState string
    (String) The lifecycle state of this snapshot consistency group.
    name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    resourceGroup string
    The resource group ID where the snapshot consistency group is to be created.
    resourceType string
    (String) The resource type.
    serviceTags string[]
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    snapshotReferences IsSnapshotConsistencyGroupSnapshotReference[]
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    snapshots IsSnapshotConsistencyGroupSnapshot[]

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    tags string[]
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    access_tags Sequence[str]

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    backup_policy_plans Sequence[IsSnapshotConsistencyGroupBackupPolicyPlanArgs]
    (List) If present, the backup policy plan which created this snapshot consistency group.
    created_at str
    (String) The date and time that this snapshot consistency group was created.
    crn str
    (String) The CRN of the source snapshot.
    delete_snapshots_on_delete bool
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    href str
    (String) The URL for this region.
    is_snapshot_consistency_group_id str
    (String) The unique identifier for the source snapshot.
    lifecycle_state str
    (String) The lifecycle state of this snapshot consistency group.
    name str
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    resource_group str
    The resource group ID where the snapshot consistency group is to be created.
    resource_type str
    (String) The resource type.
    service_tags Sequence[str]
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    snapshot_references Sequence[IsSnapshotConsistencyGroupSnapshotReferenceArgs]
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    snapshots Sequence[IsSnapshotConsistencyGroupSnapshotArgs]

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    tags Sequence[str]
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    accessTags List<String>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    backupPolicyPlans List<Property Map>
    (List) If present, the backup policy plan which created this snapshot consistency group.
    createdAt String
    (String) The date and time that this snapshot consistency group was created.
    crn String
    (String) The CRN of the source snapshot.
    deleteSnapshotsOnDelete Boolean
    Indicates whether deleting the snapshot consistency group will also delete the snapshots in the group.
    href String
    (String) The URL for this region.
    isSnapshotConsistencyGroupId String
    (String) The unique identifier for the source snapshot.
    lifecycleState String
    (String) The lifecycle state of this snapshot consistency group.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    resourceGroup String
    The resource group ID where the snapshot consistency group is to be created.
    resourceType String
    (String) The resource type.
    serviceTags List<String>
    (List) The service tagsis.instance: prefix associated with this snapshot consistency group.
    snapshotReferences List<Property Map>
    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).
    snapshots List<Property Map>

    The member snapshots that are data-consistent with respect to captured time. (may bedeleted).

    Nested schema for snapshots:

    tags List<String>
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

    Supporting Types

    IsSnapshotConsistencyGroupBackupPolicyPlan, IsSnapshotConsistencyGroupBackupPolicyPlanArgs

    Deleteds List<IsSnapshotConsistencyGroupBackupPolicyPlanDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this region.
    Id string
    (String) The unique identifier for the source snapshot.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    Remotes List<IsSnapshotConsistencyGroupBackupPolicyPlanRemote>
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    ResourceType string
    (String) The resource type.
    Deleteds []IsSnapshotConsistencyGroupBackupPolicyPlanDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this region.
    Id string
    (String) The unique identifier for the source snapshot.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    Remotes []IsSnapshotConsistencyGroupBackupPolicyPlanRemote
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    ResourceType string
    (String) The resource type.
    deleteds List<IsSnapshotConsistencyGroupBackupPolicyPlanDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this region.
    id String
    (String) The unique identifier for the source snapshot.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    remotes List<IsSnapshotConsistencyGroupBackupPolicyPlanRemote>
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    resourceType String
    (String) The resource type.
    deleteds IsSnapshotConsistencyGroupBackupPolicyPlanDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href string
    (String) The URL for this region.
    id string
    (String) The unique identifier for the source snapshot.
    name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    remotes IsSnapshotConsistencyGroupBackupPolicyPlanRemote[]
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    resourceType string
    (String) The resource type.
    deleteds Sequence[IsSnapshotConsistencyGroupBackupPolicyPlanDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href str
    (String) The URL for this region.
    id str
    (String) The unique identifier for the source snapshot.
    name str
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    remotes Sequence[IsSnapshotConsistencyGroupBackupPolicyPlanRemote]
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    resource_type str
    (String) The resource type.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this region.
    id String
    (String) The unique identifier for the source snapshot.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    remotes List<Property Map>
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    resourceType String
    (String) The resource type.

    IsSnapshotConsistencyGroupBackupPolicyPlanDeleted, IsSnapshotConsistencyGroupBackupPolicyPlanDeletedArgs

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.

    IsSnapshotConsistencyGroupBackupPolicyPlanRemote, IsSnapshotConsistencyGroupBackupPolicyPlanRemoteArgs

    Href string
    (String) The URL for this region.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    Href string
    (String) The URL for this region.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    href String
    (String) The URL for this region.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    href string
    (String) The URL for this region.
    name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    href str
    (String) The URL for this region.
    name str
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    href String
    (String) The URL for this region.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.

    IsSnapshotConsistencyGroupSnapshot, IsSnapshotConsistencyGroupSnapshotArgs

    SourceVolume string
    The unique identifier for the volume for which snapshot is to be created.
    Name string
    The name for this snapshot.
    Tags List<string>
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    SourceVolume string
    The unique identifier for the volume for which snapshot is to be created.
    Name string
    The name for this snapshot.
    Tags []string
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    sourceVolume String
    The unique identifier for the volume for which snapshot is to be created.
    name String
    The name for this snapshot.
    tags List<String>
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    sourceVolume string
    The unique identifier for the volume for which snapshot is to be created.
    name string
    The name for this snapshot.
    tags string[]
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    source_volume str
    The unique identifier for the volume for which snapshot is to be created.
    name str
    The name for this snapshot.
    tags Sequence[str]
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    sourceVolume String
    The unique identifier for the volume for which snapshot is to be created.
    name String
    The name for this snapshot.
    tags List<String>
    A list of user tags that you want to add to your snapshot. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

    IsSnapshotConsistencyGroupSnapshotReference, IsSnapshotConsistencyGroupSnapshotReferenceArgs

    Crn string
    (String) The CRN of the source snapshot.
    Deleteds List<IsSnapshotConsistencyGroupSnapshotReferenceDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this region.
    Id string
    (String) The unique identifier for the source snapshot.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    Remotes List<IsSnapshotConsistencyGroupSnapshotReferenceRemote>
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    ResourceType string
    (String) The resource type.
    Crn string
    (String) The CRN of the source snapshot.
    Deleteds []IsSnapshotConsistencyGroupSnapshotReferenceDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this region.
    Id string
    (String) The unique identifier for the source snapshot.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    Remotes []IsSnapshotConsistencyGroupSnapshotReferenceRemote
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    ResourceType string
    (String) The resource type.
    crn String
    (String) The CRN of the source snapshot.
    deleteds List<IsSnapshotConsistencyGroupSnapshotReferenceDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this region.
    id String
    (String) The unique identifier for the source snapshot.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    remotes List<IsSnapshotConsistencyGroupSnapshotReferenceRemote>
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    resourceType String
    (String) The resource type.
    crn string
    (String) The CRN of the source snapshot.
    deleteds IsSnapshotConsistencyGroupSnapshotReferenceDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href string
    (String) The URL for this region.
    id string
    (String) The unique identifier for the source snapshot.
    name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    remotes IsSnapshotConsistencyGroupSnapshotReferenceRemote[]
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    resourceType string
    (String) The resource type.
    crn str
    (String) The CRN of the source snapshot.
    deleteds Sequence[IsSnapshotConsistencyGroupSnapshotReferenceDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href str
    (String) The URL for this region.
    id str
    (String) The unique identifier for the source snapshot.
    name str
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    remotes Sequence[IsSnapshotConsistencyGroupSnapshotReferenceRemote]
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    resource_type str
    (String) The resource type.
    crn String
    (String) The CRN of the source snapshot.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this region.
    id String
    (String) The unique identifier for the source snapshot.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    remotes List<Property Map>
    (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region
    resourceType String
    (String) The resource type.

    IsSnapshotConsistencyGroupSnapshotReferenceDeleted, IsSnapshotConsistencyGroupSnapshotReferenceDeletedArgs

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.

    IsSnapshotConsistencyGroupSnapshotReferenceRemote, IsSnapshotConsistencyGroupSnapshotReferenceRemoteArgs

    Href string
    (String) The URL for this region.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    Href string
    (String) The URL for this region.
    Name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    href String
    (String) The URL for this region.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    href string
    (String) The URL for this region.
    name string
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    href str
    (String) The URL for this region.
    name str
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.
    href String
    (String) The URL for this region.
    name String
    The name for this snapshot consistency group. The name is unique across all snapshot consistency groups in the region.

    Import

    You can import the ibm_is_snapshot_consistency_group resource by using id. The unique identifier for this snapshot consistency group.

    Syntax

    $ pulumi import ibm:index/isSnapshotConsistencyGroup:IsSnapshotConsistencyGroup is_snapshot_consistency_group <id>

    Example

    $ pulumi import ibm:index/isSnapshotConsistencyGroup:IsSnapshotConsistencyGroup is_snapshot_consistency_group r134-fa329f6b-0e36-433f-a3bb-0df632e79263

    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 logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm