outscale 1.0.1, Mar 13 25

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

outscale.getImage

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 image01 = outscale.getImage({
    filters: [{
        name: "image_ids",
        values: ["ami-12345678"],
    }],
});

import pulumi
import pulumi_outscale as outscale

image01 = outscale.get_image(filters=[{
    "name": "image_ids",
    "values": ["ami-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.LookupImage(ctx, &outscale.LookupImageArgs{
			Filters: []outscale.GetImageFilter{
				{
					Name: "image_ids",
					Values: []string{
						"ami-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 image01 = Outscale.GetImage.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetImageFilterInputArgs
            {
                Name = "image_ids",
                Values = new[]
                {
                    "ami-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.GetImageArgs;
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 image01 = OutscaleFunctions.getImage(GetImageArgs.builder()
            .filters(GetImageFilterArgs.builder()
                .name("image_ids")
                .values("ami-12345678")
                .build())
            .build());

    }
}

variables:
  image01:
    fn::invoke:
      function: outscale:getImage
      arguments:
        filters:
          - name: image_ids
            values:
              - ami-12345678

Using getImage

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 getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>
function getImageOutput(args: GetImageOutputArgs, opts?: InvokeOptions): Output<GetImageResult>

def get_image(block_device_mappings: Optional[Sequence[GetImageBlockDeviceMapping]] = None,
              filters: Optional[Sequence[GetImageFilter]] = None,
              id: Optional[str] = None,
              image_id: Optional[str] = None,
              permissions: Optional[Sequence[str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(block_device_mappings: Optional[pulumi.Input[Sequence[pulumi.Input[GetImageBlockDeviceMappingArgs]]]] = None,
              filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetImageFilterArgs]]]] = None,
              id: Optional[pulumi.Input[str]] = None,
              image_id: Optional[pulumi.Input[str]] = None,
              permissions: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]

func LookupImage(ctx *Context, args *LookupImageArgs, opts ...InvokeOption) (*LookupImageResult, error)
func LookupImageOutput(ctx *Context, args *LookupImageOutputArgs, opts ...InvokeOption) LookupImageResultOutput

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

public static class GetImage 
{
    public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
    public static Output<GetImageResult> Invoke(GetImageInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
public static Output<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)

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

The following arguments are supported:

BlockDeviceMappings List<GetImageBlockDeviceMapping>: One or more block device mappings.
Filters List<GetImageFilter>: 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
ImageId string: The ID of the OMI.
Permissions List<string>

BlockDeviceMappings []GetImageBlockDeviceMapping: One or more block device mappings.
Filters []GetImageFilter: 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
ImageId string: The ID of the OMI.
Permissions []string

blockDeviceMappings List<GetImageBlockDeviceMapping>: One or more block device mappings.
filters List<GetImageFilter>: 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
imageId String: The ID of the OMI.
permissions List<String>

blockDeviceMappings GetImageBlockDeviceMapping[]: One or more block device mappings.
filters GetImageFilter[]: 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
imageId string: The ID of the OMI.
permissions string[]

block_device_mappings Sequence[GetImageBlockDeviceMapping]: One or more block device mappings.
filters Sequence[GetImageFilter]: 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
image_id str: The ID of the OMI.
permissions Sequence[str]

blockDeviceMappings List<Property Map>: One or more block device mappings.
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
imageId String: The ID of the OMI.
permissions List<String>

getImage Result

The following output properties are available:

AccountAlias string: The account alias of the owner of the OMI.
AccountId string: The account ID of the owner of the OMI.
Architecture string: The architecture of the OMI.
CreationDate string: The date and time (UTC) at which the OMI was created.
Description string: The description of the OMI.
FileLocation string: The location from which the OMI files were created.
Id string
ImageName string: The name of the OMI.
ImageType string: The type of the OMI.
IsPublic bool
PermissionsToLaunches List<GetImagePermissionsToLaunch>: Permissions for the resource.
ProductCodes List<string>: The product codes associated with the OMI.
RequestId string
RootDeviceName string: The name of the root device.
RootDeviceType string: The type of root device used by the OMI (always bsu).
State string: The state of the OMI (pending | available | failed).
StateComments List<GetImageStateComment>: Information about the change of state.
Tags List<GetImageTag>: One or more tags associated with the OMI.
BlockDeviceMappings List<GetImageBlockDeviceMapping>: One or more block device mappings.
Filters List<GetImageFilter>
ImageId string: The ID of the OMI.
Permissions List<string>

AccountAlias string: The account alias of the owner of the OMI.
AccountId string: The account ID of the owner of the OMI.
Architecture string: The architecture of the OMI.
CreationDate string: The date and time (UTC) at which the OMI was created.
Description string: The description of the OMI.
FileLocation string: The location from which the OMI files were created.
Id string
ImageName string: The name of the OMI.
ImageType string: The type of the OMI.
IsPublic bool
PermissionsToLaunches []GetImagePermissionsToLaunch: Permissions for the resource.
ProductCodes []string: The product codes associated with the OMI.
RequestId string
RootDeviceName string: The name of the root device.
RootDeviceType string: The type of root device used by the OMI (always bsu).
State string: The state of the OMI (pending | available | failed).
StateComments []GetImageStateComment: Information about the change of state.
Tags []GetImageTag: One or more tags associated with the OMI.
BlockDeviceMappings []GetImageBlockDeviceMapping: One or more block device mappings.
Filters []GetImageFilter
ImageId string: The ID of the OMI.
Permissions []string

accountAlias String: The account alias of the owner of the OMI.
accountId String: The account ID of the owner of the OMI.
architecture String: The architecture of the OMI.
creationDate String: The date and time (UTC) at which the OMI was created.
description String: The description of the OMI.
fileLocation String: The location from which the OMI files were created.
id String
imageName String: The name of the OMI.
imageType String: The type of the OMI.
isPublic Boolean
permissionsToLaunches List<GetImagePermissionsToLaunch>: Permissions for the resource.
productCodes List<String>: The product codes associated with the OMI.
requestId String
rootDeviceName String: The name of the root device.
rootDeviceType String: The type of root device used by the OMI (always bsu).
state String: The state of the OMI (pending | available | failed).
stateComments List<GetImageStateComment>: Information about the change of state.
tags List<GetImageTag>: One or more tags associated with the OMI.
blockDeviceMappings List<GetImageBlockDeviceMapping>: One or more block device mappings.
filters List<GetImageFilter>
imageId String: The ID of the OMI.
permissions List<String>

accountAlias string: The account alias of the owner of the OMI.
accountId string: The account ID of the owner of the OMI.
architecture string: The architecture of the OMI.
creationDate string: The date and time (UTC) at which the OMI was created.
description string: The description of the OMI.
fileLocation string: The location from which the OMI files were created.
id string
imageName string: The name of the OMI.
imageType string: The type of the OMI.
isPublic boolean
permissionsToLaunches GetImagePermissionsToLaunch[]: Permissions for the resource.
productCodes string[]: The product codes associated with the OMI.
requestId string
rootDeviceName string: The name of the root device.
rootDeviceType string: The type of root device used by the OMI (always bsu).
state string: The state of the OMI (pending | available | failed).
stateComments GetImageStateComment[]: Information about the change of state.
tags GetImageTag[]: One or more tags associated with the OMI.
blockDeviceMappings GetImageBlockDeviceMapping[]: One or more block device mappings.
filters GetImageFilter[]
imageId string: The ID of the OMI.
permissions string[]

account_alias str: The account alias of the owner of the OMI.
account_id str: The account ID of the owner of the OMI.
architecture str: The architecture of the OMI.
creation_date str: The date and time (UTC) at which the OMI was created.
description str: The description of the OMI.
file_location str: The location from which the OMI files were created.
id str
image_name str: The name of the OMI.
image_type str: The type of the OMI.
is_public bool
permissions_to_launches Sequence[GetImagePermissionsToLaunch]: Permissions for the resource.
product_codes Sequence[str]: The product codes associated with the OMI.
request_id str
root_device_name str: The name of the root device.
root_device_type str: The type of root device used by the OMI (always bsu).
state str: The state of the OMI (pending | available | failed).
state_comments Sequence[GetImageStateComment]: Information about the change of state.
tags Sequence[GetImageTag]: One or more tags associated with the OMI.
block_device_mappings Sequence[GetImageBlockDeviceMapping]: One or more block device mappings.
filters Sequence[GetImageFilter]
image_id str: The ID of the OMI.
permissions Sequence[str]

accountAlias String: The account alias of the owner of the OMI.
accountId String: The account ID of the owner of the OMI.
architecture String: The architecture of the OMI.
creationDate String: The date and time (UTC) at which the OMI was created.
description String: The description of the OMI.
fileLocation String: The location from which the OMI files were created.
id String
imageName String: The name of the OMI.
imageType String: The type of the OMI.
isPublic Boolean
permissionsToLaunches List<Property Map>: Permissions for the resource.
productCodes List<String>: The product codes associated with the OMI.
requestId String
rootDeviceName String: The name of the root device.
rootDeviceType String: The type of root device used by the OMI (always bsu).
state String: The state of the OMI (pending | available | failed).
stateComments List<Property Map>: Information about the change of state.
tags List<Property Map>: One or more tags associated with the OMI.
blockDeviceMappings List<Property Map>: One or more block device mappings.
filters List<Property Map>
imageId String: The ID of the OMI.
permissions List<String>

Supporting Types

GetImageBlockDeviceMapping

DeviceName string: The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
VirtualDeviceName string: The name of the virtual device (ephemeralN).
Bsus List<GetImageBlockDeviceMappingBsus>: Information about the BSU volume to create.

DeviceName string: The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
VirtualDeviceName string: The name of the virtual device (ephemeralN).
Bsus []GetImageBlockDeviceMappingBsus: Information about the BSU volume to create.

deviceName String: The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
virtualDeviceName String: The name of the virtual device (ephemeralN).
bsus List<GetImageBlockDeviceMappingBsus>: Information about the BSU volume to create.

deviceName string: The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
virtualDeviceName string: The name of the virtual device (ephemeralN).
bsus GetImageBlockDeviceMappingBsus[]: Information about the BSU volume to create.

device_name str: The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
virtual_device_name str: The name of the virtual device (ephemeralN).
bsus Sequence[GetImageBlockDeviceMappingBsus]: Information about the BSU volume to create.

deviceName String: The device name for the volume. For a root device, you must use /dev/sda1. For other volumes, you must use /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX (where the first X is a letter between b and z, and the second X is a letter between a and z).
virtualDeviceName String: The name of the virtual device (ephemeralN).
bsus List<Property Map>: Information about the BSU volume to create.

GetImageBlockDeviceMappingBsus

DeleteOnVmDeletion bool: By default or if set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
Iops double: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
SnapshotId string: The ID of the snapshot used to create the volume.
VolumeSize double: The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
VolumeType string: The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.

DeleteOnVmDeletion bool: By default or if set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
Iops float64: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
SnapshotId string: The ID of the snapshot used to create the volume.
VolumeSize float64: The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
VolumeType string: The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.

deleteOnVmDeletion Boolean: By default or if set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
iops Double: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
snapshotId String: The ID of the snapshot used to create the volume.
volumeSize Double: The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
volumeType String: The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.

deleteOnVmDeletion boolean: By default or if set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
iops number: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
snapshotId string: The ID of the snapshot used to create the volume.
volumeSize number: The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
volumeType string: The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.

delete_on_vm_deletion bool: By default or if set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
iops float: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
snapshot_id str: The ID of the snapshot used to create the volume.
volume_size float: The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
volume_type str: The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.

deleteOnVmDeletion Boolean: By default or if set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
iops Number: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
snapshotId String: The ID of the snapshot used to create the volume.
volumeSize Number: The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
volumeType String: The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.

GetImageFilter

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>

GetImagePermissionsToLaunch

AccountId string: The account ID of the owner of the OMI.
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.

AccountId string: The account ID of the owner of the OMI.
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.

accountId String: The account ID of the owner of the OMI.
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.

accountId string: The account ID of the owner of the OMI.
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_id str: The account ID of the owner of the OMI.
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.

accountId String: The account ID of the owner of the OMI.
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.

GetImageStateComment

StateCode string: The code of the change of state.
StateMessage string: A message explaining the change of state.

StateCode string: The code of the change of state.
StateMessage string: A message explaining the change of state.

stateCode String: The code of the change of state.
stateMessage String: A message explaining the change of state.

stateCode string: The code of the change of state.
stateMessage string: A message explaining the change of state.

state_code str: The code of the change of state.
state_message str: A message explaining the change of state.

stateCode String: The code of the change of state.
stateMessage String: A message explaining the change of state.

GetImageTag

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.getImage

On this page

On this page

Example Usage

Using getImage

getImage Result

Supporting Types

GetImageBlockDeviceMapping

GetImageBlockDeviceMappingBsus

GetImageFilter

GetImagePermissionsToLaunch

GetImageStateComment

GetImageTag

Package Details

On this page

On this page