AWS Cloud Control v1.26.0, Mar 12 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.ec2.getInstance

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

Using getInstance

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 getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>

def get_instance(instance_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]

func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

> Note: This function is named LookupInstance in the Go SDK.

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:ec2:getInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: The EC2 Instance ID.

InstanceId string: The EC2 Instance ID.

instanceId String: The EC2 Instance ID.

instanceId string: The EC2 Instance ID.

instance_id str: The EC2 Instance ID.

instanceId String: The EC2 Instance ID.

getInstance Result

The following output properties are available:

Affinity Pulumi.AwsNative.Ec2.InstanceAffinity: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
BlockDeviceMappings List<Pulumi.AwsNative.Ec2.Outputs.InstanceBlockDeviceMapping>: The block device mapping entries that defines the block devices to attach to the instance at launch.
CreditSpecification Pulumi.AwsNative.Ec2.Outputs.CreditSpecificationProperties: The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
DisableApiTermination bool: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
EbsOptimized bool: Indicates whether the instance is optimized for Amazon EBS I/O.
HostId string: If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
IamInstanceProfile string: The IAM instance profile.
InstanceId string: The EC2 Instance ID.
InstanceInitiatedShutdownBehavior string: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
InstanceType string: The instance type.
KernelId string: The ID of the kernel.
Monitoring bool: Specifies whether detailed monitoring is enabled for the instance.
PrivateDnsName string: The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
PrivateDnsNameOptions Pulumi.AwsNative.Ec2.Outputs.InstancePrivateDnsNameOptions: The options for the instance hostname.
PrivateIp string: The private IP address of the specified instance. For example: 10.24.34.0.
PublicDnsName string: The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
PublicIp string: The public IP address of the specified instance. For example: 192.0.2.0.
RamdiskId string: The ID of the RAM disk to select.
SecurityGroupIds List<string>: The IDs of the security groups.
SourceDestCheck bool: Specifies whether to enable an instance launched in a VPC to perform NAT.
SsmAssociations List<Pulumi.AwsNative.Ec2.Outputs.InstanceSsmAssociation>: The SSM document and parameter values in AWS Systems Manager to associate with this instance.
State Pulumi.AwsNative.Ec2.Outputs.InstanceState: The current state of the instance.
Tags List<Pulumi.AwsNative.Outputs.Tag>: The tags to add to the instance.
Tenancy string: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
UserData string: The user data to make available to the instance.
Volumes List<Pulumi.AwsNative.Ec2.Outputs.InstanceVolume>: The volumes to attach to the instance.
VpcId string: The ID of the VPC that the instance is running in.

Affinity InstanceAffinity: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
BlockDeviceMappings []InstanceBlockDeviceMapping: The block device mapping entries that defines the block devices to attach to the instance at launch.
CreditSpecification CreditSpecificationProperties: The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
DisableApiTermination bool: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
EbsOptimized bool: Indicates whether the instance is optimized for Amazon EBS I/O.
HostId string: If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
IamInstanceProfile string: The IAM instance profile.
InstanceId string: The EC2 Instance ID.
InstanceInitiatedShutdownBehavior string: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
InstanceType string: The instance type.
KernelId string: The ID of the kernel.
Monitoring bool: Specifies whether detailed monitoring is enabled for the instance.
PrivateDnsName string: The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
PrivateDnsNameOptions InstancePrivateDnsNameOptions: The options for the instance hostname.
PrivateIp string: The private IP address of the specified instance. For example: 10.24.34.0.
PublicDnsName string: The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
PublicIp string: The public IP address of the specified instance. For example: 192.0.2.0.
RamdiskId string: The ID of the RAM disk to select.
SecurityGroupIds []string: The IDs of the security groups.
SourceDestCheck bool: Specifies whether to enable an instance launched in a VPC to perform NAT.
SsmAssociations []InstanceSsmAssociation: The SSM document and parameter values in AWS Systems Manager to associate with this instance.
State InstanceStateType: The current state of the instance.
Tags Tag: The tags to add to the instance.
Tenancy string: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
UserData string: The user data to make available to the instance.
Volumes []InstanceVolume: The volumes to attach to the instance.
VpcId string: The ID of the VPC that the instance is running in.

affinity InstanceAffinity: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
blockDeviceMappings List<InstanceBlockDeviceMapping>: The block device mapping entries that defines the block devices to attach to the instance at launch.
creditSpecification CreditSpecificationProperties: The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
disableApiTermination Boolean: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
ebsOptimized Boolean: Indicates whether the instance is optimized for Amazon EBS I/O.
hostId String: If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
iamInstanceProfile String: The IAM instance profile.
instanceId String: The EC2 Instance ID.
instanceInitiatedShutdownBehavior String: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
instanceType String: The instance type.
kernelId String: The ID of the kernel.
monitoring Boolean: Specifies whether detailed monitoring is enabled for the instance.
privateDnsName String: The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
privateDnsNameOptions InstancePrivateDnsNameOptions: The options for the instance hostname.
privateIp String: The private IP address of the specified instance. For example: 10.24.34.0.
publicDnsName String: The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
publicIp String: The public IP address of the specified instance. For example: 192.0.2.0.
ramdiskId String: The ID of the RAM disk to select.
securityGroupIds List<String>: The IDs of the security groups.
sourceDestCheck Boolean: Specifies whether to enable an instance launched in a VPC to perform NAT.
ssmAssociations List<InstanceSsmAssociation>: The SSM document and parameter values in AWS Systems Manager to associate with this instance.
state InstanceState: The current state of the instance.
tags List<Tag>: The tags to add to the instance.
tenancy String: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
userData String: The user data to make available to the instance.
volumes List<InstanceVolume>: The volumes to attach to the instance.
vpcId String: The ID of the VPC that the instance is running in.

affinity InstanceAffinity: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
blockDeviceMappings InstanceBlockDeviceMapping[]: The block device mapping entries that defines the block devices to attach to the instance at launch.
creditSpecification CreditSpecificationProperties: The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
disableApiTermination boolean: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
ebsOptimized boolean: Indicates whether the instance is optimized for Amazon EBS I/O.
hostId string: If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
iamInstanceProfile string: The IAM instance profile.
instanceId string: The EC2 Instance ID.
instanceInitiatedShutdownBehavior string: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
instanceType string: The instance type.
kernelId string: The ID of the kernel.
monitoring boolean: Specifies whether detailed monitoring is enabled for the instance.
privateDnsName string: The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
privateDnsNameOptions InstancePrivateDnsNameOptions: The options for the instance hostname.
privateIp string: The private IP address of the specified instance. For example: 10.24.34.0.
publicDnsName string: The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
publicIp string: The public IP address of the specified instance. For example: 192.0.2.0.
ramdiskId string: The ID of the RAM disk to select.
securityGroupIds string[]: The IDs of the security groups.
sourceDestCheck boolean: Specifies whether to enable an instance launched in a VPC to perform NAT.
ssmAssociations InstanceSsmAssociation[]: The SSM document and parameter values in AWS Systems Manager to associate with this instance.
state InstanceState: The current state of the instance.
tags Tag[]: The tags to add to the instance.
tenancy string: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
userData string: The user data to make available to the instance.
volumes InstanceVolume[]: The volumes to attach to the instance.
vpcId string: The ID of the VPC that the instance is running in.

affinity InstanceAffinity: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
block_device_mappings Sequence[InstanceBlockDeviceMapping]: The block device mapping entries that defines the block devices to attach to the instance at launch.
credit_specification CreditSpecificationProperties: The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
disable_api_termination bool: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
ebs_optimized bool: Indicates whether the instance is optimized for Amazon EBS I/O.
host_id str: If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
iam_instance_profile str: The IAM instance profile.
instance_id str: The EC2 Instance ID.
instance_initiated_shutdown_behavior str: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
instance_type str: The instance type.
kernel_id str: The ID of the kernel.
monitoring bool: Specifies whether detailed monitoring is enabled for the instance.
private_dns_name str: The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
private_dns_name_options InstancePrivateDnsNameOptions: The options for the instance hostname.
private_ip str: The private IP address of the specified instance. For example: 10.24.34.0.
public_dns_name str: The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
public_ip str: The public IP address of the specified instance. For example: 192.0.2.0.
ramdisk_id str: The ID of the RAM disk to select.
security_group_ids Sequence[str]: The IDs of the security groups.
source_dest_check bool: Specifies whether to enable an instance launched in a VPC to perform NAT.
ssm_associations Sequence[InstanceSsmAssociation]: The SSM document and parameter values in AWS Systems Manager to associate with this instance.
state InstanceState: The current state of the instance.
tags Sequence[root_Tag]: The tags to add to the instance.
tenancy str: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
user_data str: The user data to make available to the instance.
volumes Sequence[InstanceVolume]: The volumes to attach to the instance.
vpc_id str: The ID of the VPC that the instance is running in.

affinity "default" | "host": Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
blockDeviceMappings List<Property Map>: The block device mapping entries that defines the block devices to attach to the instance at launch.
creditSpecification Property Map: The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
disableApiTermination Boolean: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
ebsOptimized Boolean: Indicates whether the instance is optimized for Amazon EBS I/O.
hostId String: If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
iamInstanceProfile String: The IAM instance profile.
instanceId String: The EC2 Instance ID.
instanceInitiatedShutdownBehavior String: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
instanceType String: The instance type.
kernelId String: The ID of the kernel.
monitoring Boolean: Specifies whether detailed monitoring is enabled for the instance.
privateDnsName String: The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
privateDnsNameOptions Property Map: The options for the instance hostname.
privateIp String: The private IP address of the specified instance. For example: 10.24.34.0.
publicDnsName String: The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
publicIp String: The public IP address of the specified instance. For example: 192.0.2.0.
ramdiskId String: The ID of the RAM disk to select.
securityGroupIds List<String>: The IDs of the security groups.
sourceDestCheck Boolean: Specifies whether to enable an instance launched in a VPC to perform NAT.
ssmAssociations List<Property Map>: The SSM document and parameter values in AWS Systems Manager to associate with this instance.
state Property Map: The current state of the instance.
tags List<Property Map>: The tags to add to the instance.
tenancy String: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
userData String: The user data to make available to the instance.
volumes List<Property Map>: The volumes to attach to the instance.
vpcId String: The ID of the VPC that the instance is running in.

Supporting Types

CreditSpecificationProperties

CpuCredits string

The credit option for CPU usage of the instance.

Valid values: standard | unlimited

T3 instances with host tenancy do not support the unlimited CPU credit option.

CpuCredits string

The credit option for CPU usage of the instance.

Valid values: standard | unlimited

T3 instances with host tenancy do not support the unlimited CPU credit option.

cpuCredits String

The credit option for CPU usage of the instance.

Valid values: standard | unlimited

T3 instances with host tenancy do not support the unlimited CPU credit option.

cpuCredits string

The credit option for CPU usage of the instance.

Valid values: standard | unlimited

T3 instances with host tenancy do not support the unlimited CPU credit option.

cpu_credits str

The credit option for CPU usage of the instance.

Valid values: standard | unlimited

T3 instances with host tenancy do not support the unlimited CPU credit option.

cpuCredits String

The credit option for CPU usage of the instance.

Valid values: standard | unlimited

T3 instances with host tenancy do not support the unlimited CPU credit option.

InstanceAffinity

InstanceAssociationParameter

Key string: The name of an input parameter that is in the associated SSM document.
Value List<string>: The value of an input parameter.

Key string: The name of an input parameter that is in the associated SSM document.
Value []string: The value of an input parameter.

key String: The name of an input parameter that is in the associated SSM document.
value List<String>: The value of an input parameter.

key string: The name of an input parameter that is in the associated SSM document.
value string[]: The value of an input parameter.

key str: The name of an input parameter that is in the associated SSM document.
value Sequence[str]: The value of an input parameter.

key String: The name of an input parameter that is in the associated SSM document.
value List<String>: The value of an input parameter.

InstanceBlockDeviceMapping

DeviceName string

The device name (for example, /dev/sdh or xvdh).

Ebs Pulumi.AwsNative.Ec2.Inputs.InstanceEbs

Parameters used to automatically set up EBS volumes when the instance is launched.

NoDevice object

To omit the device from the block device mapping, specify an empty string.

VirtualName string

The virtual device name ( ephemeral N). The name must be in the form ephemeral X where X is a number starting from zero (0). For example, an instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

Constraints : For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

DeviceName string

The device name (for example, /dev/sdh or xvdh).

Ebs InstanceEbs

Parameters used to automatically set up EBS volumes when the instance is launched.

NoDevice interface{}

To omit the device from the block device mapping, specify an empty string.

VirtualName string

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

deviceName String

The device name (for example, /dev/sdh or xvdh).

ebs InstanceEbs

Parameters used to automatically set up EBS volumes when the instance is launched.

noDevice Object

To omit the device from the block device mapping, specify an empty string.

virtualName String

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

deviceName string

The device name (for example, /dev/sdh or xvdh).

ebs InstanceEbs

Parameters used to automatically set up EBS volumes when the instance is launched.

noDevice any

To omit the device from the block device mapping, specify an empty string.

virtualName string

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

device_name str

The device name (for example, /dev/sdh or xvdh).

ebs InstanceEbs

Parameters used to automatically set up EBS volumes when the instance is launched.

no_device Any

To omit the device from the block device mapping, specify an empty string.

virtual_name str

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

deviceName String

The device name (for example, /dev/sdh or xvdh).

ebs Property Map

Parameters used to automatically set up EBS volumes when the instance is launched.

noDevice Any

To omit the device from the block device mapping, specify an empty string.

virtualName String

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

InstanceEbs

DeleteOnTermination bool: Indicates whether the EBS volume is deleted on instance termination.
Encrypted bool: Indicates whether the volume should be encrypted.
Iops int: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
KmsKeyId string: The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used.
SnapshotId string: The ID of the snapshot.
VolumeSize int: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
VolumeType string: The volume type.

DeleteOnTermination bool: Indicates whether the EBS volume is deleted on instance termination.
Encrypted bool: Indicates whether the volume should be encrypted.
Iops int: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
KmsKeyId string: The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used.
SnapshotId string: The ID of the snapshot.
VolumeSize int: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
VolumeType string: The volume type.

deleteOnTermination Boolean: Indicates whether the EBS volume is deleted on instance termination.
encrypted Boolean: Indicates whether the volume should be encrypted.
iops Integer: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
kmsKeyId String: The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used.
snapshotId String: The ID of the snapshot.
volumeSize Integer: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
volumeType String: The volume type.

deleteOnTermination boolean: Indicates whether the EBS volume is deleted on instance termination.
encrypted boolean: Indicates whether the volume should be encrypted.
iops number: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
kmsKeyId string: The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used.
snapshotId string: The ID of the snapshot.
volumeSize number: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
volumeType string: The volume type.

delete_on_termination bool: Indicates whether the EBS volume is deleted on instance termination.
encrypted bool: Indicates whether the volume should be encrypted.
iops int: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
kms_key_id str: The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used.
snapshot_id str: The ID of the snapshot.
volume_size int: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
volume_type str: The volume type.

deleteOnTermination Boolean: Indicates whether the EBS volume is deleted on instance termination.
encrypted Boolean: Indicates whether the volume should be encrypted.
iops Number: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
kmsKeyId String: The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used.
snapshotId String: The ID of the snapshot.
volumeSize Number: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
volumeType String: The volume type.

InstancePrivateDnsNameOptions

EnableResourceNameDnsARecord bool: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
EnableResourceNameDnsAaaaRecord bool: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
HostnameType Pulumi.AwsNative.Ec2.InstancePrivateDnsNameOptionsHostnameType: The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.

EnableResourceNameDnsARecord bool: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
EnableResourceNameDnsAaaaRecord bool: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
HostnameType InstancePrivateDnsNameOptionsHostnameType: The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.

enableResourceNameDnsARecord Boolean: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
enableResourceNameDnsAaaaRecord Boolean: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
hostnameType InstancePrivateDnsNameOptionsHostnameType: The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.

enableResourceNameDnsARecord boolean: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
enableResourceNameDnsAaaaRecord boolean: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
hostnameType InstancePrivateDnsNameOptionsHostnameType: The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.

enable_resource_name_dns_a_record bool: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
enable_resource_name_dns_aaaa_record bool: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
hostname_type InstancePrivateDnsNameOptionsHostnameType: The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.

enableResourceNameDnsARecord Boolean: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
enableResourceNameDnsAaaaRecord Boolean: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.
hostnameType "ip-name" | "resource-name": The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.

InstancePrivateDnsNameOptionsHostnameType

InstanceSsmAssociation

DocumentName string: The name of an SSM document to associate with the instance.
AssociationParameters List<Pulumi.AwsNative.Ec2.Inputs.InstanceAssociationParameter>: The input parameter values to use with the associated SSM document.

DocumentName string: The name of an SSM document to associate with the instance.
AssociationParameters []InstanceAssociationParameter: The input parameter values to use with the associated SSM document.

documentName String: The name of an SSM document to associate with the instance.
associationParameters List<InstanceAssociationParameter>: The input parameter values to use with the associated SSM document.

documentName string: The name of an SSM document to associate with the instance.
associationParameters InstanceAssociationParameter[]: The input parameter values to use with the associated SSM document.

document_name str: The name of an SSM document to associate with the instance.
association_parameters Sequence[InstanceAssociationParameter]: The input parameter values to use with the associated SSM document.

documentName String: The name of an SSM document to associate with the instance.
associationParameters List<Property Map>: The input parameter values to use with the associated SSM document.

InstanceState

Code string: The state of the instance as a 16-bit unsigned integer.
Name string: The current state of the instance.

Code string: The state of the instance as a 16-bit unsigned integer.
Name string: The current state of the instance.

code String: The state of the instance as a 16-bit unsigned integer.
name String: The current state of the instance.

code string: The state of the instance as a 16-bit unsigned integer.
name string: The current state of the instance.

code str: The state of the instance as a 16-bit unsigned integer.
name str: The current state of the instance.

code String: The state of the instance as a 16-bit unsigned integer.
name String: The current state of the instance.

InstanceVolume

Device string: The device name (for example, /dev/sdh or xvdh).
VolumeId string: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

Device string: The device name (for example, /dev/sdh or xvdh).
VolumeId string: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

device String: The device name (for example, /dev/sdh or xvdh).
volumeId String: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

device string: The device name (for example, /dev/sdh or xvdh).
volumeId string: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

device str: The device name (for example, /dev/sdh or xvdh).
volume_id str: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

device String: The device name (for example, /dev/sdh or xvdh).
volumeId String: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.ec2.getInstance

On this page

On this page

Using getInstance

getInstance Result

Supporting Types

CreditSpecificationProperties

InstanceAffinity

InstanceAssociationParameter

InstanceBlockDeviceMapping

InstanceEbs

InstancePrivateDnsNameOptions

InstancePrivateDnsNameOptionsHostnameType

InstanceSsmAssociation

InstanceState

InstanceVolume

Tag

Package Details

On this page

On this page