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

ibm.IsShareSnapshot

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 ShareSnapshots with this resource.

    Example Usage

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

const exampleIsShare = new ibm.IsShare("exampleIsShare", {
    zone: "us-south-1",
    size: 220,
    profile: "dp2",
});
const exampleIsShareSnapshot = new ibm.IsShareSnapshot("exampleIsShareSnapshot", {
    share: exampleIsShare.isShareId,
    tags: ["my-example-share-snapshot-tag"],
});

    import pulumi
import pulumi_ibm as ibm

example_is_share = ibm.IsShare("exampleIsShare",
    zone="us-south-1",
    size=220,
    profile="dp2")
example_is_share_snapshot = ibm.IsShareSnapshot("exampleIsShareSnapshot",
    share=example_is_share.is_share_id,
    tags=["my-example-share-snapshot-tag"])

    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 {
		exampleIsShare, err := ibm.NewIsShare(ctx, "exampleIsShare", &ibm.IsShareArgs{
			Zone:    pulumi.String("us-south-1"),
			Size:    pulumi.Float64(220),
			Profile: pulumi.String("dp2"),
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsShareSnapshot(ctx, "exampleIsShareSnapshot", &ibm.IsShareSnapshotArgs{
			Share: exampleIsShare.IsShareId,
			Tags: pulumi.StringArray{
				pulumi.String("my-example-share-snapshot-tag"),
			},
		})
		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 exampleIsShare = new Ibm.IsShare("exampleIsShare", new()
    {
        Zone = "us-south-1",
        Size = 220,
        Profile = "dp2",
    });

    var exampleIsShareSnapshot = new Ibm.IsShareSnapshot("exampleIsShareSnapshot", new()
    {
        Share = exampleIsShare.IsShareId,
        Tags = new[]
        {
            "my-example-share-snapshot-tag",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsShare;
import com.pulumi.ibm.IsShareArgs;
import com.pulumi.ibm.IsShareSnapshot;
import com.pulumi.ibm.IsShareSnapshotArgs;
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 exampleIsShare = new IsShare("exampleIsShare", IsShareArgs.builder()
            .zone("us-south-1")
            .size(220)
            .profile("dp2")
            .build());

        var exampleIsShareSnapshot = new IsShareSnapshot("exampleIsShareSnapshot", IsShareSnapshotArgs.builder()
            .share(exampleIsShare.isShareId())
            .tags("my-example-share-snapshot-tag")
            .build());

    }
}

    resources:
  exampleIsShare:
    type: ibm:IsShare
    properties:
      zone: us-south-1
      size: 220
      profile: dp2
  exampleIsShareSnapshot:
    type: ibm:IsShareSnapshot
    properties:
      share: ${exampleIsShare.isShareId}
      tags:
        - my-example-share-snapshot-tag

    Create IsShareSnapshot Resource

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

    Constructor syntax

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

@overload
def IsShareSnapshot(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    share: Optional[str] = None,
                    access_tags: Optional[Sequence[str]] = None,
                    is_share_snapshot_id: Optional[str] = None,
                    name: Optional[str] = None,
                    tags: Optional[Sequence[str]] = None)
    func NewIsShareSnapshot(ctx *Context, name string, args IsShareSnapshotArgs, opts ...ResourceOption) (*IsShareSnapshot, error)
    public IsShareSnapshot(string name, IsShareSnapshotArgs args, CustomResourceOptions? opts = null)
    public IsShareSnapshot(String name, IsShareSnapshotArgs args)
public IsShareSnapshot(String name, IsShareSnapshotArgs args, CustomResourceOptions options)

    type: ibm:IsShareSnapshot
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 IsShareSnapshotArgs
    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 IsShareSnapshotArgs
    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 IsShareSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsShareSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsShareSnapshotArgs
    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 isShareSnapshotResource = new Ibm.IsShareSnapshot("isShareSnapshotResource", new()
{
    Share = "string",
    AccessTags = new[]
    {
        "string",
    },
    IsShareSnapshotId = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := ibm.NewIsShareSnapshot(ctx, "isShareSnapshotResource", &ibm.IsShareSnapshotArgs{
	Share: pulumi.String("string"),
	AccessTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsShareSnapshotId: pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var isShareSnapshotResource = new IsShareSnapshot("isShareSnapshotResource", IsShareSnapshotArgs.builder()
    .share("string")
    .accessTags("string")
    .isShareSnapshotId("string")
    .name("string")
    .tags("string")
    .build());

    is_share_snapshot_resource = ibm.IsShareSnapshot("isShareSnapshotResource",
    share="string",
    access_tags=["string"],
    is_share_snapshot_id="string",
    name="string",
    tags=["string"])

    const isShareSnapshotResource = new ibm.IsShareSnapshot("isShareSnapshotResource", {
    share: "string",
    accessTags: ["string"],
    isShareSnapshotId: "string",
    name: "string",
    tags: ["string"],
});

    type: ibm:IsShareSnapshot
properties:
    accessTags:
        - string
    isShareSnapshotId: string
    name: string
    share: string
    tags:
        - string

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

    Share string
    The file share identifier.
    AccessTags List<string>
    List of access management tags
    IsShareSnapshotId string
    (String) The unique identifier for this resource group.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    Tags List<string>
    The user tags associated with this share snapshot.
    Share string
    The file share identifier.
    AccessTags []string
    List of access management tags
    IsShareSnapshotId string
    (String) The unique identifier for this resource group.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    Tags []string
    The user tags associated with this share snapshot.
    share String
    The file share identifier.
    accessTags List<String>
    List of access management tags
    isShareSnapshotId String
    (String) The unique identifier for this resource group.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    tags List<String>
    The user tags associated with this share snapshot.
    share string
    The file share identifier.
    accessTags string[]
    List of access management tags
    isShareSnapshotId string
    (String) The unique identifier for this resource group.
    name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    tags string[]
    The user tags associated with this share snapshot.
    share str
    The file share identifier.
    access_tags Sequence[str]
    List of access management tags
    is_share_snapshot_id str
    (String) The unique identifier for this resource group.
    name str
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    tags Sequence[str]
    The user tags associated with this share snapshot.
    share String
    The file share identifier.
    accessTags List<String>
    List of access management tags
    isShareSnapshotId String
    (String) The unique identifier for this resource group.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    tags List<String>
    The user tags associated with this share snapshot.

    Outputs

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

    BackupPolicyPlans List<IsShareSnapshotBackupPolicyPlan>
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    CapturedAt string
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    CreatedAt string
    (String) The date and time that the share snapshot was created.
    Crn string
    (String) The CRN for this share snapshot.
    Fingerprint string
    (String) The fingerprint for this snapshot.
    Href string
    (String) The URL for this zone.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleState string
    (String) The lifecycle state of this share snapshot.
    MinimumSize double
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    ResourceGroups List<IsShareSnapshotResourceGroup>
    (List) The resource group for this file share. Nested schema for resource_group:
    ResourceType string
    (String) The resource type.
    ShareSnapshot string
    (String) The unique identifier for this share snapshot.
    Status string
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    StatusReasons List<IsShareSnapshotStatusReason>
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    Zones List<IsShareSnapshotZone>
    (List) The zone this share snapshot resides in. Nested schema for zone:
    BackupPolicyPlans []IsShareSnapshotBackupPolicyPlan
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    CapturedAt string
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    CreatedAt string
    (String) The date and time that the share snapshot was created.
    Crn string
    (String) The CRN for this share snapshot.
    Fingerprint string
    (String) The fingerprint for this snapshot.
    Href string
    (String) The URL for this zone.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleState string
    (String) The lifecycle state of this share snapshot.
    MinimumSize float64
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    ResourceGroups []IsShareSnapshotResourceGroup
    (List) The resource group for this file share. Nested schema for resource_group:
    ResourceType string
    (String) The resource type.
    ShareSnapshot string
    (String) The unique identifier for this share snapshot.
    Status string
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    StatusReasons []IsShareSnapshotStatusReason
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    Zones []IsShareSnapshotZone
    (List) The zone this share snapshot resides in. Nested schema for zone:
    backupPolicyPlans List<IsShareSnapshotBackupPolicyPlan>
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    capturedAt String
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    createdAt String
    (String) The date and time that the share snapshot was created.
    crn String
    (String) The CRN for this share snapshot.
    fingerprint String
    (String) The fingerprint for this snapshot.
    href String
    (String) The URL for this zone.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleState String
    (String) The lifecycle state of this share snapshot.
    minimumSize Double
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    resourceGroups List<IsShareSnapshotResourceGroup>
    (List) The resource group for this file share. Nested schema for resource_group:
    resourceType String
    (String) The resource type.
    shareSnapshot String
    (String) The unique identifier for this share snapshot.
    status String
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    statusReasons List<IsShareSnapshotStatusReason>
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    zones List<IsShareSnapshotZone>
    (List) The zone this share snapshot resides in. Nested schema for zone:
    backupPolicyPlans IsShareSnapshotBackupPolicyPlan[]
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    capturedAt string
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    createdAt string
    (String) The date and time that the share snapshot was created.
    crn string
    (String) The CRN for this share snapshot.
    fingerprint string
    (String) The fingerprint for this snapshot.
    href string
    (String) The URL for this zone.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleState string
    (String) The lifecycle state of this share snapshot.
    minimumSize number
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    resourceGroups IsShareSnapshotResourceGroup[]
    (List) The resource group for this file share. Nested schema for resource_group:
    resourceType string
    (String) The resource type.
    shareSnapshot string
    (String) The unique identifier for this share snapshot.
    status string
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    statusReasons IsShareSnapshotStatusReason[]
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    zones IsShareSnapshotZone[]
    (List) The zone this share snapshot resides in. Nested schema for zone:
    backup_policy_plans Sequence[IsShareSnapshotBackupPolicyPlan]
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    captured_at str
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    created_at str
    (String) The date and time that the share snapshot was created.
    crn str
    (String) The CRN for this share snapshot.
    fingerprint str
    (String) The fingerprint for this snapshot.
    href str
    (String) The URL for this zone.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_state str
    (String) The lifecycle state of this share snapshot.
    minimum_size float
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    resource_groups Sequence[IsShareSnapshotResourceGroup]
    (List) The resource group for this file share. Nested schema for resource_group:
    resource_type str
    (String) The resource type.
    share_snapshot str
    (String) The unique identifier for this share snapshot.
    status str
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    status_reasons Sequence[IsShareSnapshotStatusReason]
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    zones Sequence[IsShareSnapshotZone]
    (List) The zone this share snapshot resides in. Nested schema for zone:
    backupPolicyPlans List<Property Map>
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    capturedAt String
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    createdAt String
    (String) The date and time that the share snapshot was created.
    crn String
    (String) The CRN for this share snapshot.
    fingerprint String
    (String) The fingerprint for this snapshot.
    href String
    (String) The URL for this zone.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleState String
    (String) The lifecycle state of this share snapshot.
    minimumSize Number
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    resourceGroups List<Property Map>
    (List) The resource group for this file share. Nested schema for resource_group:
    resourceType String
    (String) The resource type.
    shareSnapshot String
    (String) The unique identifier for this share snapshot.
    status String
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    statusReasons List<Property Map>
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    zones List<Property Map>
    (List) The zone this share snapshot resides in. Nested schema for zone:

    Look up Existing IsShareSnapshot Resource

    Get an existing IsShareSnapshot 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?: IsShareSnapshotState, opts?: CustomResourceOptions): IsShareSnapshot
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tags: Optional[Sequence[str]] = None,
        backup_policy_plans: Optional[Sequence[IsShareSnapshotBackupPolicyPlanArgs]] = None,
        captured_at: Optional[str] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        fingerprint: Optional[str] = None,
        href: Optional[str] = None,
        is_share_snapshot_id: Optional[str] = None,
        lifecycle_state: Optional[str] = None,
        minimum_size: Optional[float] = None,
        name: Optional[str] = None,
        resource_groups: Optional[Sequence[IsShareSnapshotResourceGroupArgs]] = None,
        resource_type: Optional[str] = None,
        share: Optional[str] = None,
        share_snapshot: Optional[str] = None,
        status: Optional[str] = None,
        status_reasons: Optional[Sequence[IsShareSnapshotStatusReasonArgs]] = None,
        tags: Optional[Sequence[str]] = None,
        zones: Optional[Sequence[IsShareSnapshotZoneArgs]] = None) -> IsShareSnapshot
    func GetIsShareSnapshot(ctx *Context, name string, id IDInput, state *IsShareSnapshotState, opts ...ResourceOption) (*IsShareSnapshot, error)
    public static IsShareSnapshot Get(string name, Input<string> id, IsShareSnapshotState? state, CustomResourceOptions? opts = null)
    public static IsShareSnapshot get(String name, Output<String> id, IsShareSnapshotState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsShareSnapshot    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>
    List of access management tags
    BackupPolicyPlans List<IsShareSnapshotBackupPolicyPlan>
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    CapturedAt string
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    CreatedAt string
    (String) The date and time that the share snapshot was created.
    Crn string
    (String) The CRN for this share snapshot.
    Fingerprint string
    (String) The fingerprint for this snapshot.
    Href string
    (String) The URL for this zone.
    IsShareSnapshotId string
    (String) The unique identifier for this resource group.
    LifecycleState string
    (String) The lifecycle state of this share snapshot.
    MinimumSize double
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    ResourceGroups List<IsShareSnapshotResourceGroup>
    (List) The resource group for this file share. Nested schema for resource_group:
    ResourceType string
    (String) The resource type.
    Share string
    The file share identifier.
    ShareSnapshot string
    (String) The unique identifier for this share snapshot.
    Status string
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    StatusReasons List<IsShareSnapshotStatusReason>
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    Tags List<string>
    The user tags associated with this share snapshot.
    Zones List<IsShareSnapshotZone>
    (List) The zone this share snapshot resides in. Nested schema for zone:
    AccessTags []string
    List of access management tags
    BackupPolicyPlans []IsShareSnapshotBackupPolicyPlanArgs
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    CapturedAt string
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    CreatedAt string
    (String) The date and time that the share snapshot was created.
    Crn string
    (String) The CRN for this share snapshot.
    Fingerprint string
    (String) The fingerprint for this snapshot.
    Href string
    (String) The URL for this zone.
    IsShareSnapshotId string
    (String) The unique identifier for this resource group.
    LifecycleState string
    (String) The lifecycle state of this share snapshot.
    MinimumSize float64
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    ResourceGroups []IsShareSnapshotResourceGroupArgs
    (List) The resource group for this file share. Nested schema for resource_group:
    ResourceType string
    (String) The resource type.
    Share string
    The file share identifier.
    ShareSnapshot string
    (String) The unique identifier for this share snapshot.
    Status string
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    StatusReasons []IsShareSnapshotStatusReasonArgs
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    Tags []string
    The user tags associated with this share snapshot.
    Zones []IsShareSnapshotZoneArgs
    (List) The zone this share snapshot resides in. Nested schema for zone:
    accessTags List<String>
    List of access management tags
    backupPolicyPlans List<IsShareSnapshotBackupPolicyPlan>
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    capturedAt String
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    createdAt String
    (String) The date and time that the share snapshot was created.
    crn String
    (String) The CRN for this share snapshot.
    fingerprint String
    (String) The fingerprint for this snapshot.
    href String
    (String) The URL for this zone.
    isShareSnapshotId String
    (String) The unique identifier for this resource group.
    lifecycleState String
    (String) The lifecycle state of this share snapshot.
    minimumSize Double
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    resourceGroups List<IsShareSnapshotResourceGroup>
    (List) The resource group for this file share. Nested schema for resource_group:
    resourceType String
    (String) The resource type.
    share String
    The file share identifier.
    shareSnapshot String
    (String) The unique identifier for this share snapshot.
    status String
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    statusReasons List<IsShareSnapshotStatusReason>
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    tags List<String>
    The user tags associated with this share snapshot.
    zones List<IsShareSnapshotZone>
    (List) The zone this share snapshot resides in. Nested schema for zone:
    accessTags string[]
    List of access management tags
    backupPolicyPlans IsShareSnapshotBackupPolicyPlan[]
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    capturedAt string
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    createdAt string
    (String) The date and time that the share snapshot was created.
    crn string
    (String) The CRN for this share snapshot.
    fingerprint string
    (String) The fingerprint for this snapshot.
    href string
    (String) The URL for this zone.
    isShareSnapshotId string
    (String) The unique identifier for this resource group.
    lifecycleState string
    (String) The lifecycle state of this share snapshot.
    minimumSize number
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    resourceGroups IsShareSnapshotResourceGroup[]
    (List) The resource group for this file share. Nested schema for resource_group:
    resourceType string
    (String) The resource type.
    share string
    The file share identifier.
    shareSnapshot string
    (String) The unique identifier for this share snapshot.
    status string
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    statusReasons IsShareSnapshotStatusReason[]
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    tags string[]
    The user tags associated with this share snapshot.
    zones IsShareSnapshotZone[]
    (List) The zone this share snapshot resides in. Nested schema for zone:
    access_tags Sequence[str]
    List of access management tags
    backup_policy_plans Sequence[IsShareSnapshotBackupPolicyPlanArgs]
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    captured_at str
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    created_at str
    (String) The date and time that the share snapshot was created.
    crn str
    (String) The CRN for this share snapshot.
    fingerprint str
    (String) The fingerprint for this snapshot.
    href str
    (String) The URL for this zone.
    is_share_snapshot_id str
    (String) The unique identifier for this resource group.
    lifecycle_state str
    (String) The lifecycle state of this share snapshot.
    minimum_size float
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    name str
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    resource_groups Sequence[IsShareSnapshotResourceGroupArgs]
    (List) The resource group for this file share. Nested schema for resource_group:
    resource_type str
    (String) The resource type.
    share str
    The file share identifier.
    share_snapshot str
    (String) The unique identifier for this share snapshot.
    status str
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    status_reasons Sequence[IsShareSnapshotStatusReasonArgs]
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    tags Sequence[str]
    The user tags associated with this share snapshot.
    zones Sequence[IsShareSnapshotZoneArgs]
    (List) The zone this share snapshot resides in. Nested schema for zone:
    accessTags List<String>
    List of access management tags
    backupPolicyPlans List<Property Map>
    (List) If present, the backup policy plan which created this share snapshot. Nested schema for backup_policy_plan: _ deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
    capturedAt String
    (String) The date and time the data capture for this share snapshot was completed.If absent, this snapshot's data has not yet been captured.
    createdAt String
    (String) The date and time that the share snapshot was created.
    crn String
    (String) The CRN for this share snapshot.
    fingerprint String
    (String) The fingerprint for this snapshot.
    href String
    (String) The URL for this zone.
    isShareSnapshotId String
    (String) The unique identifier for this resource group.
    lifecycleState String
    (String) The lifecycle state of this share snapshot.
    minimumSize Number
    (Integer) The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the source_share.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    resourceGroups List<Property Map>
    (List) The resource group for this file share. Nested schema for resource_group:
    resourceType String
    (String) The resource type.
    share String
    The file share identifier.
    shareSnapshot String
    (String) The unique identifier for this share snapshot.
    status String
    (String) The status of the share snapshot:- available: The share snapshot is available for use.- failed: The share snapshot is irrecoverably unusable.- pending: The share snapshot is being provisioned and is not yet usable.- unusable: The share snapshot is not currently usable (see status_reasons)The enumerated values for this property mayexpand in the future.
    statusReasons List<Property Map>
    (List) The reasons for the current status (if any). Nested schema for status_reasons:
    tags List<String>
    The user tags associated with this share snapshot.
    zones List<Property Map>
    (List) The zone this share snapshot resides in. Nested schema for zone:

    Supporting Types

    IsShareSnapshotBackupPolicyPlan, IsShareSnapshotBackupPolicyPlanArgs

    Deleteds List<IsShareSnapshotBackupPolicyPlanDeleted>
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    Remotes List<IsShareSnapshotBackupPolicyPlanRemote>
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    ResourceType string
    (String) The resource type.
    Deleteds []IsShareSnapshotBackupPolicyPlanDeleted
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    Remotes []IsShareSnapshotBackupPolicyPlanRemote
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    ResourceType string
    (String) The resource type.
    deleteds List<IsShareSnapshotBackupPolicyPlanDeleted>
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    remotes List<IsShareSnapshotBackupPolicyPlanRemote>
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    resourceType String
    (String) The resource type.
    deleteds IsShareSnapshotBackupPolicyPlanDeleted[]
    href string
    (String) The URL for this zone.
    id string
    (String) The unique identifier for this resource group.
    name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    remotes IsShareSnapshotBackupPolicyPlanRemote[]
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    resourceType string
    (String) The resource type.
    deleteds Sequence[IsShareSnapshotBackupPolicyPlanDeleted]
    href str
    (String) The URL for this zone.
    id str
    (String) The unique identifier for this resource group.
    name str
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    remotes Sequence[IsShareSnapshotBackupPolicyPlanRemote]
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    resource_type str
    (String) The resource type.
    deleteds List<Property Map>
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    remotes List<Property Map>
    (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
    resourceType String
    (String) The resource type.

    IsShareSnapshotBackupPolicyPlanDeleted, IsShareSnapshotBackupPolicyPlanDeletedArgs

    MoreInfo string
    (String) Link to documentation about this status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    moreInfo String
    (String) Link to documentation about this status reason.
    moreInfo string
    (String) Link to documentation about this status reason.
    more_info str
    (String) Link to documentation about this status reason.
    moreInfo String
    (String) Link to documentation about this status reason.

    IsShareSnapshotBackupPolicyPlanRemote, IsShareSnapshotBackupPolicyPlanRemoteArgs

    Regions List<IsShareSnapshotBackupPolicyPlanRemoteRegion>
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
    Regions []IsShareSnapshotBackupPolicyPlanRemoteRegion
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
    regions List<IsShareSnapshotBackupPolicyPlanRemoteRegion>
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
    regions IsShareSnapshotBackupPolicyPlanRemoteRegion[]
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
    regions Sequence[IsShareSnapshotBackupPolicyPlanRemoteRegion]
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
    regions List<Property Map>
    (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:

    IsShareSnapshotBackupPolicyPlanRemoteRegion, IsShareSnapshotBackupPolicyPlanRemoteRegionArgs

    Href string
    (String) The URL for this zone.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    Href string
    (String) The URL for this zone.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href String
    (String) The URL for this zone.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href string
    (String) The URL for this zone.
    name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href str
    (String) The URL for this zone.
    name str
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href String
    (String) The URL for this zone.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.

    IsShareSnapshotResourceGroup, IsShareSnapshotResourceGroupArgs

    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href string
    (String) The URL for this zone.
    id string
    (String) The unique identifier for this resource group.
    name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href str
    (String) The URL for this zone.
    id str
    (String) The unique identifier for this resource group.
    name str
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.

    IsShareSnapshotStatusReason, IsShareSnapshotStatusReasonArgs

    Code string
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    Code string
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    code String
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason.
    code string
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    message string
    (String) An explanation of the status reason.
    moreInfo string
    (String) Link to documentation about this status reason.
    code str
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    message str
    (String) An explanation of the status reason.
    more_info str
    (String) Link to documentation about this status reason.
    code String
    (String) A reason code for the status:- encryption_key_deleted: File share snapshot is unusable because its encryption_key was deleted- internal_error: Internal error (contact IBM support)The enumerated values for this property mayexpand in the future.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason.

    IsShareSnapshotZone, IsShareSnapshotZoneArgs

    Href string
    (String) The URL for this zone.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    Href string
    (String) The URL for this zone.
    Name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href String
    (String) The URL for this zone.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href string
    (String) The URL for this zone.
    name string
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href str
    (String) The URL for this zone.
    name str
    The name for this share snapshot. The name is unique across all snapshots for the file share.
    href String
    (String) The URL for this zone.
    name String
    The name for this share snapshot. The name is unique across all snapshots for the file share.

    Import

    You can import the ibm_is_share_snapshot resource by using id.

    The id property can be formed from share_id, and share_snapshot in the following format:

    
<share_id>/<is_share_snapshot_id>

    • share_id: A string. The file share identifier.

    • share_snapshot: A string in the format r006-e13ee54f-baa4-40d3-b35c-b9ec163972b4. The unique identifier for this share snapshot.

    Syntax

    
```sh
$ pulumi import ibm:index/isShareSnapshot:IsShareSnapshot is_share_snapshot <share_id>/<is_share_snapshot_id>
```

    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