Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Outscale Provider
  3. API Docs
  4. getSnapshots
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

outscale.getSnapshots

Explore with Pulumi AI

outscale logo
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

    Provides information about snapshots.

    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 snapshots01 = outscale.getSnapshots({
    filters: [
        {
            name: "tag_keys",
            values: ["env"],
        },
        {
            name: "tag_values",
            values: [
                "prod",
                "test",
            ],
        },
    ],
});

    import pulumi
import pulumi_outscale as outscale

snapshots01 = outscale.get_snapshots(filters=[
    {
        "name": "tag_keys",
        "values": ["env"],
    },
    {
        "name": "tag_values",
        "values": [
            "prod",
            "test",
        ],
    },
])

    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.GetSnapshots(ctx, &outscale.GetSnapshotsArgs{
			Filters: []outscale.GetSnapshotsFilter{
				{
					Name: "tag_keys",
					Values: []string{
						"env",
					},
				},
				{
					Name: "tag_values",
					Values: []string{
						"prod",
						"test",
					},
				},
			},
		}, 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 snapshots01 = Outscale.GetSnapshots.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetSnapshotsFilterInputArgs
            {
                Name = "tag_keys",
                Values = new[]
                {
                    "env",
                },
            },
            new Outscale.Inputs.GetSnapshotsFilterInputArgs
            {
                Name = "tag_values",
                Values = new[]
                {
                    "prod",
                    "test",
                },
            },
        },
    });

});

    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.GetSnapshotsArgs;
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 snapshots01 = OutscaleFunctions.getSnapshots(GetSnapshotsArgs.builder()
            .filters(            
                GetSnapshotsFilterArgs.builder()
                    .name("tag_keys")
                    .values("env")
                    .build(),
                GetSnapshotsFilterArgs.builder()
                    .name("tag_values")
                    .values(                    
                        "prod",
                        "test")
                    .build())
            .build());

    }
}

    variables:
  snapshots01:
    fn::invoke:
      function: outscale:getSnapshots
      arguments:
        filters:
          - name: tag_keys
            values:
              - env
          - name: tag_values
            values:
              - prod
              - test

    Using getSnapshots

    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 getSnapshots(args: GetSnapshotsArgs, opts?: InvokeOptions): Promise<GetSnapshotsResult>
function getSnapshotsOutput(args: GetSnapshotsOutputArgs, opts?: InvokeOptions): Output<GetSnapshotsResult>
    def get_snapshots(account_ids: Optional[Sequence[str]] = None,
                  filters: Optional[Sequence[GetSnapshotsFilter]] = None,
                  id: Optional[str] = None,
                  permission_to_create_volumes: Optional[Sequence[str]] = None,
                  snapshot_ids: Optional[Sequence[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetSnapshotsResult
def get_snapshots_output(account_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetSnapshotsFilterArgs]]]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  permission_to_create_volumes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  snapshot_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotsResult]
    func GetSnapshots(ctx *Context, args *GetSnapshotsArgs, opts ...InvokeOption) (*GetSnapshotsResult, error)
func GetSnapshotsOutput(ctx *Context, args *GetSnapshotsOutputArgs, opts ...InvokeOption) GetSnapshotsResultOutput

    > Note: This function is named GetSnapshots in the Go SDK.

    public static class GetSnapshots 
{
    public static Task<GetSnapshotsResult> InvokeAsync(GetSnapshotsArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotsResult> Invoke(GetSnapshotsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSnapshotsResult> getSnapshots(GetSnapshotsArgs args, InvokeOptions options)
public static Output<GetSnapshotsResult> getSnapshots(GetSnapshotsArgs args, InvokeOptions options)

    fn::invoke:
  function: outscale:index/getSnapshots:getSnapshots
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountIds List<string>
    The account ID of the owner of the snapshot.
    Filters List<GetSnapshotsFilter>
    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
    PermissionToCreateVolumes List<string>
    SnapshotIds List<string>
    The ID of the snapshot.
    AccountIds []string
    The account ID of the owner of the snapshot.
    Filters []GetSnapshotsFilter
    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
    PermissionToCreateVolumes []string
    SnapshotIds []string
    The ID of the snapshot.
    accountIds List<String>
    The account ID of the owner of the snapshot.
    filters List<GetSnapshotsFilter>
    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
    permissionToCreateVolumes List<String>
    snapshotIds List<String>
    The ID of the snapshot.
    accountIds string[]
    The account ID of the owner of the snapshot.
    filters GetSnapshotsFilter[]
    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
    permissionToCreateVolumes string[]
    snapshotIds string[]
    The ID of the snapshot.
    account_ids Sequence[str]
    The account ID of the owner of the snapshot.
    filters Sequence[GetSnapshotsFilter]
    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
    permission_to_create_volumes Sequence[str]
    snapshot_ids Sequence[str]
    The ID of the snapshot.
    accountIds List<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
    permissionToCreateVolumes List<String>
    snapshotIds List<String>
    The ID of the snapshot.

    getSnapshots Result

    The following output properties are available:

    Id string
    RequestId string
    Snapshots List<GetSnapshotsSnapshot>
    Information about one or more snapshots and their permissions.
    AccountIds List<string>
    The account ID of the owner of the snapshot.
    Filters List<GetSnapshotsFilter>
    PermissionToCreateVolumes List<string>
    SnapshotIds List<string>
    The ID of the snapshot.
    Id string
    RequestId string
    Snapshots []GetSnapshotsSnapshot
    Information about one or more snapshots and their permissions.
    AccountIds []string
    The account ID of the owner of the snapshot.
    Filters []GetSnapshotsFilter
    PermissionToCreateVolumes []string
    SnapshotIds []string
    The ID of the snapshot.
    id String
    requestId String
    snapshots List<GetSnapshotsSnapshot>
    Information about one or more snapshots and their permissions.
    accountIds List<String>
    The account ID of the owner of the snapshot.
    filters List<GetSnapshotsFilter>
    permissionToCreateVolumes List<String>
    snapshotIds List<String>
    The ID of the snapshot.
    id string
    requestId string
    snapshots GetSnapshotsSnapshot[]
    Information about one or more snapshots and their permissions.
    accountIds string[]
    The account ID of the owner of the snapshot.
    filters GetSnapshotsFilter[]
    permissionToCreateVolumes string[]
    snapshotIds string[]
    The ID of the snapshot.
    id str
    request_id str
    snapshots Sequence[GetSnapshotsSnapshot]
    Information about one or more snapshots and their permissions.
    account_ids Sequence[str]
    The account ID of the owner of the snapshot.
    filters Sequence[GetSnapshotsFilter]
    permission_to_create_volumes Sequence[str]
    snapshot_ids Sequence[str]
    The ID of the snapshot.
    id String
    requestId String
    snapshots List<Property Map>
    Information about one or more snapshots and their permissions.
    accountIds List<String>
    The account ID of the owner of the snapshot.
    filters List<Property Map>
    permissionToCreateVolumes List<String>
    snapshotIds List<String>
    The ID of the snapshot.

    Supporting Types

    GetSnapshotsFilter

    Name string
    Values List<string>
    Name string
    Values []string
    name String
    values List<String>
    name string
    values string[]
    name str
    values Sequence[str]
    name String
    values List<String>

    GetSnapshotsSnapshot

    AccountAlias string
    The account alias of the owner of the snapshot.
    AccountId string
    The account ID of the owner of the snapshot.
    CreationDate string
    The date and time (UTC) at which the snapshot was created.
    Description string
    The description of the snapshot.
    PermissionsToCreateVolumes List<GetSnapshotsSnapshotPermissionsToCreateVolume>
    Permissions for the resource.
    Progress double
    The progress of the snapshot, as a percentage.
    SnapshotId string
    The ID of the snapshot.
    State string
    The state of the snapshot (in-queue | pending | completed | error | deleting)).
    Tags List<GetSnapshotsSnapshotTag>
    One or more tags associated with the snapshot.
    VolumeId string
    The ID of the volume used to create the snapshot.
    VolumeSize double
    The size of the volume used to create the snapshot, in gibibytes (GiB).
    AccountAlias string
    The account alias of the owner of the snapshot.
    AccountId string
    The account ID of the owner of the snapshot.
    CreationDate string
    The date and time (UTC) at which the snapshot was created.
    Description string
    The description of the snapshot.
    PermissionsToCreateVolumes []GetSnapshotsSnapshotPermissionsToCreateVolume
    Permissions for the resource.
    Progress float64
    The progress of the snapshot, as a percentage.
    SnapshotId string
    The ID of the snapshot.
    State string
    The state of the snapshot (in-queue | pending | completed | error | deleting)).
    Tags []GetSnapshotsSnapshotTag
    One or more tags associated with the snapshot.
    VolumeId string
    The ID of the volume used to create the snapshot.
    VolumeSize float64
    The size of the volume used to create the snapshot, in gibibytes (GiB).
    accountAlias String
    The account alias of the owner of the snapshot.
    accountId String
    The account ID of the owner of the snapshot.
    creationDate String
    The date and time (UTC) at which the snapshot was created.
    description String
    The description of the snapshot.
    permissionsToCreateVolumes List<GetSnapshotsSnapshotPermissionsToCreateVolume>
    Permissions for the resource.
    progress Double
    The progress of the snapshot, as a percentage.
    snapshotId String
    The ID of the snapshot.
    state String
    The state of the snapshot (in-queue | pending | completed | error | deleting)).
    tags List<GetSnapshotsSnapshotTag>
    One or more tags associated with the snapshot.
    volumeId String
    The ID of the volume used to create the snapshot.
    volumeSize Double
    The size of the volume used to create the snapshot, in gibibytes (GiB).
    accountAlias string
    The account alias of the owner of the snapshot.
    accountId string
    The account ID of the owner of the snapshot.
    creationDate string
    The date and time (UTC) at which the snapshot was created.
    description string
    The description of the snapshot.
    permissionsToCreateVolumes GetSnapshotsSnapshotPermissionsToCreateVolume[]
    Permissions for the resource.
    progress number
    The progress of the snapshot, as a percentage.
    snapshotId string
    The ID of the snapshot.
    state string
    The state of the snapshot (in-queue | pending | completed | error | deleting)).
    tags GetSnapshotsSnapshotTag[]
    One or more tags associated with the snapshot.
    volumeId string
    The ID of the volume used to create the snapshot.
    volumeSize number
    The size of the volume used to create the snapshot, in gibibytes (GiB).
    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.
    permissions_to_create_volumes Sequence[GetSnapshotsSnapshotPermissionsToCreateVolume]
    Permissions for the resource.
    progress float
    The progress of the snapshot, as a percentage.
    snapshot_id str
    The ID of the snapshot.
    state str
    The state of the snapshot (in-queue | pending | completed | error | deleting)).
    tags Sequence[GetSnapshotsSnapshotTag]
    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).
    accountAlias String
    The account alias of the owner of the snapshot.
    accountId String
    The account ID of the owner of the snapshot.
    creationDate String
    The date and time (UTC) at which the snapshot was created.
    description String
    The description of the snapshot.
    permissionsToCreateVolumes List<Property Map>
    Permissions for the resource.
    progress Number
    The progress of the snapshot, as a percentage.
    snapshotId String
    The ID of the snapshot.
    state String
    The state of the snapshot (in-queue | pending | completed | error | deleting)).
    tags List<Property Map>
    One or more tags associated with the snapshot.
    volumeId String
    The ID of the volume used to create the snapshot.
    volumeSize Number
    The size of the volume used to create the snapshot, in gibibytes (GiB).

    GetSnapshotsSnapshotPermissionsToCreateVolume

    AccountIds List<string>
    One or more account IDs that the permission is associated with.
    GlobalPermission 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 is Removals). (Response) If true, the resource is public. If false, the resource is private.
    AccountIds []string
    One or more account IDs that the permission is associated with.
    GlobalPermission 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 is Removals). (Response) If true, the resource is public. If false, the resource is private.
    accountIds List<String>
    One or more account IDs that the permission is associated with.
    globalPermission 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 is Removals). (Response) If true, the resource is public. If false, the resource is private.
    accountIds string[]
    One or more account IDs that the permission is associated with.
    globalPermission 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 is Removals). (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 is Removals). (Response) If true, the resource is public. If false, the resource is private.
    accountIds List<String>
    One or more account IDs that the permission is associated with.
    globalPermission 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 is Removals). (Response) If true, the resource is public. If false, the resource is private.

    GetSnapshotsSnapshotTag

    Key string
    The key of the tag, with a minimum of 1 character.
    Value string
    The value of the tag, between 0 and 255 characters.
    Key string
    The key of the tag, with a minimum of 1 character.
    Value string
    The value of the tag, between 0 and 255 characters.
    key String
    The key of the tag, with a minimum of 1 character.
    value String
    The value of the tag, between 0 and 255 characters.
    key string
    The key of the tag, with a minimum of 1 character.
    value string
    The value of the tag, between 0 and 255 characters.
    key str
    The key of the tag, with a minimum of 1 character.
    value str
    The value of the tag, between 0 and 255 characters.
    key String
    The key of the tag, with a minimum of 1 character.
    value String
    The value of the tag, between 0 and 255 characters.

    Package Details

    Repository
    outscale outscale/terraform-provider-outscale
    License
    Notes
    This Pulumi package is based on the outscale Terraform Provider.
    outscale logo
    outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
    outscale/terraform-provider-outscale