1. Packages
  2. Powerstore Provider
  3. API Docs
  4. VolumegroupSnapshot
powerstore 1.2.0 published on Monday, Apr 14, 2025 by dell

powerstore.VolumegroupSnapshot

Explore with Pulumi AI

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.

Below are the steps to import volume group snapshot :

Step 1 - To import a volume group snapshot , we need the id of that volume group snapshot

Step 2 - To check the id of the volume group snapshot we can make Get request to volume group snapshot endpoint. eg. https://10.0.0.1/api/rest/volume_group –header ’type: Snapshot’ which will return list of all volume group snapshots ids.

Step 3 - Add empty resource block in tf file.

eg.

#resource “powerstore_volumegroup_snapshot” “resource_block_name” {

(resource arguments)

#}

$ pulumi import powerstore:index/volumegroupSnapshot:VolumegroupSnapshot Step 4 - Execute the command: "powerstore_volumegroup_snapshot.resource_block_name" "id_of_the_snapshot" (resource_block_name must be taken from step 3 and id must be taken from step 2)
Copy

Step 5 - After successful execution of the command , check the state file

Create VolumegroupSnapshot Resource

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

Constructor syntax

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

@overload
def VolumegroupSnapshot(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        expiration_timestamp: Optional[str] = None,
                        name: Optional[str] = None,
                        volume_group_id: Optional[str] = None,
                        volume_group_name: Optional[str] = None)
func NewVolumegroupSnapshot(ctx *Context, name string, args *VolumegroupSnapshotArgs, opts ...ResourceOption) (*VolumegroupSnapshot, error)
public VolumegroupSnapshot(string name, VolumegroupSnapshotArgs? args = null, CustomResourceOptions? opts = null)
public VolumegroupSnapshot(String name, VolumegroupSnapshotArgs args)
public VolumegroupSnapshot(String name, VolumegroupSnapshotArgs args, CustomResourceOptions options)
type: powerstore:VolumegroupSnapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args VolumegroupSnapshotArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args VolumegroupSnapshotArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args VolumegroupSnapshotArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args VolumegroupSnapshotArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VolumegroupSnapshotArgs
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 volumegroupSnapshotResource = new Powerstore.VolumegroupSnapshot("volumegroupSnapshotResource", new()
{
    Description = "string",
    ExpirationTimestamp = "string",
    Name = "string",
    VolumeGroupId = "string",
    VolumeGroupName = "string",
});
Copy
example, err := powerstore.NewVolumegroupSnapshot(ctx, "volumegroupSnapshotResource", &powerstore.VolumegroupSnapshotArgs{
Description: pulumi.String("string"),
ExpirationTimestamp: pulumi.String("string"),
Name: pulumi.String("string"),
VolumeGroupId: pulumi.String("string"),
VolumeGroupName: pulumi.String("string"),
})
Copy
var volumegroupSnapshotResource = new VolumegroupSnapshot("volumegroupSnapshotResource", VolumegroupSnapshotArgs.builder()
    .description("string")
    .expirationTimestamp("string")
    .name("string")
    .volumeGroupId("string")
    .volumeGroupName("string")
    .build());
Copy
volumegroup_snapshot_resource = powerstore.VolumegroupSnapshot("volumegroupSnapshotResource",
    description="string",
    expiration_timestamp="string",
    name="string",
    volume_group_id="string",
    volume_group_name="string")
Copy
const volumegroupSnapshotResource = new powerstore.VolumegroupSnapshot("volumegroupSnapshotResource", {
    description: "string",
    expirationTimestamp: "string",
    name: "string",
    volumeGroupId: "string",
    volumeGroupName: "string",
});
Copy
type: powerstore:VolumegroupSnapshot
properties:
    description: string
    expirationTimestamp: string
    name: string
    volumeGroupId: string
    volumeGroupName: string
Copy

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

Description string
Description of the volume group snapshot.
ExpirationTimestamp string
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
Name string
Name of the volume group snapshot.
VolumeGroupId string
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
VolumeGroupName string
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.
Description string
Description of the volume group snapshot.
ExpirationTimestamp string
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
Name string
Name of the volume group snapshot.
VolumeGroupId string
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
VolumeGroupName string
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.
description String
Description of the volume group snapshot.
expirationTimestamp String
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
name String
Name of the volume group snapshot.
volumeGroupId String
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
volumeGroupName String
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.
description string
Description of the volume group snapshot.
expirationTimestamp string
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
name string
Name of the volume group snapshot.
volumeGroupId string
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
volumeGroupName string
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.
description str
Description of the volume group snapshot.
expiration_timestamp str
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
name str
Name of the volume group snapshot.
volume_group_id str
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
volume_group_name str
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.
description String
Description of the volume group snapshot.
expirationTimestamp String
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
name String
Name of the volume group snapshot.
volumeGroupId String
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
volumeGroupName String
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing VolumegroupSnapshot Resource

Get an existing VolumegroupSnapshot 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?: VolumegroupSnapshotState, opts?: CustomResourceOptions): VolumegroupSnapshot
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        expiration_timestamp: Optional[str] = None,
        name: Optional[str] = None,
        volume_group_id: Optional[str] = None,
        volume_group_name: Optional[str] = None) -> VolumegroupSnapshot
func GetVolumegroupSnapshot(ctx *Context, name string, id IDInput, state *VolumegroupSnapshotState, opts ...ResourceOption) (*VolumegroupSnapshot, error)
public static VolumegroupSnapshot Get(string name, Input<string> id, VolumegroupSnapshotState? state, CustomResourceOptions? opts = null)
public static VolumegroupSnapshot get(String name, Output<String> id, VolumegroupSnapshotState state, CustomResourceOptions options)
resources:  _:    type: powerstore:VolumegroupSnapshot    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description string
Description of the volume group snapshot.
ExpirationTimestamp string
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
Name string
Name of the volume group snapshot.
VolumeGroupId string
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
VolumeGroupName string
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.
Description string
Description of the volume group snapshot.
ExpirationTimestamp string
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
Name string
Name of the volume group snapshot.
VolumeGroupId string
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
VolumeGroupName string
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.
description String
Description of the volume group snapshot.
expirationTimestamp String
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
name String
Name of the volume group snapshot.
volumeGroupId String
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
volumeGroupName String
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.
description string
Description of the volume group snapshot.
expirationTimestamp string
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
name string
Name of the volume group snapshot.
volumeGroupId string
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
volumeGroupName string
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.
description str
Description of the volume group snapshot.
expiration_timestamp str
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
name str
Name of the volume group snapshot.
volume_group_id str
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
volume_group_name str
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.
description String
Description of the volume group snapshot.
expirationTimestamp String
Expiration Timestamp of the volume group snapshot.Only UTC (+Z) format is allowed
name String
Name of the volume group snapshot.
volumeGroupId String
ID of the volume group to take snapshot. Conflicts with volume_group_name. Cannot be updated.
volumeGroupName String
Name of the volume group to take snapshot. Conflicts with volume_group_id. Cannot be updated.

Package Details

Repository
powerstore dell/terraform-provider-powerstore
License
Notes
This Pulumi package is based on the powerstore Terraform Provider.