outscale 1.1.1 published on Tuesday, May 6, 2025 by outscale
outscale.getSnapshot
Explore with Pulumi AI
Provides information about a snapshot.
For more information on this resource, see the User Guide.
For more information on this resource actions, see the API documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as outscale from "@pulumi/outscale";
const snapshot01 = outscale.getSnapshot({
filters: [{
name: "snapshot_ids",
values: ["snap-12345678"],
}],
});
import pulumi
import pulumi_outscale as outscale
snapshot01 = outscale.get_snapshot(filters=[{
"name": "snapshot_ids",
"values": ["snap-12345678"],
}])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := outscale.LookupSnapshot(ctx, &outscale.LookupSnapshotArgs{
Filters: []outscale.GetSnapshotFilter{
{
Name: "snapshot_ids",
Values: []string{
"snap-12345678",
},
},
},
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;
return await Deployment.RunAsync(() =>
{
var snapshot01 = Outscale.GetSnapshot.Invoke(new()
{
Filters = new[]
{
new Outscale.Inputs.GetSnapshotFilterInputArgs
{
Name = "snapshot_ids",
Values = new[]
{
"snap-12345678",
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.OutscaleFunctions;
import com.pulumi.outscale.inputs.GetSnapshotArgs;
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) {
final var snapshot01 = OutscaleFunctions.getSnapshot(GetSnapshotArgs.builder()
.filters(GetSnapshotFilterArgs.builder()
.name("snapshot_ids")
.values("snap-12345678")
.build())
.build());
}
}
variables:
snapshot01:
fn::invoke:
function: outscale:getSnapshot
arguments:
filters:
- name: snapshot_ids
values:
- snap-12345678
Using getSnapshot
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOptions): Output<GetSnapshotResult>def get_snapshot(account_id: Optional[str] = None,
filters: Optional[Sequence[GetSnapshotFilter]] = None,
id: Optional[str] = None,
snapshot_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(account_id: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetSnapshotFilterArgs]]]] = None,
id: Optional[pulumi.Input[str]] = None,
snapshot_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotResult]func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput> Note: This function is named LookupSnapshot in the Go SDK.
public static class GetSnapshot
{
public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
fn::invoke:
function: outscale:index/getSnapshot:getSnapshot
arguments:
# arguments dictionaryThe following arguments are supported:
- Account
Id string - The account ID of the owner of the snapshot.
- Filters
List<Get
Snapshot Filter> - A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- Id string
- Snapshot
Id string - The ID of the snapshot.
- Account
Id string - The account ID of the owner of the snapshot.
- Filters
[]Get
Snapshot Filter - A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- Id string
- Snapshot
Id string - The ID of the snapshot.
- account
Id String - The account ID of the owner of the snapshot.
- filters
List<Get
Snapshot Filter> - A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- id String
- snapshot
Id String - The ID of the snapshot.
- account
Id string - The account ID of the owner of the snapshot.
- filters
Get
Snapshot Filter[] - A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- id string
- snapshot
Id string - The ID of the snapshot.
- account_
id str - The account ID of the owner of the snapshot.
- filters
Sequence[Get
Snapshot Filter] - A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- id str
- snapshot_
id str - The ID of the snapshot.
- account
Id String - The account ID of the owner of the snapshot.
- filters List<Property Map>
- A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- id String
- snapshot
Id String - The ID of the snapshot.
getSnapshot Result
The following output properties are available:
- Account
Alias string - The account alias of the owner of the snapshot.
- Account
Id string - The account ID of the owner of the snapshot.
- Creation
Date string - The date and time (UTC) at which the snapshot was created.
- Description string
- The description of the snapshot.
- Id string
- Permissions
To List<GetCreate Volumes Snapshot Permissions To Create Volume> - Permissions for the resource.
- Progress double
- The progress of the snapshot, as a percentage.
- Request
Id string - Snapshot
Id string - The ID of the snapshot.
- State string
- The state of the snapshot (
in-queue|pending|completed|error|deleting)). -
List<Get
Snapshot Tag> - One or more tags associated with the snapshot.
- Volume
Id string - The ID of the volume used to create the snapshot.
- Volume
Size double - The size of the volume used to create the snapshot, in gibibytes (GiB).
- Filters
List<Get
Snapshot Filter>
- Account
Alias string - The account alias of the owner of the snapshot.
- Account
Id string - The account ID of the owner of the snapshot.
- Creation
Date string - The date and time (UTC) at which the snapshot was created.
- Description string
- The description of the snapshot.
- Id string
- Permissions
To []GetCreate Volumes Snapshot Permissions To Create Volume - Permissions for the resource.
- Progress float64
- The progress of the snapshot, as a percentage.
- Request
Id string - Snapshot
Id string - The ID of the snapshot.
- State string
- The state of the snapshot (
in-queue|pending|completed|error|deleting)). -
[]Get
Snapshot Tag - One or more tags associated with the snapshot.
- Volume
Id string - The ID of the volume used to create the snapshot.
- Volume
Size float64 - The size of the volume used to create the snapshot, in gibibytes (GiB).
- Filters
[]Get
Snapshot Filter
- account
Alias String - The account alias of the owner of the snapshot.
- account
Id String - The account ID of the owner of the snapshot.
- creation
Date String - The date and time (UTC) at which the snapshot was created.
- description String
- The description of the snapshot.
- id String
- permissions
To List<GetCreate Volumes Snapshot Permissions To Create Volume> - Permissions for the resource.
- progress Double
- The progress of the snapshot, as a percentage.
- request
Id String - snapshot
Id String - The ID of the snapshot.
- state String
- The state of the snapshot (
in-queue|pending|completed|error|deleting)). -
List<Get
Snapshot Tag> - One or more tags associated with the snapshot.
- volume
Id String - The ID of the volume used to create the snapshot.
- volume
Size Double - The size of the volume used to create the snapshot, in gibibytes (GiB).
- filters
List<Get
Snapshot Filter>
- account
Alias string - The account alias of the owner of the snapshot.
- account
Id string - The account ID of the owner of the snapshot.
- creation
Date string - The date and time (UTC) at which the snapshot was created.
- description string
- The description of the snapshot.
- id string
- permissions
To GetCreate Volumes Snapshot Permissions To Create Volume[] - Permissions for the resource.
- progress number
- The progress of the snapshot, as a percentage.
- request
Id string - snapshot
Id string - The ID of the snapshot.
- state string
- The state of the snapshot (
in-queue|pending|completed|error|deleting)). -
Get
Snapshot Tag[] - One or more tags associated with the snapshot.
- volume
Id string - The ID of the volume used to create the snapshot.
- volume
Size number - The size of the volume used to create the snapshot, in gibibytes (GiB).
- filters
Get
Snapshot Filter[]
- account_
alias str - The account alias of the owner of the snapshot.
- account_
id str - The account ID of the owner of the snapshot.
- creation_
date str - The date and time (UTC) at which the snapshot was created.
- description str
- The description of the snapshot.
- id str
- permissions_
to_ Sequence[Getcreate_ volumes Snapshot Permissions To Create Volume] - Permissions for the resource.
- progress float
- The progress of the snapshot, as a percentage.
- request_
id str - snapshot_
id str - The ID of the snapshot.
- state str
- The state of the snapshot (
in-queue|pending|completed|error|deleting)). -
Sequence[Get
Snapshot Tag] - One or more tags associated with the snapshot.
- volume_
id str - The ID of the volume used to create the snapshot.
- volume_
size float - The size of the volume used to create the snapshot, in gibibytes (GiB).
- filters
Sequence[Get
Snapshot Filter]
- account
Alias String - The account alias of the owner of the snapshot.
- account
Id String - The account ID of the owner of the snapshot.
- creation
Date String - The date and time (UTC) at which the snapshot was created.
- description String
- The description of the snapshot.
- id String
- permissions
To List<Property Map>Create Volumes - Permissions for the resource.
- progress Number
- The progress of the snapshot, as a percentage.
- request
Id String - snapshot
Id String - The ID of the snapshot.
- state String
- The state of the snapshot (
in-queue|pending|completed|error|deleting)). - List<Property Map>
- One or more tags associated with the snapshot.
- volume
Id String - The ID of the volume used to create the snapshot.
- volume
Size Number - The size of the volume used to create the snapshot, in gibibytes (GiB).
- filters List<Property Map>
Supporting Types
GetSnapshotFilter
GetSnapshotPermissionsToCreateVolume
- Account
Ids List<string> - One or more account IDs that the permission is associated with.
- Global
Permission bool - A global permission for all accounts.
(Request) Set this parameter to true to make the resource public (if the parent parameter is
Additions) or to make the resource private (if the parent parameter isRemovals). (Response) If true, the resource is public. If false, the resource is private.
- Account
Ids []string - One or more account IDs that the permission is associated with.
- Global
Permission bool - A global permission for all accounts.
(Request) Set this parameter to true to make the resource public (if the parent parameter is
Additions) or to make the resource private (if the parent parameter isRemovals). (Response) If true, the resource is public. If false, the resource is private.
- account
Ids List<String> - One or more account IDs that the permission is associated with.
- global
Permission Boolean - A global permission for all accounts.
(Request) Set this parameter to true to make the resource public (if the parent parameter is
Additions) or to make the resource private (if the parent parameter isRemovals). (Response) If true, the resource is public. If false, the resource is private.
- account
Ids string[] - One or more account IDs that the permission is associated with.
- global
Permission boolean - A global permission for all accounts.
(Request) Set this parameter to true to make the resource public (if the parent parameter is
Additions) or to make the resource private (if the parent parameter isRemovals). (Response) If true, the resource is public. If false, the resource is private.
- account_
ids Sequence[str] - One or more account IDs that the permission is associated with.
- global_
permission bool - A global permission for all accounts.
(Request) Set this parameter to true to make the resource public (if the parent parameter is
Additions) or to make the resource private (if the parent parameter isRemovals). (Response) If true, the resource is public. If false, the resource is private.
- account
Ids List<String> - One or more account IDs that the permission is associated with.
- global
Permission Boolean - A global permission for all accounts.
(Request) Set this parameter to true to make the resource public (if the parent parameter is
Additions) or to make the resource private (if the parent parameter isRemovals). (Response) If true, the resource is public. If false, the resource is private.
GetSnapshotTag
Package Details
- Repository
- outscale outscale/terraform-provider-outscale
- License
- Notes
- This Pulumi package is based on the
outscaleTerraform Provider.