GetInstanceResult class

Result data returned by getInstance.

Constructors

GetInstanceResult({required String ami, required String arn, required bool associatePublicIpAddress, required String availabilityZone, required List<GetInstanceCreditSpecification> creditSpecifications, required bool disableApiStop, required bool disableApiTermination, required List<GetInstanceEbsBlockDevice> ebsBlockDevices, required bool ebsOptimized, required List<GetInstanceEnclaveOption> enclaveOptions, required List<GetInstanceEphemeralBlockDevice> ephemeralBlockDevices, List<GetInstanceFilter>? filters, bool? getPasswordData, bool? getUserData, required String hostId, required String hostResourceGroupArn, required String iamInstanceProfile, required String id, String? instanceId, required String instanceState, required Map<String, String> instanceTags, required String instanceType, required List<String> ipv6Addresses, required String keyName, required String launchTime, required List<GetInstanceMaintenanceOption> maintenanceOptions, required List<GetInstanceMetadataOption> metadataOptions, required bool monitoring, required String networkInterfaceId, required String outpostArn, required String passwordData, required String placementGroup, required String placementGroupId, required int placementPartitionNumber, required String privateDns, required List<GetInstancePrivateDnsNameOption> privateDnsNameOptions, required String privateIp, required String publicDns, required String publicIp, required String region, required List<GetInstanceRootBlockDevice> rootBlockDevices, required List<String> secondaryPrivateIps, required List<String> securityGroups, required bool sourceDestCheck, required String subnetId, required Map<String, String> tags, required String tenancy, required String userData, required String userDataBase64, required List<String> vpcSecurityGroupIds})
Creates a new GetInstanceResult. ami ID of the AMI used to launch the instance. arn ARN of the instance. associatePublicIpAddress Whether or not the Instance is associated with a public IP address or not (Boolean). availabilityZone Availability zone of the Instance. creditSpecifications Credit specification of the Instance. disableApiStop Whether or not EC2 Instance Stop Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) is enabled (Boolean). disableApiTermination Whether or not EC2 Instance Termination Protection is enabled (Boolean). ebsBlockDevices EBS block device mappings of the Instance. ebsOptimized Whether the Instance is EBS optimized or not (Boolean). enclaveOptions Enclave options of the instance. ephemeralBlockDevices Ephemeral block device mappings of the Instance. filters Optional. getPasswordData Optional. getUserData Optional. hostId ID of the dedicated host the instance will be assigned to. hostResourceGroupArn ARN of the host resource group the instance is associated with. iamInstanceProfile Name of the instance profile associated with the Instance. id The provider-assigned unique ID for this managed resource. instanceId Optional. instanceState State of the instance. One of: pending, running, shutting-down, terminated, stopping, stopped. See Instance Lifecycle for more information. instanceTags Required. instanceType Type of the Instance. ipv6Addresses IPv6 addresses associated to the Instance, if applicable. NOTE: Unlike the IPv4 address, this doesn't change if you attach an EIP to the instance. keyName Key name of the Instance. launchTime Time the instance was launched. maintenanceOptions Maintenance and recovery options for the instance. metadataOptions Metadata options of the Instance. monitoring Whether detailed monitoring is enabled or disabled for the Instance (Boolean). networkInterfaceId ID of the network interface that was created with the Instance. outpostArn ARN of the Outpost. passwordData Base-64 encoded encrypted password data for the instance. Useful for getting the administrator password for instances running Microsoft Windows. This attribute is only exported if getPasswordData is true. See GetPasswordData for more information. placementGroup Placement group of the Instance. placementGroupId Placement group ID of the Instance. placementPartitionNumber Number of the partition the instance is in. privateDns Private DNS name assigned to the Instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC. privateDnsNameOptions Options for the instance hostname. privateIp Private IP address assigned to the Instance. publicDns Public DNS name assigned to the Instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC. publicIp Public IP address assigned to the Instance, if applicable. NOTE: If you are using an aws.ec2.Eip with your instance, you should refer to the EIP's address directly and not use publicIp, as this field will change after the EIP is attached. region Required. rootBlockDevices Root block device mappings of the Instance secondaryPrivateIps Secondary private IPv4 addresses assigned to the instance's primary network interface (eth0) in a VPC. securityGroups Associated security groups. sourceDestCheck Whether the network interface performs source/destination checking (Boolean). subnetId VPC subnet ID. tags Map of tags assigned to the Instance. tenancy Tenancy of the instance: dedicated, default, host. userData SHA-1 hash of User Data supplied to the Instance. userDataBase64 Base64 encoded contents of User Data supplied to the Instance. This attribute is only exported if getUserData is true. vpcSecurityGroupIds Associated security groups in a non-default VPC.
const
GetInstanceResult.fromMap(Map<String, dynamic> map)
factory

Properties

ami → String
ID of the AMI used to launch the instance.
final
arn → String
ARN of the instance.
final
associatePublicIpAddress → bool
Whether or not the Instance is associated with a public IP address or not (Boolean).
final
availabilityZone → String
Availability zone of the Instance.
final
creditSpecifications → List<GetInstanceCreditSpecification>
Credit specification of the Instance.
final
disableApiStop → bool
Whether or not EC2 Instance Stop Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) is enabled (Boolean).
final
disableApiTermination → bool
Whether or not EC2 Instance Termination Protection is enabled (Boolean).
final
ebsBlockDevices → List<GetInstanceEbsBlockDevice>
EBS block device mappings of the Instance.
final
ebsOptimized → bool
Whether the Instance is EBS optimized or not (Boolean).
final
enclaveOptions → List<GetInstanceEnclaveOption>
Enclave options of the instance.
final
ephemeralBlockDevices → List<GetInstanceEphemeralBlockDevice>
Ephemeral block device mappings of the Instance.
final
filters → List<GetInstanceFilter>?
final
getPasswordData → bool?
final
getUserData → bool?
final
hashCode → int
The hash code for this object.
no setterinherited
hostId → String
ID of the dedicated host the instance will be assigned to.
final
hostResourceGroupArn → String
ARN of the host resource group the instance is associated with.
final
iamInstanceProfile → String
Name of the instance profile associated with the Instance.
final
id → String
The provider-assigned unique ID for this managed resource.
final
instanceId → String?
final
instanceState → String
State of the instance. One of: pending, running, shutting-down, terminated, stopping, stopped. See Instance Lifecycle for more information.
final
instanceTags → Map<String, String>
final
instanceType → String
Type of the Instance.
final
ipv6Addresses → List<String>
IPv6 addresses associated to the Instance, if applicable. NOTE: Unlike the IPv4 address, this doesn't change if you attach an EIP to the instance.
final
keyName → String
Key name of the Instance.
final
launchTime → String
Time the instance was launched.
final
maintenanceOptions → List<GetInstanceMaintenanceOption>
Maintenance and recovery options for the instance.
final
metadataOptions → List<GetInstanceMetadataOption>
Metadata options of the Instance.
final
monitoring → bool
Whether detailed monitoring is enabled or disabled for the Instance (Boolean).
final
networkInterfaceId → String
ID of the network interface that was created with the Instance.
final
outpostArn → String
ARN of the Outpost.
final
passwordData → String
Base-64 encoded encrypted password data for the instance. Useful for getting the administrator password for instances running Microsoft Windows. This attribute is only exported if getPasswordData is true. See GetPasswordData for more information.
final
placementGroup → String
Placement group of the Instance.
final
placementGroupId → String
Placement group ID of the Instance.
final
placementPartitionNumber → int
Number of the partition the instance is in.
final
privateDns → String
Private DNS name assigned to the Instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
final
privateDnsNameOptions → List<GetInstancePrivateDnsNameOption>
Options for the instance hostname.
final
privateIp → String
Private IP address assigned to the Instance.
final
publicDns → String
Public DNS name assigned to the Instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
final
publicIp → String
Public IP address assigned to the Instance, if applicable. NOTE: If you are using an aws.ec2.Eip with your instance, you should refer to the EIP's address directly and not use publicIp, as this field will change after the EIP is attached.
final
region → String
final
rootBlockDevices → List<GetInstanceRootBlockDevice>
Root block device mappings of the Instance
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondaryPrivateIps → List<String>
Secondary private IPv4 addresses assigned to the instance's primary network interface (eth0) in a VPC.
final
securityGroups → List<String>
Associated security groups.
final
sourceDestCheck → bool
Whether the network interface performs source/destination checking (Boolean).
final
subnetId → String
VPC subnet ID.
final
tags → Map<String, String>
Map of tags assigned to the Instance.
final
tenancy → String
Tenancy of the instance: dedicated, default, host.
final
userData → String
SHA-1 hash of User Data supplied to the Instance.
final
userDataBase64 → String
Base64 encoded contents of User Data supplied to the Instance. This attribute is only exported if getUserData is true.
final
vpcSecurityGroupIds → List<String>
Associated security groups in a non-default VPC.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited