Hetzner Cloud
getImage
Example Usage
using Pulumi;
using HCloud = Pulumi.HCloud;
class MyStack : Stack
{
public MyStack()
{
var image1 = Output.Create(HCloud.GetImage.InvokeAsync(new HCloud.GetImageArgs
{
Id = 1234,
}));
var image2 = Output.Create(HCloud.GetImage.InvokeAsync(new HCloud.GetImageArgs
{
Name = "ubuntu-18.04",
}));
var image3 = Output.Create(HCloud.GetImage.InvokeAsync(new HCloud.GetImageArgs
{
WithSelector = "key=value",
}));
var main = new HCloud.Server("main", new HCloud.ServerArgs
{
Image = image1.Apply(image1 => image1.Id),
});
}
}
package main
import (
"github.com/pulumi/pulumi-hcloud/sdk/go/hcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
image1, err := hcloud.GetImage(ctx, &GetImageArgs{
Id: pulumi.IntRef(1234),
}, nil)
if err != nil {
return err
}
_, err = hcloud.GetImage(ctx, &GetImageArgs{
Name: pulumi.StringRef("ubuntu-18.04"),
}, nil)
if err != nil {
return err
}
_, err = hcloud.GetImage(ctx, &GetImageArgs{
WithSelector: pulumi.StringRef("key=value"),
}, nil)
if err != nil {
return err
}
_, err = hcloud.NewServer(ctx, "main", &hcloud.ServerArgs{
Image: pulumi.Int(image1.Id),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var image1 = Output.of(HcloudFunctions.getImage(GetImageArgs.builder()
.id("1234")
.build()));
final var image2 = Output.of(HcloudFunctions.getImage(GetImageArgs.builder()
.name("ubuntu-18.04")
.build()));
final var image3 = Output.of(HcloudFunctions.getImage(GetImageArgs.builder()
.withSelector("key=value")
.build()));
var main = new Server("main", ServerArgs.builder()
.image(image1.apply(getImageResult -> getImageResult.id()))
.build());
}
}
import pulumi
import pulumi_hcloud as hcloud
image1 = hcloud.get_image(id=1234)
image2 = hcloud.get_image(name="ubuntu-18.04")
image3 = hcloud.get_image(with_selector="key=value")
main = hcloud.Server("main", image=image1.id)
import * as pulumi from "@pulumi/pulumi";
import * as hcloud from "@pulumi/hcloud";
const image1 = hcloud.getImage({
id: 1234,
});
const image2 = hcloud.getImage({
name: "ubuntu-18.04",
});
const image3 = hcloud.getImage({
withSelector: "key=value",
});
const main = new hcloud.Server("main", {image: image1.then(image1 => image1.id)});
resources:
main:
type: hcloud:Server
properties:
image: ${image1.id}
variables:
image1:
Fn::Invoke:
Function: hcloud:getImage
Arguments:
id: 1234
image2:
Fn::Invoke:
Function: hcloud:getImage
Arguments:
name: ubuntu-18.04
image3:
Fn::Invoke:
Function: hcloud:getImage
Arguments:
withSelector: key=value
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[int] = None,
most_recent: Optional[bool] = None,
name: Optional[str] = None,
selector: Optional[str] = None,
with_selector: Optional[str] = None,
with_statuses: Optional[Sequence[str]] = None,
opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(id: Optional[pulumi.Input[int]] = None,
most_recent: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
selector: Optional[pulumi.Input[str]] = None,
with_selector: Optional[pulumi.Input[str]] = None,
with_statuses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]
func GetImage(ctx *Context, args *GetImageArgs, opts ...InvokeOption) (*GetImageResult, error)
func GetImageOutput(ctx *Context, args *GetImageOutputArgs, opts ...InvokeOption) GetImageResultOutput
> Note: This function is named GetImage
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: hcloud:index/getImage:getImage
Arguments:
# Arguments dictionary
The following arguments are supported:
- Id int
ID of the Image.
- Most
Recent bool If more than one result is returned, use the most recent Image.
- Name string
Name of the Image.
- Selector string
Please use the with_selector property instead.
- With
Selector string - With
Statuses List<string> List only images with the specified status, could contain
creating
oravailable
.
- Id int
ID of the Image.
- Most
Recent bool If more than one result is returned, use the most recent Image.
- Name string
Name of the Image.
- Selector string
Please use the with_selector property instead.
- With
Selector string - With
Statuses []string List only images with the specified status, could contain
creating
oravailable
.
- id Integer
ID of the Image.
- most
Recent Boolean If more than one result is returned, use the most recent Image.
- name String
Name of the Image.
- selector String
Please use the with_selector property instead.
- with
Selector String - with
Statuses List<String> List only images with the specified status, could contain
creating
oravailable
.
- id number
ID of the Image.
- most
Recent boolean If more than one result is returned, use the most recent Image.
- name string
Name of the Image.
- selector string
Please use the with_selector property instead.
- with
Selector string - with
Statuses string[] List only images with the specified status, could contain
creating
oravailable
.
- id int
ID of the Image.
- most_
recent bool If more than one result is returned, use the most recent Image.
- name str
Name of the Image.
- selector str
Please use the with_selector property instead.
- with_
selector str - with_
statuses Sequence[str] List only images with the specified status, could contain
creating
oravailable
.
- id Number
ID of the Image.
- most
Recent Boolean If more than one result is returned, use the most recent Image.
- name String
Name of the Image.
- selector String
Please use the with_selector property instead.
- with
Selector String - with
Statuses List<String> List only images with the specified status, could contain
creating
oravailable
.
getImage Result
The following output properties are available:
- Created string
(string) Date when the Image was created (in ISO-8601 format).
- Deprecated string
(string) Point in time when the image is considered to be deprecated (in ISO-8601 format).
- Description string
(string) Description of the Image.
- Id int
(int) Unique ID of the Image.
- Labels Dictionary<string, object>
- Name string
(string) Name of the Image, only present when the Image is of type
system
.- Os
Flavor string (string) Flavor of operating system contained in the image, could be
ubuntu
,centos
,debian
,fedora
orunknown
.- Os
Version string (string) Operating system version.
- Rapid
Deploy bool (bool) Indicates that rapid deploy of the image is available.
- Type string
(string) Type of the Image, could be
system
,backup
orsnapshot
.- Most
Recent bool - Selector string
Please use the with_selector property instead.
- With
Selector string - With
Statuses List<string>
- Created string
(string) Date when the Image was created (in ISO-8601 format).
- Deprecated string
(string) Point in time when the image is considered to be deprecated (in ISO-8601 format).
- Description string
(string) Description of the Image.
- Id int
(int) Unique ID of the Image.
- Labels map[string]interface{}
- Name string
(string) Name of the Image, only present when the Image is of type
system
.- Os
Flavor string (string) Flavor of operating system contained in the image, could be
ubuntu
,centos
,debian
,fedora
orunknown
.- Os
Version string (string) Operating system version.
- Rapid
Deploy bool (bool) Indicates that rapid deploy of the image is available.
- Type string
(string) Type of the Image, could be
system
,backup
orsnapshot
.- Most
Recent bool - Selector string
Please use the with_selector property instead.
- With
Selector string - With
Statuses []string
- created String
(string) Date when the Image was created (in ISO-8601 format).
- deprecated String
(string) Point in time when the image is considered to be deprecated (in ISO-8601 format).
- description String
(string) Description of the Image.
- id Integer
(int) Unique ID of the Image.
- labels Map<String,Object>
- name String
(string) Name of the Image, only present when the Image is of type
system
.- os
Flavor String (string) Flavor of operating system contained in the image, could be
ubuntu
,centos
,debian
,fedora
orunknown
.- os
Version String (string) Operating system version.
- rapid
Deploy Boolean (bool) Indicates that rapid deploy of the image is available.
- type String
(string) Type of the Image, could be
system
,backup
orsnapshot
.- most
Recent Boolean - selector String
Please use the with_selector property instead.
- with
Selector String - with
Statuses List<String>
- created string
(string) Date when the Image was created (in ISO-8601 format).
- deprecated string
(string) Point in time when the image is considered to be deprecated (in ISO-8601 format).
- description string
(string) Description of the Image.
- id number
(int) Unique ID of the Image.
- labels {[key: string]: any}
- name string
(string) Name of the Image, only present when the Image is of type
system
.- os
Flavor string (string) Flavor of operating system contained in the image, could be
ubuntu
,centos
,debian
,fedora
orunknown
.- os
Version string (string) Operating system version.
- rapid
Deploy boolean (bool) Indicates that rapid deploy of the image is available.
- type string
(string) Type of the Image, could be
system
,backup
orsnapshot
.- most
Recent boolean - selector string
Please use the with_selector property instead.
- with
Selector string - with
Statuses string[]
- created str
(string) Date when the Image was created (in ISO-8601 format).
- deprecated str
(string) Point in time when the image is considered to be deprecated (in ISO-8601 format).
- description str
(string) Description of the Image.
- id int
(int) Unique ID of the Image.
- labels Mapping[str, Any]
- name str
(string) Name of the Image, only present when the Image is of type
system
.- os_
flavor str (string) Flavor of operating system contained in the image, could be
ubuntu
,centos
,debian
,fedora
orunknown
.- os_
version str (string) Operating system version.
- rapid_
deploy bool (bool) Indicates that rapid deploy of the image is available.
- type str
(string) Type of the Image, could be
system
,backup
orsnapshot
.- most_
recent bool - selector str
Please use the with_selector property instead.
- with_
selector str - with_
statuses Sequence[str]
- created String
(string) Date when the Image was created (in ISO-8601 format).
- deprecated String
(string) Point in time when the image is considered to be deprecated (in ISO-8601 format).
- description String
(string) Description of the Image.
- id Number
(int) Unique ID of the Image.
- labels Map<Any>
- name String
(string) Name of the Image, only present when the Image is of type
system
.- os
Flavor String (string) Flavor of operating system contained in the image, could be
ubuntu
,centos
,debian
,fedora
orunknown
.- os
Version String (string) Operating system version.
- rapid
Deploy Boolean (bool) Indicates that rapid deploy of the image is available.
- type String
(string) Type of the Image, could be
system
,backup
orsnapshot
.- most
Recent Boolean - selector String
Please use the with_selector property instead.
- with
Selector String - with
Statuses List<String>
Package Details
- Repository
- https://github.com/pulumi/pulumi-hcloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
hcloud
Terraform Provider.