1. Packages
  2. Powerscale Provider
  3. API Docs
  4. WritableSnapshot
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

powerscale.WritableSnapshot

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

    Example Usage

    Create WritableSnapshot Resource

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

    Constructor syntax

    new WritableSnapshot(name: string, args: WritableSnapshotArgs, opts?: CustomResourceOptions);
    @overload
    def WritableSnapshot(resource_name: str,
                         args: WritableSnapshotArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def WritableSnapshot(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         dst_path: Optional[str] = None,
                         snap_id: Optional[str] = None)
    func NewWritableSnapshot(ctx *Context, name string, args WritableSnapshotArgs, opts ...ResourceOption) (*WritableSnapshot, error)
    public WritableSnapshot(string name, WritableSnapshotArgs args, CustomResourceOptions? opts = null)
    public WritableSnapshot(String name, WritableSnapshotArgs args)
    public WritableSnapshot(String name, WritableSnapshotArgs args, CustomResourceOptions options)
    
    type: powerscale:WritableSnapshot
    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 WritableSnapshotArgs
    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 WritableSnapshotArgs
    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 WritableSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WritableSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WritableSnapshotArgs
    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 writableSnapshotResource = new Powerscale.WritableSnapshot("writableSnapshotResource", new()
    {
        DstPath = "string",
        SnapId = "string",
    });
    
    example, err := powerscale.NewWritableSnapshot(ctx, "writableSnapshotResource", &powerscale.WritableSnapshotArgs{
    	DstPath: pulumi.String("string"),
    	SnapId:  pulumi.String("string"),
    })
    
    var writableSnapshotResource = new WritableSnapshot("writableSnapshotResource", WritableSnapshotArgs.builder()
        .dstPath("string")
        .snapId("string")
        .build());
    
    writable_snapshot_resource = powerscale.WritableSnapshot("writableSnapshotResource",
        dst_path="string",
        snap_id="string")
    
    const writableSnapshotResource = new powerscale.WritableSnapshot("writableSnapshotResource", {
        dstPath: "string",
        snapId: "string",
    });
    
    type: powerscale:WritableSnapshot
    properties:
        dstPath: string
        snapId: string
    

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

    DstPath string
    The destination path for the writable snapshot.
    SnapId string
    The ID of the source snapshot for the writable snapshot.
    DstPath string
    The destination path for the writable snapshot.
    SnapId string
    The ID of the source snapshot for the writable snapshot.
    dstPath String
    The destination path for the writable snapshot.
    snapId String
    The ID of the source snapshot for the writable snapshot.
    dstPath string
    The destination path for the writable snapshot.
    snapId string
    The ID of the source snapshot for the writable snapshot.
    dst_path str
    The destination path for the writable snapshot.
    snap_id str
    The ID of the source snapshot for the writable snapshot.
    dstPath String
    The destination path for the writable snapshot.
    snapId String
    The ID of the source snapshot for the writable snapshot.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SnapName string
    The name of the source snapshot for the writable snapshot.
    SrcPath string
    The source path of the writable snapshot.
    State string
    The state of the writable snapshot.
    WritableSnapshotId double
    Unique identifier of the writable snapshot.
    Id string
    The provider-assigned unique ID for this managed resource.
    SnapName string
    The name of the source snapshot for the writable snapshot.
    SrcPath string
    The source path of the writable snapshot.
    State string
    The state of the writable snapshot.
    WritableSnapshotId float64
    Unique identifier of the writable snapshot.
    id String
    The provider-assigned unique ID for this managed resource.
    snapName String
    The name of the source snapshot for the writable snapshot.
    srcPath String
    The source path of the writable snapshot.
    state String
    The state of the writable snapshot.
    writableSnapshotId Double
    Unique identifier of the writable snapshot.
    id string
    The provider-assigned unique ID for this managed resource.
    snapName string
    The name of the source snapshot for the writable snapshot.
    srcPath string
    The source path of the writable snapshot.
    state string
    The state of the writable snapshot.
    writableSnapshotId number
    Unique identifier of the writable snapshot.
    id str
    The provider-assigned unique ID for this managed resource.
    snap_name str
    The name of the source snapshot for the writable snapshot.
    src_path str
    The source path of the writable snapshot.
    state str
    The state of the writable snapshot.
    writable_snapshot_id float
    Unique identifier of the writable snapshot.
    id String
    The provider-assigned unique ID for this managed resource.
    snapName String
    The name of the source snapshot for the writable snapshot.
    srcPath String
    The source path of the writable snapshot.
    state String
    The state of the writable snapshot.
    writableSnapshotId Number
    Unique identifier of the writable snapshot.

    Look up Existing WritableSnapshot Resource

    Get an existing WritableSnapshot 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?: WritableSnapshotState, opts?: CustomResourceOptions): WritableSnapshot
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dst_path: Optional[str] = None,
            snap_id: Optional[str] = None,
            snap_name: Optional[str] = None,
            src_path: Optional[str] = None,
            state: Optional[str] = None,
            writable_snapshot_id: Optional[float] = None) -> WritableSnapshot
    func GetWritableSnapshot(ctx *Context, name string, id IDInput, state *WritableSnapshotState, opts ...ResourceOption) (*WritableSnapshot, error)
    public static WritableSnapshot Get(string name, Input<string> id, WritableSnapshotState? state, CustomResourceOptions? opts = null)
    public static WritableSnapshot get(String name, Output<String> id, WritableSnapshotState state, CustomResourceOptions options)
    resources:  _:    type: powerscale:WritableSnapshot    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:
    DstPath string
    The destination path for the writable snapshot.
    SnapId string
    The ID of the source snapshot for the writable snapshot.
    SnapName string
    The name of the source snapshot for the writable snapshot.
    SrcPath string
    The source path of the writable snapshot.
    State string
    The state of the writable snapshot.
    WritableSnapshotId double
    Unique identifier of the writable snapshot.
    DstPath string
    The destination path for the writable snapshot.
    SnapId string
    The ID of the source snapshot for the writable snapshot.
    SnapName string
    The name of the source snapshot for the writable snapshot.
    SrcPath string
    The source path of the writable snapshot.
    State string
    The state of the writable snapshot.
    WritableSnapshotId float64
    Unique identifier of the writable snapshot.
    dstPath String
    The destination path for the writable snapshot.
    snapId String
    The ID of the source snapshot for the writable snapshot.
    snapName String
    The name of the source snapshot for the writable snapshot.
    srcPath String
    The source path of the writable snapshot.
    state String
    The state of the writable snapshot.
    writableSnapshotId Double
    Unique identifier of the writable snapshot.
    dstPath string
    The destination path for the writable snapshot.
    snapId string
    The ID of the source snapshot for the writable snapshot.
    snapName string
    The name of the source snapshot for the writable snapshot.
    srcPath string
    The source path of the writable snapshot.
    state string
    The state of the writable snapshot.
    writableSnapshotId number
    Unique identifier of the writable snapshot.
    dst_path str
    The destination path for the writable snapshot.
    snap_id str
    The ID of the source snapshot for the writable snapshot.
    snap_name str
    The name of the source snapshot for the writable snapshot.
    src_path str
    The source path of the writable snapshot.
    state str
    The state of the writable snapshot.
    writable_snapshot_id float
    Unique identifier of the writable snapshot.
    dstPath String
    The destination path for the writable snapshot.
    snapId String
    The ID of the source snapshot for the writable snapshot.
    snapName String
    The name of the source snapshot for the writable snapshot.
    srcPath String
    The source path of the writable snapshot.
    state String
    The state of the writable snapshot.
    writableSnapshotId Number
    Unique identifier of the writable snapshot.

    Import

    Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.

    Licensed under the Mozilla Public License Version 2.0 (the “License”);

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

    http://mozilla.org/MPL/2.0/
    

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an “AS IS” BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.

    The command is

    $ pulumi import powerscale:index/writableSnapshot:WritableSnapshot writablesnap <path of the Snapshot>
    

    Example:

    $ pulumi import powerscale:index/writableSnapshot:WritableSnapshot writablesnap "/ifs/abcd"
    

    after running this command, populate the name field and other required parameters in the config file to start managing this resource.

    Note: running “terraform show” after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

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

    Package Details

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