1. Packages
  2. Linode
  3. API Docs
  4. Image
Linode v4.7.0 published on Friday, Sep 29, 2023 by Pulumi

linode.Image

Explore with Pulumi AI

linode logo
Linode v4.7.0 published on Friday, Sep 29, 2023 by Pulumi

    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

    new Image(name: string, args: ImageArgs, opts?: CustomResourceOptions);
    @overload
    def Image(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              cloud_init: Optional[bool] = None,
              description: Optional[str] = None,
              disk_id: Optional[int] = None,
              file_hash: Optional[str] = None,
              file_path: Optional[str] = None,
              label: Optional[str] = None,
              linode_id: Optional[int] = None,
              region: Optional[str] = None)
    @overload
    def Image(resource_name: str,
              args: ImageArgs,
              opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    The Image resource accepts the following input properties:

    Label string

    A short description of the Image. Labels cannot contain special characters.

    CloudInit bool

    Whether this image supports cloud-init.

    Description string

    A detailed description of this Image.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    Region string

    The region of the image. See all regions here.

    Label string

    A short description of the Image. Labels cannot contain special characters.

    CloudInit bool

    Whether this image supports cloud-init.

    Description string

    A detailed description of this Image.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    Region string

    The region of the image. See all regions here.

    label String

    A short description of the Image. Labels cannot contain special characters.

    cloudInit Boolean

    Whether this image supports cloud-init.

    description String

    A detailed description of this Image.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    region String

    The region of the image. See all regions here.

    label string

    A short description of the Image. Labels cannot contain special characters.

    cloudInit boolean

    Whether this image supports cloud-init.

    description string

    A detailed description of this Image.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    region string

    The region of the image. See all regions here.

    label str

    A short description of the Image. Labels cannot contain special characters.

    cloud_init bool

    Whether this image supports cloud-init.

    description str

    A detailed description of this Image.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    region str

    The region of the image. See all regions here.

    label String

    A short description of the Image. Labels cannot contain special characters.

    cloudInit Boolean

    Whether this image supports cloud-init.

    description String

    A detailed description of this Image.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    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:

    Capabilities List<string>

    The capabilities of this Image.

    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.

    Capabilities []string

    The capabilities of this Image.

    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.

    capabilities List<String>

    The capabilities of this Image.

    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.

    capabilities string[]

    The capabilities of this Image.

    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.

    capabilities Sequence[str]

    The capabilities of this Image.

    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.

    capabilities List<String>

    The capabilities of this Image.

    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,
            capabilities: Optional[Sequence[str]] = None,
            cloud_init: Optional[bool] = 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)
    Resource lookup is not supported in YAML
    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:
    Capabilities List<string>

    The capabilities of this Image.

    CloudInit bool

    Whether this image supports cloud-init.

    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.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    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.

    Capabilities []string

    The capabilities of this Image.

    CloudInit bool

    Whether this image supports cloud-init.

    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.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    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.

    capabilities List<String>

    The capabilities of this Image.

    cloudInit Boolean

    Whether this image supports cloud-init.

    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.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    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.

    capabilities string[]

    The capabilities of this Image.

    cloudInit boolean

    Whether this image supports cloud-init.

    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.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    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.

    capabilities Sequence[str]

    The capabilities of this Image.

    cloud_init bool

    Whether this image supports cloud-init.

    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.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    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.

    capabilities List<String>

    The capabilities of this Image.

    cloudInit Boolean

    Whether this image supports cloud-init.

    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.


    The following arguments apply to creating an image from an existing Linode Instance:

    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.


    NOTICE: Uploading images is currently in beta. Ensure LINODE_API_VERSION is set to v4beta in order to use this functionality.

    The following arguments apply to uploading an image:

    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
    

    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.7.0 published on Friday, Sep 29, 2023 by Pulumi