outscale 1.0.1, Mar 13 25

outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale

outscale.getSnapshot

Explore with Pulumi AI

outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale

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 dictionary

The following arguments are supported:

AccountId string: The account ID of the owner of the snapshot.
Filters List<GetSnapshotFilter>: 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
SnapshotId string: The ID of the snapshot.

AccountId string: The account ID of the owner of the snapshot.
Filters []GetSnapshotFilter: 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
SnapshotId string: The ID of the snapshot.

accountId String: The account ID of the owner of the snapshot.
filters List<GetSnapshotFilter>: 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
snapshotId String: The ID of the snapshot.

accountId string: The account ID of the owner of the snapshot.
filters GetSnapshotFilter[]: 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
snapshotId string: The ID of the snapshot.

account_id str: The account ID of the owner of the snapshot.
filters Sequence[GetSnapshotFilter]: 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.

accountId 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
snapshotId String: The ID of the snapshot.

getSnapshot Result

The following output properties are available:

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.
Id string
PermissionsToCreateVolumes List<GetSnapshotPermissionsToCreateVolume>: Permissions for the resource.
Progress double: The progress of the snapshot, as a percentage.
RequestId string
SnapshotId string: The ID of the snapshot.
State string: The state of the snapshot (in-queue | pending | completed | error | deleting)).
Tags List<GetSnapshotTag>: 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).
Filters List<GetSnapshotFilter>

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.
Id string
PermissionsToCreateVolumes []GetSnapshotPermissionsToCreateVolume: Permissions for the resource.
Progress float64: The progress of the snapshot, as a percentage.
RequestId string
SnapshotId string: The ID of the snapshot.
State string: The state of the snapshot (in-queue | pending | completed | error | deleting)).
Tags []GetSnapshotTag: 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).
Filters []GetSnapshotFilter

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.
id String
permissionsToCreateVolumes List<GetSnapshotPermissionsToCreateVolume>: Permissions for the resource.
progress Double: The progress of the snapshot, as a percentage.
requestId String
snapshotId String: The ID of the snapshot.
state String: The state of the snapshot (in-queue | pending | completed | error | deleting)).
tags List<GetSnapshotTag>: 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).
filters List<GetSnapshotFilter>

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.
id string
permissionsToCreateVolumes GetSnapshotPermissionsToCreateVolume[]: Permissions for the resource.
progress number: The progress of the snapshot, as a percentage.
requestId string
snapshotId string: The ID of the snapshot.
state string: The state of the snapshot (in-queue | pending | completed | error | deleting)).
tags GetSnapshotTag[]: 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).
filters GetSnapshotFilter[]

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_create_volumes Sequence[GetSnapshotPermissionsToCreateVolume]: 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)).
tags Sequence[GetSnapshotTag]: 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[GetSnapshotFilter]

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.
id String
permissionsToCreateVolumes List<Property Map>: Permissions for the resource.
progress Number: The progress of the snapshot, as a percentage.
requestId String
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).
filters List<Property Map>

Supporting Types

GetSnapshotFilter

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>

GetSnapshotPermissionsToCreateVolume

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.

GetSnapshotTag

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 1.0.1 published on Thursday, Mar 13, 2025 by outscale

outscale/terraform-provider-outscale

outscale.getSnapshot

On this page

On this page

Example Usage

Using getSnapshot

getSnapshot Result

Supporting Types

GetSnapshotFilter

GetSnapshotPermissionsToCreateVolume

GetSnapshotTag

Package Details

On this page

On this page