getAmi function
Use this data source to get the ID of a registered AMI for use in other resources.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.ec2.getAmi({
filters: [
{
name: "name",
values: ["myami-*"],
},
{
name: "root-device-type",
values: ["ebs"],
},
{
name: "virtualization-type",
values: ["hvm"],
},
],
executableUsers: ["self"],
mostRecent: true,
nameRegex: "^myami-[0-9]{3}",
owners: ["self"],
});
import pulumi
import pulumi_aws as aws
example = aws.ec2.get_ami(filters=[
{
"name": "name",
"values": ["myami-*"],
},
{
"name": "root-device-type",
"values": ["ebs"],
},
{
"name": "virtualization-type",
"values": ["hvm"],
},
],
executable_users=["self"],
most_recent=True,
name_regex="^myami-[0-9]{3}",
owners=["self"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Ec2.GetAmi.Invoke(new()
{
Filters = new[]
{
new Aws.Ec2.Inputs.GetAmiFilterInputArgs
{
Name = "name",
Values = new[]
{
"myami-*",
},
},
new Aws.Ec2.Inputs.GetAmiFilterInputArgs
{
Name = "root-device-type",
Values = new[]
{
"ebs",
},
},
new Aws.Ec2.Inputs.GetAmiFilterInputArgs
{
Name = "virtualization-type",
Values = new[]
{
"hvm",
},
},
},
ExecutableUsers = new[]
{
"self",
},
MostRecent = true,
NameRegex = "^myami-[0-9]{3}",
Owners = new[]
{
"self",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2.LookupAmi(ctx, &ec2.LookupAmiArgs{
Filters: []ec2.GetAmiFilter{
{
Name: "name",
Values: []string{
"myami-*",
},
},
{
Name: "root-device-type",
Values: []string{
"ebs",
},
},
{
Name: "virtualization-type",
Values: []string{
"hvm",
},
},
},
ExecutableUsers: []string{
"self",
},
MostRecent: pulumi.BoolRef(true),
NameRegex: pulumi.StringRef("^myami-[0-9]{3}"),
Owners: []string{
"self",
},
}, nil)
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ec2_getami" "example" {
filters {
name = "name"
values = ["myami-*"]
}
filters {
name = "root-device-type"
values = ["ebs"]
}
filters {
name = "virtualization-type"
values = ["hvm"]
}
executable_users = ["self"]
most_recent = true
name_regex = "^myami-[0-9]{3}"
owners = ["self"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetAmiArgs;
import com.pulumi.aws.ec2.inputs.GetAmiFilterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = Ec2Functions.getAmi(GetAmiArgs.builder()
.filters(
GetAmiFilterArgs.builder()
.name("name")
.values("myami-*")
.build(),
GetAmiFilterArgs.builder()
.name("root-device-type")
.values("ebs")
.build(),
GetAmiFilterArgs.builder()
.name("virtualization-type")
.values("hvm")
.build())
.executableUsers("self")
.mostRecent(true)
.nameRegex("^myami-[0-9]{3}")
.owners("self")
.build());
}
}
variables:
example:
fn::invoke:
function: aws:ec2:getAmi
arguments:
filters:
- name: name
values:
- myami-*
- name: root-device-type
values:
- ebs
- name: virtualization-type
values:
- hvm
executableUsers:
- self
mostRecent: true
nameRegex: ^myami-[0-9]{3}
owners:
- self
args Arguments passed to this invoke. Arguments for getAmi.
options Invoke options controlling this call.
Implementation
Future<GetAmiResult> getAmi(
GetAmiArgs args, {
pulumi.InvokeOptions? options,
}) async {
final deployment = pulumi.Deployment.instance;
final result = await deployment.invoke<Map<String, dynamic>>(
'aws:ec2/getAmi:getAmi',
args.toMap(),
options: pulumi.toDeploymentInvokeOptions(options),
);
return GetAmiResult.fromMap(result);
}