1. Packages
  2. Packages
  3. Linode Provider
  4. API Docs
  5. Image
Viewing docs for Linode v3.12.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-linode

linode.Image

linode logo
Viewing docs for Linode v3.12.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-linode

    Provides a Linode Image resource. This can be used to create, modify, and delete Linodes Images. Linode Images are snapshots of a Linode Instance Disk which can then be used to provision more Linode Instances. Images can be used across regions.

    For more information, see Linode’s documentation on Images and the Linode APIv4 docs.

    Create Image Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Image(name: string, args: ImageArgs, opts?: CustomResourceOptions);
    @overload
def Image(resource_name: str,
          args: ImageArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Image(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          label: Optional[str] = None,
          description: Optional[str] = None,
          disk_id: Optional[int] = None,
          file_hash: Optional[str] = None,
          file_path: Optional[str] = None,
          linode_id: Optional[int] = None,
          region: Optional[str] = None)
    func NewImage(ctx *Context, name string, args ImageArgs, opts ...ResourceOption) (*Image, error)
    public Image(string name, ImageArgs args, CustomResourceOptions? opts = null)
    public Image(String name, ImageArgs args)
public Image(String name, ImageArgs args, CustomResourceOptions options)

    type: linode:Image
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ImageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var imageResource = new Linode.Image("imageResource", new()
{
    Label = "string",
    Description = "string",
    DiskId = 0,
    FileHash = "string",
    FilePath = "string",
    LinodeId = 0,
    Region = "string",
});

    example, err := linode.NewImage(ctx, "imageResource", &linode.ImageArgs{
	Label:       pulumi.String("string"),
	Description: pulumi.String("string"),
	DiskId:      pulumi.Int(0),
	FileHash:    pulumi.String("string"),
	FilePath:    pulumi.String("string"),
	LinodeId:    pulumi.Int(0),
	Region:      pulumi.String("string"),
})

    var imageResource = new Image("imageResource", ImageArgs.builder()
    .label("string")
    .description("string")
    .diskId(0)
    .fileHash("string")
    .filePath("string")
    .linodeId(0)
    .region("string")
    .build());

    image_resource = linode.Image("imageResource",
    label="string",
    description="string",
    disk_id=0,
    file_hash="string",
    file_path="string",
    linode_id=0,
    region="string")

    const imageResource = new linode.Image("imageResource", {
    label: "string",
    description: "string",
    diskId: 0,
    fileHash: "string",
    filePath: "string",
    linodeId: 0,
    region: "string",
});

    type: linode:Image
properties:
    description: string
    diskId: 0
    fileHash: string
    filePath: string
    label: string
    linodeId: 0
    region: string

    Image Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Image resource accepts the following input properties:

    Label string
    A short description of the Image. Labels cannot contain special characters.
    Description string
    A detailed description of this Image.
    DiskId int
    The ID of the Linode Disk that this Image will be created from.
    FileHash string
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    FilePath string
    The path of the image file to be uploaded.
    LinodeId int
    The ID of the Linode that this Image will be created from.
    Region string
    The region of the image. See all regions here.
    Label string
    A short description of the Image. Labels cannot contain special characters.
    Description string
    A detailed description of this Image.
    DiskId int
    The ID of the Linode Disk that this Image will be created from.
    FileHash string
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    FilePath string
    The path of the image file to be uploaded.
    LinodeId int
    The ID of the Linode that this Image will be created from.
    Region string
    The region of the image. See all regions here.
    label String
    A short description of the Image. Labels cannot contain special characters.
    description String
    A detailed description of this Image.
    diskId Integer
    The ID of the Linode Disk that this Image will be created from.
    fileHash String
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    filePath String
    The path of the image file to be uploaded.
    linodeId Integer
    The ID of the Linode that this Image will be created from.
    region String
    The region of the image. See all regions here.
    label string
    A short description of the Image. Labels cannot contain special characters.
    description string
    A detailed description of this Image.
    diskId number
    The ID of the Linode Disk that this Image will be created from.
    fileHash string
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    filePath string
    The path of the image file to be uploaded.
    linodeId number
    The ID of the Linode that this Image will be created from.
    region string
    The region of the image. See all regions here.
    label str
    A short description of the Image. Labels cannot contain special characters.
    description str
    A detailed description of this Image.
    disk_id int
    The ID of the Linode Disk that this Image will be created from.
    file_hash str
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    file_path str
    The path of the image file to be uploaded.
    linode_id int
    The ID of the Linode that this Image will be created from.
    region str
    The region of the image. See all regions here.
    label String
    A short description of the Image. Labels cannot contain special characters.
    description String
    A detailed description of this Image.
    diskId Number
    The ID of the Linode Disk that this Image will be created from.
    fileHash String
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    filePath String
    The path of the image file to be uploaded.
    linodeId Number
    The ID of the Linode that this Image will be created from.
    region String
    The region of the image. See all regions here.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Image resource produces the following output properties:

    Created string
    When this Image was created.
    CreatedBy string
    The name of the User who created this Image.
    Deprecated bool
    Whether or not this Image is deprecated. Will only be True for deprecated public Images.
    Expiry string
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsPublic bool
    True if the Image is public.
    Size int
    The minimum size this Image needs to deploy. Size is in MB.
    Status string
    The current status of this Image.
    Type string
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    Vendor string
    The upstream distribution vendor. Nil for private Images.
    Created string
    When this Image was created.
    CreatedBy string
    The name of the User who created this Image.
    Deprecated bool
    Whether or not this Image is deprecated. Will only be True for deprecated public Images.
    Expiry string
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsPublic bool
    True if the Image is public.
    Size int
    The minimum size this Image needs to deploy. Size is in MB.
    Status string
    The current status of this Image.
    Type string
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    Vendor string
    The upstream distribution vendor. Nil for private Images.
    created String
    When this Image was created.
    createdBy String
    The name of the User who created this Image.
    deprecated Boolean
    Whether or not this Image is deprecated. Will only be True for deprecated public Images.
    expiry String
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    id String
    The provider-assigned unique ID for this managed resource.
    isPublic Boolean
    True if the Image is public.
    size Integer
    The minimum size this Image needs to deploy. Size is in MB.
    status String
    The current status of this Image.
    type String
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    vendor String
    The upstream distribution vendor. Nil for private Images.
    created string
    When this Image was created.
    createdBy string
    The name of the User who created this Image.
    deprecated boolean
    Whether or not this Image is deprecated. Will only be True for deprecated public Images.
    expiry string
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    id string
    The provider-assigned unique ID for this managed resource.
    isPublic boolean
    True if the Image is public.
    size number
    The minimum size this Image needs to deploy. Size is in MB.
    status string
    The current status of this Image.
    type string
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    vendor string
    The upstream distribution vendor. Nil for private Images.
    created str
    When this Image was created.
    created_by str
    The name of the User who created this Image.
    deprecated bool
    Whether or not this Image is deprecated. Will only be True for deprecated public Images.
    expiry str
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    id str
    The provider-assigned unique ID for this managed resource.
    is_public bool
    True if the Image is public.
    size int
    The minimum size this Image needs to deploy. Size is in MB.
    status str
    The current status of this Image.
    type str
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    vendor str
    The upstream distribution vendor. Nil for private Images.
    created String
    When this Image was created.
    createdBy String
    The name of the User who created this Image.
    deprecated Boolean
    Whether or not this Image is deprecated. Will only be True for deprecated public Images.
    expiry String
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    id String
    The provider-assigned unique ID for this managed resource.
    isPublic Boolean
    True if the Image is public.
    size Number
    The minimum size this Image needs to deploy. Size is in MB.
    status String
    The current status of this Image.
    type String
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    vendor String
    The upstream distribution vendor. Nil for private Images.

    Look up Existing Image Resource

    Get an existing Image resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ImageState, opts?: CustomResourceOptions): Image
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created: Optional[str] = None,
        created_by: Optional[str] = None,
        deprecated: Optional[bool] = None,
        description: Optional[str] = None,
        disk_id: Optional[int] = None,
        expiry: Optional[str] = None,
        file_hash: Optional[str] = None,
        file_path: Optional[str] = None,
        is_public: Optional[bool] = None,
        label: Optional[str] = None,
        linode_id: Optional[int] = None,
        region: Optional[str] = None,
        size: Optional[int] = None,
        status: Optional[str] = None,
        type: Optional[str] = None,
        vendor: Optional[str] = None) -> Image
    func GetImage(ctx *Context, name string, id IDInput, state *ImageState, opts ...ResourceOption) (*Image, error)
    public static Image Get(string name, Input<string> id, ImageState? state, CustomResourceOptions? opts = null)
    public static Image get(String name, Output<String> id, ImageState state, CustomResourceOptions options)
    resources:  _:    type: linode:Image    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Created string
    When this Image was created.
    CreatedBy string
    The name of the User who created this Image.
    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.
    DiskId int
    The ID of the Linode Disk that this Image will be created from.
    Expiry string
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    FileHash string
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    FilePath string
    The path of the image file to be uploaded.
    IsPublic bool
    True if the Image is public.
    Label string
    A short description of the Image. Labels cannot contain special characters.
    LinodeId int
    The ID of the Linode that this Image will be created from.
    Region string
    The region of the image. See all regions here.
    Size int
    The minimum size this Image needs to deploy. Size is in MB.
    Status string
    The current status of this Image.
    Type string
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    Vendor string
    The upstream distribution vendor. Nil for private Images.
    Created string
    When this Image was created.
    CreatedBy string
    The name of the User who created this Image.
    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.
    DiskId int
    The ID of the Linode Disk that this Image will be created from.
    Expiry string
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    FileHash string
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    FilePath string
    The path of the image file to be uploaded.
    IsPublic bool
    True if the Image is public.
    Label string
    A short description of the Image. Labels cannot contain special characters.
    LinodeId int
    The ID of the Linode that this Image will be created from.
    Region string
    The region of the image. See all regions here.
    Size int
    The minimum size this Image needs to deploy. Size is in MB.
    Status string
    The current status of this Image.
    Type string
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    Vendor string
    The upstream distribution vendor. Nil for private Images.
    created String
    When this Image was created.
    createdBy String
    The name of the User who created this Image.
    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.
    diskId Integer
    The ID of the Linode Disk that this Image will be created from.
    expiry String
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    fileHash String
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    filePath String
    The path of the image file to be uploaded.
    isPublic Boolean
    True if the Image is public.
    label String
    A short description of the Image. Labels cannot contain special characters.
    linodeId Integer
    The ID of the Linode that this Image will be created from.
    region String
    The region of the image. See all regions here.
    size Integer
    The minimum size this Image needs to deploy. Size is in MB.
    status String
    The current status of this Image.
    type String
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    vendor String
    The upstream distribution vendor. Nil for private Images.
    created string
    When this Image was created.
    createdBy string
    The name of the User who created this Image.
    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.
    diskId number
    The ID of the Linode Disk that this Image will be created from.
    expiry string
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    fileHash string
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    filePath string
    The path of the image file to be uploaded.
    isPublic boolean
    True if the Image is public.
    label string
    A short description of the Image. Labels cannot contain special characters.
    linodeId number
    The ID of the Linode that this Image will be created from.
    region string
    The region of the image. See all regions here.
    size number
    The minimum size this Image needs to deploy. Size is in MB.
    status string
    The current status of this Image.
    type string
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    vendor string
    The upstream distribution vendor. Nil for private Images.
    created str
    When this Image was created.
    created_by str
    The name of the User who created this Image.
    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.
    disk_id int
    The ID of the Linode Disk that this Image will be created from.
    expiry str
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    file_hash str
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    file_path str
    The path of the image file to be uploaded.
    is_public bool
    True if the Image is public.
    label str
    A short description of the Image. Labels cannot contain special characters.
    linode_id int
    The ID of the Linode that this Image will be created from.
    region str
    The region of the image. See all regions here.
    size int
    The minimum size this Image needs to deploy. Size is in MB.
    status str
    The current status of this Image.
    type str
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    vendor str
    The upstream distribution vendor. Nil for private Images.
    created String
    When this Image was created.
    createdBy String
    The name of the User who created this Image.
    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.
    diskId Number
    The ID of the Linode Disk that this Image will be created from.
    expiry String
    Only Images created automatically (from a deleted Linode; type=automatic) will expire.
    fileHash String
    The MD5 hash of the file to be uploaded. This is used to trigger file updates.
    filePath String
    The path of the image file to be uploaded.
    isPublic Boolean
    True if the Image is public.
    label String
    A short description of the Image. Labels cannot contain special characters.
    linodeId Number
    The ID of the Linode that this Image will be created from.
    region String
    The region of the image. See all regions here.
    size Number
    The minimum size this Image needs to deploy. Size is in MB.
    status String
    The current status of this Image.
    type String
    How the Image was created. 'Manual' Images can be created at any time. 'Automatic' images are created automatically from a deleted Linode.
    vendor String
    The upstream distribution vendor. Nil for private Images.

    Import

    Linodes Images can be imported using the Linode Image id, e.g.

     $ pulumi import linode:index/image:Image myimage 1234567

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Viewing docs for Linode v3.12.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-linode
      Try Pulumi Cloud free. Your team will thank you.