1. Packages
  2. Linode Provider
  3. API Docs
  4. getImage
Linode v4.30.1 published on Thursday, Nov 21, 2024 by Pulumi

linode.getImage

Explore with Pulumi AI

linode logo
Linode v4.30.1 published on Thursday, Nov 21, 2024 by Pulumi

    Provides information about a Linode image For more information, see the Linode APIv4 docs.

    Example Usage

    The following example shows how one might use this data source to access information about a Linode image.

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const k8Master = linode.getImage({
        id: "linode/debian12",
    });
    
    import pulumi
    import pulumi_linode as linode
    
    k8_master = linode.get_image(id="linode/debian12")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := linode.LookupImage(ctx, &linode.LookupImageArgs{
    			Id: "linode/debian12",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var k8Master = Linode.GetImage.Invoke(new()
        {
            Id = "linode/debian12",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.LinodeFunctions;
    import com.pulumi.linode.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 k8Master = LinodeFunctions.getImage(GetImageArgs.builder()
                .id("linode/debian12")
                .build());
    
        }
    }
    
    variables:
      k8Master:
        fn::invoke:
          Function: linode:getImage
          Arguments:
            id: linode/debian12
    

    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(id: Optional[str] = None,
                  replications: Optional[Sequence[GetImageReplication]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetImageResult
    def get_image_output(id: Optional[pulumi.Input[str]] = None,
                  replications: Optional[pulumi.Input[Sequence[pulumi.Input[GetImageReplicationArgs]]]] = 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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: linode:index/getImage:getImage
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The unique ID of this Image. The ID of private images begin with private/ followed by the numeric identifier of the private image, for example private/12345.
    Replications List<GetImageReplication>
    A list of image replication regions and corresponding status.
    Id string
    The unique ID of this Image. The ID of private images begin with private/ followed by the numeric identifier of the private image, for example private/12345.
    Replications []GetImageReplication
    A list of image replication regions and corresponding status.
    id String
    The unique ID of this Image. The ID of private images begin with private/ followed by the numeric identifier of the private image, for example private/12345.
    replications List<GetImageReplication>
    A list of image replication regions and corresponding status.
    id string
    The unique ID of this Image. The ID of private images begin with private/ followed by the numeric identifier of the private image, for example private/12345.
    replications GetImageReplication[]
    A list of image replication regions and corresponding status.
    id str
    The unique ID of this Image. The ID of private images begin with private/ followed by the numeric identifier of the private image, for example private/12345.
    replications Sequence[GetImageReplication]
    A list of image replication regions and corresponding status.
    id String
    The unique ID of this Image. The ID of private images begin with private/ followed by the numeric identifier of the private image, for example private/12345.
    replications List<Property Map>
    A list of image replication regions and corresponding status.

    getImage Result

    The following output properties are available:

    Capabilities List<string>
    Created string
    When this Image was created.
    CreatedBy string
    The name of the User who created this Image, or "linode" for official Images.
    Deprecated bool
    Whether or not this Image is deprecated. Will only be true for deprecated public Images.
    Description string
    A detailed description of this Image.
    Expiry string
    Id string
    IsPublic bool
    True if the Image is public.
    Label string
    A short description of the Image.
    Size int
    The minimum size this Image needs to deploy. Size is in MB. example: 2500
    Status string
    The status of an image replica.
    Tags List<string>
    A list of customized tags.
    TotalSize int
    The total size of the image in all available regions.
    Type string
    How the Image was created. Manual Images can be created at any time. "Automatic" Images are created automatically from a deleted Linode. (manual, automatic)
    Vendor string
    The upstream distribution vendor. None for private Images.
    Replications List<GetImageReplication>
    A list of image replication regions and corresponding status.
    Capabilities []string
    Created string
    When this Image was created.
    CreatedBy string
    The name of the User who created this Image, or "linode" for official Images.
    Deprecated bool
    Whether or not this Image is deprecated. Will only be true for deprecated public Images.
    Description string
    A detailed description of this Image.
    Expiry string
    Id string
    IsPublic bool
    True if the Image is public.
    Label string
    A short description of the Image.
    Size int
    The minimum size this Image needs to deploy. Size is in MB. example: 2500
    Status string
    The status of an image replica.
    Tags []string
    A list of customized tags.
    TotalSize int
    The total size of the image in all available regions.
    Type string
    How the Image was created. Manual Images can be created at any time. "Automatic" Images are created automatically from a deleted Linode. (manual, automatic)
    Vendor string
    The upstream distribution vendor. None for private Images.
    Replications []GetImageReplication
    A list of image replication regions and corresponding status.
    capabilities List<String>
    created String
    When this Image was created.
    createdBy String
    The name of the User who created this Image, or "linode" for official Images.
    deprecated Boolean
    Whether or not this Image is deprecated. Will only be true for deprecated public Images.
    description String
    A detailed description of this Image.
    expiry String
    id String
    isPublic Boolean
    True if the Image is public.
    label String
    A short description of the Image.
    size Integer
    The minimum size this Image needs to deploy. Size is in MB. example: 2500
    status String
    The status of an image replica.
    tags List<String>
    A list of customized tags.
    totalSize Integer
    The total size of the image in all available regions.
    type String
    How the Image was created. Manual Images can be created at any time. "Automatic" Images are created automatically from a deleted Linode. (manual, automatic)
    vendor String
    The upstream distribution vendor. None for private Images.
    replications List<GetImageReplication>
    A list of image replication regions and corresponding status.
    capabilities string[]
    created string
    When this Image was created.
    createdBy string
    The name of the User who created this Image, or "linode" for official Images.
    deprecated boolean
    Whether or not this Image is deprecated. Will only be true for deprecated public Images.
    description string
    A detailed description of this Image.
    expiry string
    id string
    isPublic boolean
    True if the Image is public.
    label string
    A short description of the Image.
    size number
    The minimum size this Image needs to deploy. Size is in MB. example: 2500
    status string
    The status of an image replica.
    tags string[]
    A list of customized tags.
    totalSize number
    The total size of the image in all available regions.
    type string
    How the Image was created. Manual Images can be created at any time. "Automatic" Images are created automatically from a deleted Linode. (manual, automatic)
    vendor string
    The upstream distribution vendor. None for private Images.
    replications GetImageReplication[]
    A list of image replication regions and corresponding status.
    capabilities Sequence[str]
    created str
    When this Image was created.
    created_by str
    The name of the User who created this Image, or "linode" for official Images.
    deprecated bool
    Whether or not this Image is deprecated. Will only be true for deprecated public Images.
    description str
    A detailed description of this Image.
    expiry str
    id str
    is_public bool
    True if the Image is public.
    label str
    A short description of the Image.
    size int
    The minimum size this Image needs to deploy. Size is in MB. example: 2500
    status str
    The status of an image replica.
    tags Sequence[str]
    A list of customized tags.
    total_size int
    The total size of the image in all available regions.
    type str
    How the Image was created. Manual Images can be created at any time. "Automatic" Images are created automatically from a deleted Linode. (manual, automatic)
    vendor str
    The upstream distribution vendor. None for private Images.
    replications Sequence[GetImageReplication]
    A list of image replication regions and corresponding status.
    capabilities List<String>
    created String
    When this Image was created.
    createdBy String
    The name of the User who created this Image, or "linode" for official Images.
    deprecated Boolean
    Whether or not this Image is deprecated. Will only be true for deprecated public Images.
    description String
    A detailed description of this Image.
    expiry String
    id String
    isPublic Boolean
    True if the Image is public.
    label String
    A short description of the Image.
    size Number
    The minimum size this Image needs to deploy. Size is in MB. example: 2500
    status String
    The status of an image replica.
    tags List<String>
    A list of customized tags.
    totalSize Number
    The total size of the image in all available regions.
    type String
    How the Image was created. Manual Images can be created at any time. "Automatic" Images are created automatically from a deleted Linode. (manual, automatic)
    vendor String
    The upstream distribution vendor. None for private Images.
    replications List<Property Map>
    A list of image replication regions and corresponding status.

    Supporting Types

    GetImageReplication

    Region string
    The region of an image replica.
    Status string
    The status of an image replica.
    Region string
    The region of an image replica.
    Status string
    The status of an image replica.
    region String
    The region of an image replica.
    status String
    The status of an image replica.
    region string
    The region of an image replica.
    status string
    The status of an image replica.
    region str
    The region of an image replica.
    status str
    The status of an image replica.
    region String
    The region of an image replica.
    status String
    The status of an image replica.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.30.1 published on Thursday, Nov 21, 2024 by Pulumi