ibm 1.78.0, Apr 30 25

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

ibm.IsSnapshot

Explore with Pulumi AI

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

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

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVpc;
import com.pulumi.ibm.IsSubnet;
import com.pulumi.ibm.IsSubnetArgs;
import com.pulumi.ibm.IsSshKey;
import com.pulumi.ibm.IsSshKeyArgs;
import com.pulumi.ibm.IsInstance;
import com.pulumi.ibm.IsInstanceArgs;
import com.pulumi.ibm.inputs.IsInstancePrimaryNetworkInterfaceArgs;
import com.pulumi.ibm.inputs.IsInstanceNetworkInterfaceArgs;
import com.pulumi.ibm.IsSnapshot;
import com.pulumi.ibm.IsSnapshotArgs;
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 exampleIsVpc = new IsVpc("exampleIsVpc");

        var exampleIsSubnet = new IsSubnet("exampleIsSubnet", IsSubnetArgs.builder()
            .vpc(exampleIsVpc.isVpcId())
            .zone("us-south-2")
            .totalIpv4AddressCount(16)
            .build());

        var exampleIsSshKey = new IsSshKey("exampleIsSshKey", IsSshKeyArgs.builder()
            .publicKey("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR")
            .build());

        var exampleIsInstance = new IsInstance("exampleIsInstance", IsInstanceArgs.builder()
            .image(ibm_is_image.example().id())
            .profile("bx2-2x8")
            .primaryNetworkInterface(IsInstancePrimaryNetworkInterfaceArgs.builder()
                .subnet(exampleIsSubnet.isSubnetId())
                .build())
            .vpc(exampleIsVpc.isVpcId())
            .zone("us-south-2")
            .keys(exampleIsSshKey.isSshKeyId())
            .networkInterfaces(IsInstanceNetworkInterfaceArgs.builder()
                .subnet(exampleIsSubnet.isSubnetId())
                .name("eth1")
                .build())
            .build());

        var exampleIsSnapshot = new IsSnapshot("exampleIsSnapshot", IsSnapshotArgs.builder()
            .sourceVolume(exampleIsInstance.volumeAttachments().applyValue(volumeAttachments -> volumeAttachments[0].volumeId()))
            .timeouts(IsSnapshotTimeoutsArgs.builder()
                .create("15m")
                .delete("15m")
                .build())
            .build());

    }
}

resources:
  exampleIsVpc:
    type: ibm:IsVpc
  exampleIsSubnet:
    type: ibm:IsSubnet
    properties:
      vpc: ${exampleIsVpc.isVpcId}
      zone: us-south-2
      totalIpv4AddressCount: 16
  exampleIsSshKey:
    type: ibm:IsSshKey
    properties:
      publicKey: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR
  exampleIsInstance:
    type: ibm:IsInstance
    properties:
      image: ${ibm_is_image.example.id}
      profile: bx2-2x8
      primaryNetworkInterface:
        subnet: ${exampleIsSubnet.isSubnetId}
      vpc: ${exampleIsVpc.isVpcId}
      zone: us-south-2
      keys:
        - ${exampleIsSshKey.isSshKeyId}
      networkInterfaces:
        - subnet: ${exampleIsSubnet.isSubnetId}
          name: eth1
  exampleIsSnapshot:
    type: ibm:IsSnapshot
    properties:
      sourceVolume: ${exampleIsInstance.volumeAttachments[0].volumeId}
      # User can configure timeouts
      timeouts:
        - create: 15m
          delete: 15m

Clones)

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsSnapshot;
import com.pulumi.ibm.IsSnapshotArgs;
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 exampleClones = new IsSnapshot("exampleClones", IsSnapshotArgs.builder()
            .sourceVolume(ibm_is_instance.example().volume_attachments()[0].volume_id())
            .clones(            
                "us-south-1",
                "us-south-2")
            .timeouts(IsSnapshotTimeoutsArgs.builder()
                .create("15m")
                .delete("15m")
                .build())
            .build());

    }
}

resources:
  exampleClones:
    type: ibm:IsSnapshot
    properties:
      sourceVolume: ${ibm_is_instance.example.volume_attachments[0].volume_id}
      clones:
        - us-south-1
        - us-south-2
      # User can configure timeouts
      timeouts:
        - create: 15m
          delete: 15m

Source Snasphot - Cross Region Snapshot Crn)

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

const exampleCopy = new ibm.IsSnapshot("exampleCopy", {sourceSnapshotCrn: "crn:v1:bluemix:public:is:us-south:a/xxxxxxxxxxxxxxxxxxxxxxxx::snapshot:r006-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"});

import pulumi
import pulumi_ibm as ibm

example_copy = ibm.IsSnapshot("exampleCopy", source_snapshot_crn="crn:v1:bluemix:public:is:us-south:a/xxxxxxxxxxxxxxxxxxxxxxxx::snapshot:r006-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx")

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.NewIsSnapshot(ctx, "exampleCopy", &ibm.IsSnapshotArgs{
			SourceSnapshotCrn: pulumi.String("crn:v1:bluemix:public:is:us-south:a/xxxxxxxxxxxxxxxxxxxxxxxx::snapshot:r006-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"),
		})
		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 exampleCopy = new Ibm.IsSnapshot("exampleCopy", new()
    {
        SourceSnapshotCrn = "crn:v1:bluemix:public:is:us-south:a/xxxxxxxxxxxxxxxxxxxxxxxx::snapshot:r006-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsSnapshot;
import com.pulumi.ibm.IsSnapshotArgs;
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 exampleCopy = new IsSnapshot("exampleCopy", IsSnapshotArgs.builder()
            .sourceSnapshotCrn("crn:v1:bluemix:public:is:us-south:a/xxxxxxxxxxxxxxxxxxxxxxxx::snapshot:r006-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx")
            .build());

    }
}

resources:
  exampleCopy:
    type: ibm:IsSnapshot
    properties:
      sourceSnapshotCrn: crn:v1:bluemix:public:is:us-south:a/xxxxxxxxxxxxxxxxxxxxxxxx::snapshot:r006-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx

Create IsSnapshot Resource

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

Constructor syntax

new IsSnapshot(name: string, args?: IsSnapshotArgs, opts?: CustomResourceOptions);

@overload
def IsSnapshot(resource_name: str,
               args: Optional[IsSnapshotArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def IsSnapshot(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               access_tags: Optional[Sequence[str]] = None,
               clones: Optional[Sequence[str]] = None,
               encryption_key: Optional[str] = None,
               is_snapshot_id: Optional[str] = None,
               name: Optional[str] = None,
               resource_group: Optional[str] = None,
               source_snapshot_crn: Optional[str] = None,
               source_volume: Optional[str] = None,
               tags: Optional[Sequence[str]] = None,
               timeouts: Optional[IsSnapshotTimeoutsArgs] = None)

func NewIsSnapshot(ctx *Context, name string, args *IsSnapshotArgs, opts ...ResourceOption) (*IsSnapshot, error)

public IsSnapshot(string name, IsSnapshotArgs? args = null, CustomResourceOptions? opts = null)

public IsSnapshot(String name, IsSnapshotArgs args)
public IsSnapshot(String name, IsSnapshotArgs args, CustomResourceOptions options)

type: ibm:IsSnapshot
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 IsSnapshotArgs: 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 IsSnapshotArgs: 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 IsSnapshotArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IsSnapshotArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IsSnapshotArgs: 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 isSnapshotResource = new Ibm.IsSnapshot("isSnapshotResource", new()
{
    AccessTags = new[]
    {
        "string",
    },
    Clones = new[]
    {
        "string",
    },
    EncryptionKey = "string",
    IsSnapshotId = "string",
    Name = "string",
    ResourceGroup = "string",
    SourceSnapshotCrn = "string",
    SourceVolume = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.IsSnapshotTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

example, err := ibm.NewIsSnapshot(ctx, "isSnapshotResource", &ibm.IsSnapshotArgs{
	AccessTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Clones: pulumi.StringArray{
		pulumi.String("string"),
	},
	EncryptionKey:     pulumi.String("string"),
	IsSnapshotId:      pulumi.String("string"),
	Name:              pulumi.String("string"),
	ResourceGroup:     pulumi.String("string"),
	SourceSnapshotCrn: pulumi.String("string"),
	SourceVolume:      pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.IsSnapshotTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

var isSnapshotResource = new IsSnapshot("isSnapshotResource", IsSnapshotArgs.builder()
    .accessTags("string")
    .clones("string")
    .encryptionKey("string")
    .isSnapshotId("string")
    .name("string")
    .resourceGroup("string")
    .sourceSnapshotCrn("string")
    .sourceVolume("string")
    .tags("string")
    .timeouts(IsSnapshotTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

is_snapshot_resource = ibm.IsSnapshot("isSnapshotResource",
    access_tags=["string"],
    clones=["string"],
    encryption_key="string",
    is_snapshot_id="string",
    name="string",
    resource_group="string",
    source_snapshot_crn="string",
    source_volume="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
    })

const isSnapshotResource = new ibm.IsSnapshot("isSnapshotResource", {
    accessTags: ["string"],
    clones: ["string"],
    encryptionKey: "string",
    isSnapshotId: "string",
    name: "string",
    resourceGroup: "string",
    sourceSnapshotCrn: "string",
    sourceVolume: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

type: ibm:IsSnapshot
properties:
    accessTags:
        - string
    clones:
        - string
    encryptionKey: string
    isSnapshotId: string
    name: string
    resourceGroup: string
    sourceSnapshotCrn: string
    sourceVolume: string
    tags:
        - string
    timeouts:
        create: string
        delete: string

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

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.
Clones List<string>: The list of zones to create a clone of this snapshot.
EncryptionKey string: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
IsSnapshotId string: (String) The unique identifier for the source snapshot.
Name string: The name of the snapshot.
ResourceGroup string: The resource group ID where the snapshot is to be created
SourceSnapshotCrn string: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
SourceVolume string: The unique identifier for the volume for which snapshot 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)
Timeouts IsSnapshotTimeouts

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.
Clones []string: The list of zones to create a clone of this snapshot.
EncryptionKey string: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
IsSnapshotId string: (String) The unique identifier for the source snapshot.
Name string: The name of the snapshot.
ResourceGroup string: The resource group ID where the snapshot is to be created
SourceSnapshotCrn string: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
SourceVolume string: The unique identifier for the volume for which snapshot 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)
Timeouts IsSnapshotTimeoutsArgs

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.
clones List<String>: The list of zones to create a clone of this snapshot.
encryptionKey String: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
isSnapshotId String: (String) The unique identifier for the source snapshot.
name String: The name of the snapshot.
resourceGroup String: The resource group ID where the snapshot is to be created
sourceSnapshotCrn String: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
sourceVolume String: The unique identifier for the volume for which snapshot 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)
timeouts IsSnapshotTimeouts

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.
clones string[]: The list of zones to create a clone of this snapshot.
encryptionKey string: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
isSnapshotId string: (String) The unique identifier for the source snapshot.
name string: The name of the snapshot.
resourceGroup string: The resource group ID where the snapshot is to be created
sourceSnapshotCrn string: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
sourceVolume string: The unique identifier for the volume for which snapshot 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)
timeouts IsSnapshotTimeouts

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.
clones Sequence[str]: The list of zones to create a clone of this snapshot.
encryption_key str: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
is_snapshot_id str: (String) The unique identifier for the source snapshot.
name str: The name of the snapshot.
resource_group str: The resource group ID where the snapshot is to be created
source_snapshot_crn str: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
source_volume str: The unique identifier for the volume for which snapshot 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)
timeouts IsSnapshotTimeoutsArgs

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.
clones List<String>: The list of zones to create a clone of this snapshot.
encryptionKey String: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
isSnapshotId String: (String) The unique identifier for the source snapshot.
name String: The name of the snapshot.
resourceGroup String: The resource group ID where the snapshot is to be created
sourceSnapshotCrn String: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
sourceVolume String: The unique identifier for the volume for which snapshot 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)
timeouts Property Map

Outputs

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

BackupPolicyPlans List<IsSnapshotBackupPolicyPlan>: (List) If present, the backup policy plan which created this snapshot.
Bootable bool: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
CatalogOfferings List<IsSnapshotCatalogOffering>: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
Copies List<IsSnapshotCopy>: (List) The copies of this snapshot in other regions.
Crn string: (String) The CRN of the source snapshot.
Encryption string: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
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. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
MinimumCapacity double: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
OperatingSystem string: (String) The globally unique name for an Operating System included in this image.
ResourceType string: (String) The resource type.
ServiceTags List<string>: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
Size double: (Integer) The size of this snapshot rounded up to the next gigabyte.
SnapshotConsistencyGroups List<IsSnapshotSnapshotConsistencyGroup>: (List) The snapshot consistency group which created this snapshot.
SourceImage string: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
SourceSnapshots List<IsSnapshotSourceSnapshot>: (String) If present, the source snapshot this snapshot was created from.

BackupPolicyPlans []IsSnapshotBackupPolicyPlan: (List) If present, the backup policy plan which created this snapshot.
Bootable bool: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
CatalogOfferings []IsSnapshotCatalogOffering: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
Copies []IsSnapshotCopy: (List) The copies of this snapshot in other regions.
Crn string: (String) The CRN of the source snapshot.
Encryption string: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
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. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
MinimumCapacity float64: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
OperatingSystem string: (String) The globally unique name for an Operating System included in this image.
ResourceType string: (String) The resource type.
ServiceTags []string: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
Size float64: (Integer) The size of this snapshot rounded up to the next gigabyte.
SnapshotConsistencyGroups []IsSnapshotSnapshotConsistencyGroup: (List) The snapshot consistency group which created this snapshot.
SourceImage string: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
SourceSnapshots []IsSnapshotSourceSnapshot: (String) If present, the source snapshot this snapshot was created from.

backupPolicyPlans List<IsSnapshotBackupPolicyPlan>: (List) If present, the backup policy plan which created this snapshot.
bootable Boolean: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
catalogOfferings List<IsSnapshotCatalogOffering>: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
copies List<IsSnapshotCopy>: (List) The copies of this snapshot in other regions.
crn String: (String) The CRN of the source snapshot.
encryption String: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
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. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
minimumCapacity Double: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
operatingSystem String: (String) The globally unique name for an Operating System included in this image.
resourceType String: (String) The resource type.
serviceTags List<String>: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
size Double: (Integer) The size of this snapshot rounded up to the next gigabyte.
snapshotConsistencyGroups List<IsSnapshotSnapshotConsistencyGroup>: (List) The snapshot consistency group which created this snapshot.
sourceImage String: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
sourceSnapshots List<IsSnapshotSourceSnapshot>: (String) If present, the source snapshot this snapshot was created from.

backupPolicyPlans IsSnapshotBackupPolicyPlan[]: (List) If present, the backup policy plan which created this snapshot.
bootable boolean: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
catalogOfferings IsSnapshotCatalogOffering[]: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
copies IsSnapshotCopy[]: (List) The copies of this snapshot in other regions.
crn string: (String) The CRN of the source snapshot.
encryption string: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
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. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
minimumCapacity number: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
operatingSystem string: (String) The globally unique name for an Operating System included in this image.
resourceType string: (String) The resource type.
serviceTags string[]: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
size number: (Integer) The size of this snapshot rounded up to the next gigabyte.
snapshotConsistencyGroups IsSnapshotSnapshotConsistencyGroup[]: (List) The snapshot consistency group which created this snapshot.
sourceImage string: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
sourceSnapshots IsSnapshotSourceSnapshot[]: (String) If present, the source snapshot this snapshot was created from.

backup_policy_plans Sequence[IsSnapshotBackupPolicyPlan]: (List) If present, the backup policy plan which created this snapshot.
bootable bool: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
catalog_offerings Sequence[IsSnapshotCatalogOffering]: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
copies Sequence[IsSnapshotCopy]: (List) The copies of this snapshot in other regions.
crn str: (String) The CRN of the source snapshot.
encryption str: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
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. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
minimum_capacity float: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
operating_system str: (String) The globally unique name for an Operating System included in this image.
resource_type str: (String) The resource type.
service_tags Sequence[str]: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
size float: (Integer) The size of this snapshot rounded up to the next gigabyte.
snapshot_consistency_groups Sequence[IsSnapshotSnapshotConsistencyGroup]: (List) The snapshot consistency group which created this snapshot.
source_image str: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
source_snapshots Sequence[IsSnapshotSourceSnapshot]: (String) If present, the source snapshot this snapshot was created from.

backupPolicyPlans List<Property Map>: (List) If present, the backup policy plan which created this snapshot.
bootable Boolean: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
catalogOfferings List<Property Map>: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
copies List<Property Map>: (List) The copies of this snapshot in other regions.
crn String: (String) The CRN of the source snapshot.
encryption String: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
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. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
minimumCapacity Number: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
operatingSystem String: (String) The globally unique name for an Operating System included in this image.
resourceType String: (String) The resource type.
serviceTags List<String>: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
size Number: (Integer) The size of this snapshot rounded up to the next gigabyte.
snapshotConsistencyGroups List<Property Map>: (List) The snapshot consistency group which created this snapshot.
sourceImage String: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
sourceSnapshots List<Property Map>: (String) If present, the source snapshot this snapshot was created from.

Look up Existing IsSnapshot Resource

Get an existing IsSnapshot 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?: IsSnapshotState, opts?: CustomResourceOptions): IsSnapshot

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tags: Optional[Sequence[str]] = None,
        backup_policy_plans: Optional[Sequence[IsSnapshotBackupPolicyPlanArgs]] = None,
        bootable: Optional[bool] = None,
        catalog_offerings: Optional[Sequence[IsSnapshotCatalogOfferingArgs]] = None,
        clones: Optional[Sequence[str]] = None,
        copies: Optional[Sequence[IsSnapshotCopyArgs]] = None,
        crn: Optional[str] = None,
        encryption: Optional[str] = None,
        encryption_key: Optional[str] = None,
        href: Optional[str] = None,
        is_snapshot_id: Optional[str] = None,
        lifecycle_state: Optional[str] = None,
        minimum_capacity: Optional[float] = None,
        name: Optional[str] = None,
        operating_system: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_type: Optional[str] = None,
        service_tags: Optional[Sequence[str]] = None,
        size: Optional[float] = None,
        snapshot_consistency_groups: Optional[Sequence[IsSnapshotSnapshotConsistencyGroupArgs]] = None,
        source_image: Optional[str] = None,
        source_snapshot_crn: Optional[str] = None,
        source_snapshots: Optional[Sequence[IsSnapshotSourceSnapshotArgs]] = None,
        source_volume: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[IsSnapshotTimeoutsArgs] = None) -> IsSnapshot

func GetIsSnapshot(ctx *Context, name string, id IDInput, state *IsSnapshotState, opts ...ResourceOption) (*IsSnapshot, error)

public static IsSnapshot Get(string name, Input<string> id, IsSnapshotState? state, CustomResourceOptions? opts = null)

public static IsSnapshot get(String name, Output<String> id, IsSnapshotState state, CustomResourceOptions options)

resources:  _:    type: ibm:IsSnapshot    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<IsSnapshotBackupPolicyPlan>: (List) If present, the backup policy plan which created this snapshot.
Bootable bool: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
CatalogOfferings List<IsSnapshotCatalogOffering>: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
Clones List<string>: The list of zones to create a clone of this snapshot.
Copies List<IsSnapshotCopy>: (List) The copies of this snapshot in other regions.
Crn string: (String) The CRN of the source snapshot.
Encryption string: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
EncryptionKey string: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
Href string: (String) The URL for this region.
IsSnapshotId string: (String) The unique identifier for the source snapshot.
LifecycleState string: (String) The lifecycle state of this snapshot. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
MinimumCapacity double: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
Name string: The name of the snapshot.
OperatingSystem string: (String) The globally unique name for an Operating System included in this image.
ResourceGroup string: The resource group ID where the snapshot is to be created
ResourceType string: (String) The resource type.
ServiceTags List<string>: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
Size double: (Integer) The size of this snapshot rounded up to the next gigabyte.
SnapshotConsistencyGroups List<IsSnapshotSnapshotConsistencyGroup>: (List) The snapshot consistency group which created this snapshot.
SourceImage string: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
SourceSnapshotCrn string: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
SourceSnapshots List<IsSnapshotSourceSnapshot>: (String) If present, the source snapshot this snapshot was created from.
SourceVolume string: The unique identifier for the volume for which snapshot 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)
Timeouts IsSnapshotTimeouts

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 []IsSnapshotBackupPolicyPlanArgs: (List) If present, the backup policy plan which created this snapshot.
Bootable bool: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
CatalogOfferings []IsSnapshotCatalogOfferingArgs: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
Clones []string: The list of zones to create a clone of this snapshot.
Copies []IsSnapshotCopyArgs: (List) The copies of this snapshot in other regions.
Crn string: (String) The CRN of the source snapshot.
Encryption string: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
EncryptionKey string: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
Href string: (String) The URL for this region.
IsSnapshotId string: (String) The unique identifier for the source snapshot.
LifecycleState string: (String) The lifecycle state of this snapshot. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
MinimumCapacity float64: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
Name string: The name of the snapshot.
OperatingSystem string: (String) The globally unique name for an Operating System included in this image.
ResourceGroup string: The resource group ID where the snapshot is to be created
ResourceType string: (String) The resource type.
ServiceTags []string: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
Size float64: (Integer) The size of this snapshot rounded up to the next gigabyte.
SnapshotConsistencyGroups []IsSnapshotSnapshotConsistencyGroupArgs: (List) The snapshot consistency group which created this snapshot.
SourceImage string: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
SourceSnapshotCrn string: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
SourceSnapshots []IsSnapshotSourceSnapshotArgs: (String) If present, the source snapshot this snapshot was created from.
SourceVolume string: The unique identifier for the volume for which snapshot 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)
Timeouts IsSnapshotTimeoutsArgs

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<IsSnapshotBackupPolicyPlan>: (List) If present, the backup policy plan which created this snapshot.
bootable Boolean: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
catalogOfferings List<IsSnapshotCatalogOffering>: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
clones List<String>: The list of zones to create a clone of this snapshot.
copies List<IsSnapshotCopy>: (List) The copies of this snapshot in other regions.
crn String: (String) The CRN of the source snapshot.
encryption String: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
encryptionKey String: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
href String: (String) The URL for this region.
isSnapshotId String: (String) The unique identifier for the source snapshot.
lifecycleState String: (String) The lifecycle state of this snapshot. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
minimumCapacity Double: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
name String: The name of the snapshot.
operatingSystem String: (String) The globally unique name for an Operating System included in this image.
resourceGroup String: The resource group ID where the snapshot is to be created
resourceType String: (String) The resource type.
serviceTags List<String>: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
size Double: (Integer) The size of this snapshot rounded up to the next gigabyte.
snapshotConsistencyGroups List<IsSnapshotSnapshotConsistencyGroup>: (List) The snapshot consistency group which created this snapshot.
sourceImage String: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
sourceSnapshotCrn String: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
sourceSnapshots List<IsSnapshotSourceSnapshot>: (String) If present, the source snapshot this snapshot was created from.
sourceVolume String: The unique identifier for the volume for which snapshot 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)
timeouts IsSnapshotTimeouts

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 IsSnapshotBackupPolicyPlan[]: (List) If present, the backup policy plan which created this snapshot.
bootable boolean: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
catalogOfferings IsSnapshotCatalogOffering[]: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
clones string[]: The list of zones to create a clone of this snapshot.
copies IsSnapshotCopy[]: (List) The copies of this snapshot in other regions.
crn string: (String) The CRN of the source snapshot.
encryption string: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
encryptionKey string: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
href string: (String) The URL for this region.
isSnapshotId string: (String) The unique identifier for the source snapshot.
lifecycleState string: (String) The lifecycle state of this snapshot. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
minimumCapacity number: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
name string: The name of the snapshot.
operatingSystem string: (String) The globally unique name for an Operating System included in this image.
resourceGroup string: The resource group ID where the snapshot is to be created
resourceType string: (String) The resource type.
serviceTags string[]: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
size number: (Integer) The size of this snapshot rounded up to the next gigabyte.
snapshotConsistencyGroups IsSnapshotSnapshotConsistencyGroup[]: (List) The snapshot consistency group which created this snapshot.
sourceImage string: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
sourceSnapshotCrn string: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
sourceSnapshots IsSnapshotSourceSnapshot[]: (String) If present, the source snapshot this snapshot was created from.
sourceVolume string: The unique identifier for the volume for which snapshot 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)
timeouts IsSnapshotTimeouts

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[IsSnapshotBackupPolicyPlanArgs]: (List) If present, the backup policy plan which created this snapshot.
bootable bool: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
catalog_offerings Sequence[IsSnapshotCatalogOfferingArgs]: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
clones Sequence[str]: The list of zones to create a clone of this snapshot.
copies Sequence[IsSnapshotCopyArgs]: (List) The copies of this snapshot in other regions.
crn str: (String) The CRN of the source snapshot.
encryption str: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
encryption_key str: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
href str: (String) The URL for this region.
is_snapshot_id str: (String) The unique identifier for the source snapshot.
lifecycle_state str: (String) The lifecycle state of this snapshot. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
minimum_capacity float: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
name str: The name of the snapshot.
operating_system str: (String) The globally unique name for an Operating System included in this image.
resource_group str: The resource group ID where the snapshot is to be created
resource_type str: (String) The resource type.
service_tags Sequence[str]: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
size float: (Integer) The size of this snapshot rounded up to the next gigabyte.
snapshot_consistency_groups Sequence[IsSnapshotSnapshotConsistencyGroupArgs]: (List) The snapshot consistency group which created this snapshot.
source_image str: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
source_snapshot_crn str: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
source_snapshots Sequence[IsSnapshotSourceSnapshotArgs]: (String) If present, the source snapshot this snapshot was created from.
source_volume str: The unique identifier for the volume for which snapshot 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)
timeouts IsSnapshotTimeoutsArgs

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.
bootable Boolean: (Bool) Indicates if a boot volume attachment can be created with a volume created from this snapshot.
catalogOfferings List<Property Map>: (List) The catalog offering inherited from the snapshot's source. If a virtual server instance is provisioned with a source_snapshot specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
clones List<String>: The list of zones to create a clone of this snapshot.
copies List<Property Map>: (List) The copies of this snapshot in other regions.
crn String: (String) The CRN of the source snapshot.
encryption String: (String) The type of encryption used on the source volume. Supported values are provider_managed, user_managed.
encryptionKey String: A reference CRN to the root key used to wrap the data encryption key for the source snapshot.
href String: (String) The URL for this region.
isSnapshotId String: (String) The unique identifier for the source snapshot.
lifecycleState String: (String) The lifecycle state of this snapshot. Supported values are deleted, deleting, failed, pending, stable, updating, waiting, suspended.
minimumCapacity Number: (Integer) The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the source_volume.
name String: The name of the snapshot.
operatingSystem String: (String) The globally unique name for an Operating System included in this image.
resourceGroup String: The resource group ID where the snapshot is to be created
resourceType String: (String) The resource type.
serviceTags List<String>: (List) The service tags prefixed with is.snapshot: associated with this snapshot.
size Number: (Integer) The size of this snapshot rounded up to the next gigabyte.
snapshotConsistencyGroups List<Property Map>: (List) The snapshot consistency group which created this snapshot.
sourceImage String: (String) If present, the unique identifier for the image from which the data on this volume was most directly provisioned.
sourceSnapshotCrn String: The CRN for source snapshot.
Note source_volume and source_snapshot_crn are mutually exclusive, you can create snapshot either by a source volume or using another snapshot as a source.
sourceSnapshots List<Property Map>: (String) If present, the source snapshot this snapshot was created from.
sourceVolume String: The unique identifier for the volume for which snapshot 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)
timeouts Property Map

Supporting Types

IsSnapshotBackupPolicyPlan, IsSnapshotBackupPolicyPlanArgs

Deleteds List<IsSnapshotBackupPolicyPlanDeleted>: (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 of the snapshot.
ResourceType string: (String) The resource type.

Deleteds []IsSnapshotBackupPolicyPlanDeleted: (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 of the snapshot.
ResourceType string: (String) The resource type.

deleteds List<IsSnapshotBackupPolicyPlanDeleted>: (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 of the snapshot.
resourceType String: (String) The resource type.

deleteds IsSnapshotBackupPolicyPlanDeleted[]: (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 of the snapshot.
resourceType string: (String) The resource type.

deleteds Sequence[IsSnapshotBackupPolicyPlanDeleted]: (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 of the snapshot.
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 of the snapshot.
resourceType String: (String) The resource type.

IsSnapshotBackupPolicyPlanDeleted, IsSnapshotBackupPolicyPlanDeletedArgs

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.

IsSnapshotCatalogOffering, IsSnapshotCatalogOfferingArgs

Deleteds List<IsSnapshotCatalogOfferingDeleted>: (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
PlanCrn string: (String) The CRN for this catalog offering version's billing plan
VersionCrn string: (String) The CRN for this version of a catalog offering

Deleteds []IsSnapshotCatalogOfferingDeleted: (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
PlanCrn string: (String) The CRN for this catalog offering version's billing plan
VersionCrn string: (String) The CRN for this version of a catalog offering

deleteds List<IsSnapshotCatalogOfferingDeleted>: (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
planCrn String: (String) The CRN for this catalog offering version's billing plan
versionCrn String: (String) The CRN for this version of a catalog offering

deleteds IsSnapshotCatalogOfferingDeleted[]: (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
planCrn string: (String) The CRN for this catalog offering version's billing plan
versionCrn string: (String) The CRN for this version of a catalog offering

deleteds Sequence[IsSnapshotCatalogOfferingDeleted]: (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
plan_crn str: (String) The CRN for this catalog offering version's billing plan
version_crn str: (String) The CRN for this version of a catalog offering

deleteds List<Property Map>: (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
planCrn String: (String) The CRN for this catalog offering version's billing plan
versionCrn String: (String) The CRN for this version of a catalog offering

IsSnapshotCatalogOfferingDeleted, IsSnapshotCatalogOfferingDeletedArgs

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.

IsSnapshotCopy, IsSnapshotCopyArgs

Crn string: (String) The CRN of the source snapshot.
Deleteds List<IsSnapshotCopyDeleted>: (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 of the snapshot.
Remotes List<IsSnapshotCopyRemote>: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
ResourceType string: (String) The resource type.

Crn string: (String) The CRN of the source snapshot.
Deleteds []IsSnapshotCopyDeleted: (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 of the snapshot.
Remotes []IsSnapshotCopyRemote: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
ResourceType string: (String) The resource type.

crn String: (String) The CRN of the source snapshot.
deleteds List<IsSnapshotCopyDeleted>: (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 of the snapshot.
remotes List<IsSnapshotCopyRemote>: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
resourceType String: (String) The resource type.

crn string: (String) The CRN of the source snapshot.
deleteds IsSnapshotCopyDeleted[]: (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 of the snapshot.
remotes IsSnapshotCopyRemote[]: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
resourceType string: (String) The resource type.

crn str: (String) The CRN of the source snapshot.
deleteds Sequence[IsSnapshotCopyDeleted]: (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 of the snapshot.
remotes Sequence[IsSnapshotCopyRemote]: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
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 of the snapshot.
remotes List<Property Map>: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
resourceType String: (String) The resource type.

IsSnapshotCopyDeleted, IsSnapshotCopyDeletedArgs

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.

IsSnapshotCopyRemote, IsSnapshotCopyRemoteArgs

Href string: (String) The URL for this region.
Name string: The name of the snapshot.

Href string: (String) The URL for this region.
Name string: The name of the snapshot.

href String: (String) The URL for this region.
name String: The name of the snapshot.

href string: (String) The URL for this region.
name string: The name of the snapshot.

href str: (String) The URL for this region.
name str: The name of the snapshot.

href String: (String) The URL for this region.
name String: The name of the snapshot.

IsSnapshotSnapshotConsistencyGroup, IsSnapshotSnapshotConsistencyGroupArgs

Crn string: (String) The CRN of the source snapshot.
Deleteds List<IsSnapshotSnapshotConsistencyGroupDeleted>: (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 of the snapshot.
ResourceType string: (String) The resource type.

Crn string: (String) The CRN of the source snapshot.
Deleteds []IsSnapshotSnapshotConsistencyGroupDeleted: (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 of the snapshot.
ResourceType string: (String) The resource type.

crn String: (String) The CRN of the source snapshot.
deleteds List<IsSnapshotSnapshotConsistencyGroupDeleted>: (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 of the snapshot.
resourceType String: (String) The resource type.

crn string: (String) The CRN of the source snapshot.
deleteds IsSnapshotSnapshotConsistencyGroupDeleted[]: (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 of the snapshot.
resourceType string: (String) The resource type.

crn str: (String) The CRN of the source snapshot.
deleteds Sequence[IsSnapshotSnapshotConsistencyGroupDeleted]: (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 of the snapshot.
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 of the snapshot.
resourceType String: (String) The resource type.

IsSnapshotSnapshotConsistencyGroupDeleted, IsSnapshotSnapshotConsistencyGroupDeletedArgs

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.

IsSnapshotSourceSnapshot, IsSnapshotSourceSnapshotArgs

Crn string: (String) The CRN of the source snapshot.
Deleteds List<IsSnapshotSourceSnapshotDeleted>: (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 of the snapshot.
Remotes List<IsSnapshotSourceSnapshotRemote>: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
ResourceType string: (String) The resource type.

Crn string: (String) The CRN of the source snapshot.
Deleteds []IsSnapshotSourceSnapshotDeleted: (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 of the snapshot.
Remotes []IsSnapshotSourceSnapshotRemote: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
ResourceType string: (String) The resource type.

crn String: (String) The CRN of the source snapshot.
deleteds List<IsSnapshotSourceSnapshotDeleted>: (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 of the snapshot.
remotes List<IsSnapshotSourceSnapshotRemote>: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
resourceType String: (String) The resource type.

crn string: (String) The CRN of the source snapshot.
deleteds IsSnapshotSourceSnapshotDeleted[]: (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 of the snapshot.
remotes IsSnapshotSourceSnapshotRemote[]: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
resourceType string: (String) The resource type.

crn str: (String) The CRN of the source snapshot.
deleteds Sequence[IsSnapshotSourceSnapshotDeleted]: (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 of the snapshot.
remotes Sequence[IsSnapshotSourceSnapshotRemote]: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
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 of the snapshot.
remotes List<Property Map>: (List) If present, this property indicates the referenced resource is remote to this region,and identifies the native region. Nested scheme for remote:
resourceType String: (String) The resource type.

IsSnapshotSourceSnapshotDeleted, IsSnapshotSourceSnapshotDeletedArgs

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.

IsSnapshotSourceSnapshotRemote, IsSnapshotSourceSnapshotRemoteArgs

Href string: (String) The URL for this region.
Name string: The name of the snapshot.

Href string: (String) The URL for this region.
Name string: The name of the snapshot.

href String: (String) The URL for this region.
name String: The name of the snapshot.

href string: (String) The URL for this region.
name string: The name of the snapshot.

href str: (String) The URL for this region.
name str: The name of the snapshot.

href String: (String) The URL for this region.
name String: The name of the snapshot.

IsSnapshotTimeouts, IsSnapshotTimeoutsArgs

Create string
Delete string

Create string
Delete string

create String
delete String

create string
delete string

create str
delete str

create String
delete String

Import

The ibm_is_snapshot can be imported using ID.

Syntax

$ pulumi import ibm:index/isSnapshot:IsSnapshot example < id >

Example

$ pulumi import ibm:index/isSnapshot:IsSnapshot example d7bec597-4726-451f-8a63-e62e6f19c32c

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.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.IsSnapshot

On this page

On this page

Example Usage

Clones)

Source Snasphot - Cross Region Snapshot Crn)

Create IsSnapshot Resource

Constructor syntax

Parameters

Constructor example

IsSnapshot Resource Properties

Inputs

Outputs

Look up Existing IsSnapshot Resource

Supporting Types

IsSnapshotBackupPolicyPlan, IsSnapshotBackupPolicyPlanArgs

IsSnapshotBackupPolicyPlanDeleted, IsSnapshotBackupPolicyPlanDeletedArgs

IsSnapshotCatalogOffering, IsSnapshotCatalogOfferingArgs

IsSnapshotCatalogOfferingDeleted, IsSnapshotCatalogOfferingDeletedArgs

IsSnapshotCopy, IsSnapshotCopyArgs

IsSnapshotCopyDeleted, IsSnapshotCopyDeletedArgs

IsSnapshotCopyRemote, IsSnapshotCopyRemoteArgs

IsSnapshotSnapshotConsistencyGroup, IsSnapshotSnapshotConsistencyGroupArgs

IsSnapshotSnapshotConsistencyGroupDeleted, IsSnapshotSnapshotConsistencyGroupDeletedArgs

IsSnapshotSourceSnapshot, IsSnapshotSourceSnapshotArgs

IsSnapshotSourceSnapshotDeleted, IsSnapshotSourceSnapshotDeletedArgs

IsSnapshotSourceSnapshotRemote, IsSnapshotSourceSnapshotRemoteArgs

IsSnapshotTimeouts, IsSnapshotTimeoutsArgs

Import

Package Details

On this page

On this page