Try AWS Native preview for resources not in the classic version.
aws.ec2.getAmi
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Use this data source to get the ID of a registered AMI for use in other resources.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Ec2.GetAmi.Invoke(new()
{
ExecutableUsers = new[]
{
"self",
},
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",
},
},
},
MostRecent = true,
NameRegex = "^myami-\\d{3}",
Owners = new[]
{
"self",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/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{
ExecutableUsers: []string{
"self",
},
Filters: []ec2.GetAmiFilter{
{
Name: "name",
Values: []string{
"myami-*",
},
},
{
Name: "root-device-type",
Values: []string{
"ebs",
},
},
{
Name: "virtualization-type",
Values: []string{
"hvm",
},
},
},
MostRecent: pulumi.BoolRef(true),
NameRegex: pulumi.StringRef("^myami-\\d{3}"),
Owners: []string{
"self",
},
}, nil)
if err != nil {
return err
}
return nil
})
}
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 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 example = Ec2Functions.getAmi(GetAmiArgs.builder()
.executableUsers("self")
.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())
.mostRecent(true)
.nameRegex("^myami-\\d{3}")
.owners("self")
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.ec2.get_ami(executable_users=["self"],
filters=[
aws.ec2.GetAmiFilterArgs(
name="name",
values=["myami-*"],
),
aws.ec2.GetAmiFilterArgs(
name="root-device-type",
values=["ebs"],
),
aws.ec2.GetAmiFilterArgs(
name="virtualization-type",
values=["hvm"],
),
],
most_recent=True,
name_regex="^myami-\\d{3}",
owners=["self"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.ec2.getAmi({
executableUsers: ["self"],
filters: [
{
name: "name",
values: ["myami-*"],
},
{
name: "root-device-type",
values: ["ebs"],
},
{
name: "virtualization-type",
values: ["hvm"],
},
],
mostRecent: true,
nameRegex: "^myami-\\d{3}",
owners: ["self"],
});
variables:
example:
fn::invoke:
Function: aws:ec2:getAmi
Arguments:
executableUsers:
- self
filters:
- name: name
values:
- myami-*
- name: root-device-type
values:
- ebs
- name: virtualization-type
values:
- hvm
mostRecent: true
nameRegex: ^myami-\d{3}
owners:
- self
Using getAmi
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 getAmi(args: GetAmiArgs, opts?: InvokeOptions): Promise<GetAmiResult>
function getAmiOutput(args: GetAmiOutputArgs, opts?: InvokeOptions): Output<GetAmiResult>
def get_ami(executable_users: Optional[Sequence[str]] = None,
filters: Optional[Sequence[GetAmiFilter]] = None,
include_deprecated: Optional[bool] = None,
most_recent: Optional[bool] = None,
name_regex: Optional[str] = None,
owners: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetAmiResult
def get_ami_output(executable_users: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetAmiFilterArgs]]]] = None,
include_deprecated: Optional[pulumi.Input[bool]] = None,
most_recent: Optional[pulumi.Input[bool]] = None,
name_regex: Optional[pulumi.Input[str]] = None,
owners: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAmiResult]
func LookupAmi(ctx *Context, args *LookupAmiArgs, opts ...InvokeOption) (*LookupAmiResult, error)
func LookupAmiOutput(ctx *Context, args *LookupAmiOutputArgs, opts ...InvokeOption) LookupAmiResultOutput
> Note: This function is named LookupAmi
in the Go SDK.
public static class GetAmi
{
public static Task<GetAmiResult> InvokeAsync(GetAmiArgs args, InvokeOptions? opts = null)
public static Output<GetAmiResult> Invoke(GetAmiInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAmiResult> getAmi(GetAmiArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:ec2/getAmi:getAmi
arguments:
# arguments dictionary
The following arguments are supported:
- Executable
Users List<string> Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or
self
.- Filters
List<Get
Ami Filter> One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
- Include
Deprecated bool If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
- Most
Recent bool If more than one result is returned, use the most recent AMI.
- Name
Regex string Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use
most_recent
to choose the most recent one. If you want to match multiple AMIs, use theaws.ec2.getAmiIds
data source instead.- Owners List<string>
List of AMI owners to limit search. Valid values: an AWS account ID,
self
(the current account), or an AWS owner alias (e.g.,amazon
,aws-marketplace
,microsoft
).- Dictionary<string, string>
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- Executable
Users []string Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or
self
.- Filters
[]Get
Ami Filter One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
- Include
Deprecated bool If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
- Most
Recent bool If more than one result is returned, use the most recent AMI.
- Name
Regex string Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use
most_recent
to choose the most recent one. If you want to match multiple AMIs, use theaws.ec2.getAmiIds
data source instead.- Owners []string
List of AMI owners to limit search. Valid values: an AWS account ID,
self
(the current account), or an AWS owner alias (e.g.,amazon
,aws-marketplace
,microsoft
).- map[string]string
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- executable
Users List<String> Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or
self
.- filters
List<Get
Ami Filter> One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
- include
Deprecated Boolean If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
- most
Recent Boolean If more than one result is returned, use the most recent AMI.
- name
Regex String Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use
most_recent
to choose the most recent one. If you want to match multiple AMIs, use theaws.ec2.getAmiIds
data source instead.- owners List<String>
List of AMI owners to limit search. Valid values: an AWS account ID,
self
(the current account), or an AWS owner alias (e.g.,amazon
,aws-marketplace
,microsoft
).- Map<String,String>
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- executable
Users string[] Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or
self
.- filters
Get
Ami Filter[] One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
- include
Deprecated boolean If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
- most
Recent boolean If more than one result is returned, use the most recent AMI.
- name
Regex string Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use
most_recent
to choose the most recent one. If you want to match multiple AMIs, use theaws.ec2.getAmiIds
data source instead.- owners string[]
List of AMI owners to limit search. Valid values: an AWS account ID,
self
(the current account), or an AWS owner alias (e.g.,amazon
,aws-marketplace
,microsoft
).- {[key: string]: string}
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- executable_
users Sequence[str] Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or
self
.- filters
Sequence[Get
Ami Filter] One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
- include_
deprecated bool If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
- most_
recent bool If more than one result is returned, use the most recent AMI.
- name_
regex str Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use
most_recent
to choose the most recent one. If you want to match multiple AMIs, use theaws.ec2.getAmiIds
data source instead.- owners Sequence[str]
List of AMI owners to limit search. Valid values: an AWS account ID,
self
(the current account), or an AWS owner alias (e.g.,amazon
,aws-marketplace
,microsoft
).- Mapping[str, str]
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- executable
Users List<String> Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or
self
.- filters List<Property Map>
One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
- include
Deprecated Boolean If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
- most
Recent Boolean If more than one result is returned, use the most recent AMI.
- name
Regex String Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use
most_recent
to choose the most recent one. If you want to match multiple AMIs, use theaws.ec2.getAmiIds
data source instead.- owners List<String>
List of AMI owners to limit search. Valid values: an AWS account ID,
self
(the current account), or an AWS owner alias (e.g.,amazon
,aws-marketplace
,microsoft
).- Map<String>
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
getAmi Result
The following output properties are available:
- Architecture string
OS architecture of the AMI (ie:
i386
orx86_64
).- Arn string
ARN of the AMI.
- Block
Device List<GetMappings Ami Block Device Mapping> Set of objects with block device mappings of the AMI.
- Boot
Mode string Boot mode of the image.
- Creation
Date string Date and time the image was created.
- Deprecation
Time string Date and time when the image will be deprecated.
- Description string
Description of the AMI that was provided during image creation.
- Ena
Support bool Whether enhanced networking with ENA is enabled.
- Hypervisor string
Hypervisor type of the image.
- Id string
The provider-assigned unique ID for this managed resource.
- Image
Id string ID of the AMI. Should be the same as the resource
id
.- Image
Location string Location of the AMI.
- Image
Owner stringAlias AWS account alias (for example,
amazon
,self
) or the AWS account ID of the AMI owner.- Image
Type string Type of image.
- Imds
Support string Instance Metadata Service (IMDS) support mode for the image. Set to
v2.0
if instances ran from this image enforce IMDSv2.- Kernel
Id string Kernel associated with the image, if any. Only applicable for machine images.
- Name string
Name of the AMI that was provided during image creation.
- Owner
Id string AWS account ID of the image owner.
- Platform string
Value is Windows for
Windows
AMIs; otherwise blank.- Platform
Details string Platform details associated with the billing code of the AMI.
- Product
Codes List<GetAmi Product Code> Any product codes associated with the AMI.
product_codes.#.product_code_id
- The product code.product_codes.#.product_code_type
- The type of product code.
- Public bool
true
if the image has public launch permissions.- Ramdisk
Id string RAM disk associated with the image, if any. Only applicable for machine images.
- Root
Device stringName Device name of the root device.
- Root
Device stringType Type of root device (ie:
ebs
orinstance-store
).- Root
Snapshot stringId Snapshot id associated with the root device, if any (only applies to
ebs
root devices).- Sriov
Net stringSupport Whether enhanced networking is enabled.
- State string
Current state of the AMI. If the state is
available
, the image is successfully registered and can be used to launch an instance.- State
Reason Dictionary<string, string> Describes a state change. Fields are
UNSET
if not available.state_reason.code
- The reason code for the state change.state_reason.message
- The message for the state change.
- Dictionary<string, string>
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- Tpm
Support string If the image is configured for NitroTPM support, the value is
v2.0
.- Usage
Operation string Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
- Virtualization
Type string Type of virtualization of the AMI (ie:
hvm
orparavirtual
).- Executable
Users List<string> - Filters
List<Get
Ami Filter> - Include
Deprecated bool - Most
Recent bool - Name
Regex string - Owners List<string>
- Architecture string
OS architecture of the AMI (ie:
i386
orx86_64
).- Arn string
ARN of the AMI.
- Block
Device []GetMappings Ami Block Device Mapping Set of objects with block device mappings of the AMI.
- Boot
Mode string Boot mode of the image.
- Creation
Date string Date and time the image was created.
- Deprecation
Time string Date and time when the image will be deprecated.
- Description string
Description of the AMI that was provided during image creation.
- Ena
Support bool Whether enhanced networking with ENA is enabled.
- Hypervisor string
Hypervisor type of the image.
- Id string
The provider-assigned unique ID for this managed resource.
- Image
Id string ID of the AMI. Should be the same as the resource
id
.- Image
Location string Location of the AMI.
- Image
Owner stringAlias AWS account alias (for example,
amazon
,self
) or the AWS account ID of the AMI owner.- Image
Type string Type of image.
- Imds
Support string Instance Metadata Service (IMDS) support mode for the image. Set to
v2.0
if instances ran from this image enforce IMDSv2.- Kernel
Id string Kernel associated with the image, if any. Only applicable for machine images.
- Name string
Name of the AMI that was provided during image creation.
- Owner
Id string AWS account ID of the image owner.
- Platform string
Value is Windows for
Windows
AMIs; otherwise blank.- Platform
Details string Platform details associated with the billing code of the AMI.
- Product
Codes []GetAmi Product Code Any product codes associated with the AMI.
product_codes.#.product_code_id
- The product code.product_codes.#.product_code_type
- The type of product code.
- Public bool
true
if the image has public launch permissions.- Ramdisk
Id string RAM disk associated with the image, if any. Only applicable for machine images.
- Root
Device stringName Device name of the root device.
- Root
Device stringType Type of root device (ie:
ebs
orinstance-store
).- Root
Snapshot stringId Snapshot id associated with the root device, if any (only applies to
ebs
root devices).- Sriov
Net stringSupport Whether enhanced networking is enabled.
- State string
Current state of the AMI. If the state is
available
, the image is successfully registered and can be used to launch an instance.- State
Reason map[string]string Describes a state change. Fields are
UNSET
if not available.state_reason.code
- The reason code for the state change.state_reason.message
- The message for the state change.
- map[string]string
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- Tpm
Support string If the image is configured for NitroTPM support, the value is
v2.0
.- Usage
Operation string Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
- Virtualization
Type string Type of virtualization of the AMI (ie:
hvm
orparavirtual
).- Executable
Users []string - Filters
[]Get
Ami Filter - Include
Deprecated bool - Most
Recent bool - Name
Regex string - Owners []string
- architecture String
OS architecture of the AMI (ie:
i386
orx86_64
).- arn String
ARN of the AMI.
- block
Device List<GetMappings Ami Block Device Mapping> Set of objects with block device mappings of the AMI.
- boot
Mode String Boot mode of the image.
- creation
Date String Date and time the image was created.
- deprecation
Time String Date and time when the image will be deprecated.
- description String
Description of the AMI that was provided during image creation.
- ena
Support Boolean Whether enhanced networking with ENA is enabled.
- hypervisor String
Hypervisor type of the image.
- id String
The provider-assigned unique ID for this managed resource.
- image
Id String ID of the AMI. Should be the same as the resource
id
.- image
Location String Location of the AMI.
- image
Owner StringAlias AWS account alias (for example,
amazon
,self
) or the AWS account ID of the AMI owner.- image
Type String Type of image.
- imds
Support String Instance Metadata Service (IMDS) support mode for the image. Set to
v2.0
if instances ran from this image enforce IMDSv2.- kernel
Id String Kernel associated with the image, if any. Only applicable for machine images.
- name String
Name of the AMI that was provided during image creation.
- owner
Id String AWS account ID of the image owner.
- platform String
Value is Windows for
Windows
AMIs; otherwise blank.- platform
Details String Platform details associated with the billing code of the AMI.
- product
Codes List<GetAmi Product Code> Any product codes associated with the AMI.
product_codes.#.product_code_id
- The product code.product_codes.#.product_code_type
- The type of product code.
- public_ Boolean
true
if the image has public launch permissions.- ramdisk
Id String RAM disk associated with the image, if any. Only applicable for machine images.
- root
Device StringName Device name of the root device.
- root
Device StringType Type of root device (ie:
ebs
orinstance-store
).- root
Snapshot StringId Snapshot id associated with the root device, if any (only applies to
ebs
root devices).- sriov
Net StringSupport Whether enhanced networking is enabled.
- state String
Current state of the AMI. If the state is
available
, the image is successfully registered and can be used to launch an instance.- state
Reason Map<String,String> Describes a state change. Fields are
UNSET
if not available.state_reason.code
- The reason code for the state change.state_reason.message
- The message for the state change.
- Map<String,String>
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- tpm
Support String If the image is configured for NitroTPM support, the value is
v2.0
.- usage
Operation String Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
- virtualization
Type String Type of virtualization of the AMI (ie:
hvm
orparavirtual
).- executable
Users List<String> - filters
List<Get
Ami Filter> - include
Deprecated Boolean - most
Recent Boolean - name
Regex String - owners List<String>
- architecture string
OS architecture of the AMI (ie:
i386
orx86_64
).- arn string
ARN of the AMI.
- block
Device GetMappings Ami Block Device Mapping[] Set of objects with block device mappings of the AMI.
- boot
Mode string Boot mode of the image.
- creation
Date string Date and time the image was created.
- deprecation
Time string Date and time when the image will be deprecated.
- description string
Description of the AMI that was provided during image creation.
- ena
Support boolean Whether enhanced networking with ENA is enabled.
- hypervisor string
Hypervisor type of the image.
- id string
The provider-assigned unique ID for this managed resource.
- image
Id string ID of the AMI. Should be the same as the resource
id
.- image
Location string Location of the AMI.
- image
Owner stringAlias AWS account alias (for example,
amazon
,self
) or the AWS account ID of the AMI owner.- image
Type string Type of image.
- imds
Support string Instance Metadata Service (IMDS) support mode for the image. Set to
v2.0
if instances ran from this image enforce IMDSv2.- kernel
Id string Kernel associated with the image, if any. Only applicable for machine images.
- name string
Name of the AMI that was provided during image creation.
- owner
Id string AWS account ID of the image owner.
- platform string
Value is Windows for
Windows
AMIs; otherwise blank.- platform
Details string Platform details associated with the billing code of the AMI.
- product
Codes GetAmi Product Code[] Any product codes associated with the AMI.
product_codes.#.product_code_id
- The product code.product_codes.#.product_code_type
- The type of product code.
- public boolean
true
if the image has public launch permissions.- ramdisk
Id string RAM disk associated with the image, if any. Only applicable for machine images.
- root
Device stringName Device name of the root device.
- root
Device stringType Type of root device (ie:
ebs
orinstance-store
).- root
Snapshot stringId Snapshot id associated with the root device, if any (only applies to
ebs
root devices).- sriov
Net stringSupport Whether enhanced networking is enabled.
- state string
Current state of the AMI. If the state is
available
, the image is successfully registered and can be used to launch an instance.- state
Reason {[key: string]: string} Describes a state change. Fields are
UNSET
if not available.state_reason.code
- The reason code for the state change.state_reason.message
- The message for the state change.
- {[key: string]: string}
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- tpm
Support string If the image is configured for NitroTPM support, the value is
v2.0
.- usage
Operation string Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
- virtualization
Type string Type of virtualization of the AMI (ie:
hvm
orparavirtual
).- executable
Users string[] - filters
Get
Ami Filter[] - include
Deprecated boolean - most
Recent boolean - name
Regex string - owners string[]
- architecture str
OS architecture of the AMI (ie:
i386
orx86_64
).- arn str
ARN of the AMI.
- block_
device_ Sequence[Getmappings Ami Block Device Mapping] Set of objects with block device mappings of the AMI.
- boot_
mode str Boot mode of the image.
- creation_
date str Date and time the image was created.
- deprecation_
time str Date and time when the image will be deprecated.
- description str
Description of the AMI that was provided during image creation.
- ena_
support bool Whether enhanced networking with ENA is enabled.
- hypervisor str
Hypervisor type of the image.
- id str
The provider-assigned unique ID for this managed resource.
- image_
id str ID of the AMI. Should be the same as the resource
id
.- image_
location str Location of the AMI.
- image_
owner_ stralias AWS account alias (for example,
amazon
,self
) or the AWS account ID of the AMI owner.- image_
type str Type of image.
- imds_
support str Instance Metadata Service (IMDS) support mode for the image. Set to
v2.0
if instances ran from this image enforce IMDSv2.- kernel_
id str Kernel associated with the image, if any. Only applicable for machine images.
- name str
Name of the AMI that was provided during image creation.
- owner_
id str AWS account ID of the image owner.
- platform str
Value is Windows for
Windows
AMIs; otherwise blank.- platform_
details str Platform details associated with the billing code of the AMI.
- product_
codes Sequence[GetAmi Product Code] Any product codes associated with the AMI.
product_codes.#.product_code_id
- The product code.product_codes.#.product_code_type
- The type of product code.
- public bool
true
if the image has public launch permissions.- ramdisk_
id str RAM disk associated with the image, if any. Only applicable for machine images.
- root_
device_ strname Device name of the root device.
- root_
device_ strtype Type of root device (ie:
ebs
orinstance-store
).- root_
snapshot_ strid Snapshot id associated with the root device, if any (only applies to
ebs
root devices).- sriov_
net_ strsupport Whether enhanced networking is enabled.
- state str
Current state of the AMI. If the state is
available
, the image is successfully registered and can be used to launch an instance.- state_
reason Mapping[str, str] Describes a state change. Fields are
UNSET
if not available.state_reason.code
- The reason code for the state change.state_reason.message
- The message for the state change.
- Mapping[str, str]
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- tpm_
support str If the image is configured for NitroTPM support, the value is
v2.0
.- usage_
operation str Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
- virtualization_
type str Type of virtualization of the AMI (ie:
hvm
orparavirtual
).- executable_
users Sequence[str] - filters
Sequence[Get
Ami Filter] - include_
deprecated bool - most_
recent bool - name_
regex str - owners Sequence[str]
- architecture String
OS architecture of the AMI (ie:
i386
orx86_64
).- arn String
ARN of the AMI.
- block
Device List<Property Map>Mappings Set of objects with block device mappings of the AMI.
- boot
Mode String Boot mode of the image.
- creation
Date String Date and time the image was created.
- deprecation
Time String Date and time when the image will be deprecated.
- description String
Description of the AMI that was provided during image creation.
- ena
Support Boolean Whether enhanced networking with ENA is enabled.
- hypervisor String
Hypervisor type of the image.
- id String
The provider-assigned unique ID for this managed resource.
- image
Id String ID of the AMI. Should be the same as the resource
id
.- image
Location String Location of the AMI.
- image
Owner StringAlias AWS account alias (for example,
amazon
,self
) or the AWS account ID of the AMI owner.- image
Type String Type of image.
- imds
Support String Instance Metadata Service (IMDS) support mode for the image. Set to
v2.0
if instances ran from this image enforce IMDSv2.- kernel
Id String Kernel associated with the image, if any. Only applicable for machine images.
- name String
Name of the AMI that was provided during image creation.
- owner
Id String AWS account ID of the image owner.
- platform String
Value is Windows for
Windows
AMIs; otherwise blank.- platform
Details String Platform details associated with the billing code of the AMI.
- product
Codes List<Property Map> Any product codes associated with the AMI.
product_codes.#.product_code_id
- The product code.product_codes.#.product_code_type
- The type of product code.
- public Boolean
true
if the image has public launch permissions.- ramdisk
Id String RAM disk associated with the image, if any. Only applicable for machine images.
- root
Device StringName Device name of the root device.
- root
Device StringType Type of root device (ie:
ebs
orinstance-store
).- root
Snapshot StringId Snapshot id associated with the root device, if any (only applies to
ebs
root devices).- sriov
Net StringSupport Whether enhanced networking is enabled.
- state String
Current state of the AMI. If the state is
available
, the image is successfully registered and can be used to launch an instance.- state
Reason Map<String> Describes a state change. Fields are
UNSET
if not available.state_reason.code
- The reason code for the state change.state_reason.message
- The message for the state change.
- Map<String>
Any tags assigned to the image.
tags.#.key
- Key name of the tag.tags.#.value
- Value of the tag.
- tpm
Support String If the image is configured for NitroTPM support, the value is
v2.0
.- usage
Operation String Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
- virtualization
Type String Type of virtualization of the AMI (ie:
hvm
orparavirtual
).- executable
Users List<String> - filters List<Property Map>
- include
Deprecated Boolean - most
Recent Boolean - name
Regex String - owners List<String>
Supporting Types
GetAmiBlockDeviceMapping
- Device
Name string Physical name of the device.
- Ebs Dictionary<string, string>
Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g.,
ebs.volume_size
orebs["volume_size"]
) rather than accessed through the first element of a list (e.g.,ebs[0].volume_size
).- No
Device string Suppresses the specified device included in the block device mapping of the AMI.
- Virtual
Name string Virtual device name (for instance stores).
- Device
Name string Physical name of the device.
- Ebs map[string]string
Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g.,
ebs.volume_size
orebs["volume_size"]
) rather than accessed through the first element of a list (e.g.,ebs[0].volume_size
).- No
Device string Suppresses the specified device included in the block device mapping of the AMI.
- Virtual
Name string Virtual device name (for instance stores).
- device
Name String Physical name of the device.
- ebs Map<String,String>
Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g.,
ebs.volume_size
orebs["volume_size"]
) rather than accessed through the first element of a list (e.g.,ebs[0].volume_size
).- no
Device String Suppresses the specified device included in the block device mapping of the AMI.
- virtual
Name String Virtual device name (for instance stores).
- device
Name string Physical name of the device.
- ebs {[key: string]: string}
Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g.,
ebs.volume_size
orebs["volume_size"]
) rather than accessed through the first element of a list (e.g.,ebs[0].volume_size
).- no
Device string Suppresses the specified device included in the block device mapping of the AMI.
- virtual
Name string Virtual device name (for instance stores).
- device_
name str Physical name of the device.
- ebs Mapping[str, str]
Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g.,
ebs.volume_size
orebs["volume_size"]
) rather than accessed through the first element of a list (e.g.,ebs[0].volume_size
).- no_
device str Suppresses the specified device included in the block device mapping of the AMI.
- virtual_
name str Virtual device name (for instance stores).
- device
Name String Physical name of the device.
- ebs Map<String>
Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g.,
ebs.volume_size
orebs["volume_size"]
) rather than accessed through the first element of a list (e.g.,ebs[0].volume_size
).- no
Device String Suppresses the specified device included in the block device mapping of the AMI.
- virtual
Name String Virtual device name (for instance stores).
GetAmiFilter
GetAmiProductCode
- Product
Code stringId - Product
Code stringType
- Product
Code stringId - Product
Code stringType
- product
Code StringId - product
Code StringType
- product
Code stringId - product
Code stringType
- product_
code_ strid - product_
code_ strtype
- product
Code StringId - product
Code StringType
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.