GetInstanceResult class
Result data returned by getInstance.
Constructors
-
GetInstanceResult({String? ami, String? arn, bool? associatePublicIpAddress, String? availabilityZone, List<
GetInstanceCreditSpecification> ? creditSpecifications, bool? disableApiStop, bool? disableApiTermination, List<GetInstanceEbsBlockDevice> ? ebsBlockDevices, bool? ebsOptimized, List<GetInstanceEnclaveOption> ? enclaveOptions, List<GetInstanceEphemeralBlockDevice> ? ephemeralBlockDevices, List<GetInstanceFilter> ? filters, bool? getPasswordData, bool? getUserData, String? hostId, String? hostResourceGroupArn, String? iamInstanceProfile, String? id, String? instanceId, String? instanceState, Map<String, String> ? instanceTags, String? instanceType, List<String> ? ipv6Addresses, String? keyName, String? launchTime, List<GetInstanceMaintenanceOption> ? maintenanceOptions, List<GetInstanceMetadataOption> ? metadataOptions, bool? monitoring, String? networkInterfaceId, String? outpostArn, String? passwordData, String? placementGroup, String? placementGroupId, int? placementPartitionNumber, String? privateDns, List<GetInstancePrivateDnsNameOption> ? privateDnsNameOptions, String? privateIp, String? publicDns, String? publicIp, String? region, List<GetInstanceRootBlockDevice> ? rootBlockDevices, List<String> ? secondaryPrivateIps, List<String> ? securityGroups, bool? sourceDestCheck, String? subnetId, Map<String, String> ? tags, String? tenancy, String? userData, String? userDataBase64, List<String> ? vpcSecurityGroupIds}) -
Creates a new GetInstanceResult.
amiID of the AMI used to launch the instance.arnARN of the instance.associatePublicIpAddressWhether or not the Instance is associated with a public IP address or not (Boolean).availabilityZoneAvailability zone of the Instance.creditSpecificationsCredit specification of the Instance.disableApiStopWhether or not EC2 Instance Stop Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) is enabled (Boolean).disableApiTerminationWhether or not EC2 Instance Termination Protection is enabled (Boolean).ebsBlockDevicesEBS block device mappings of the Instance.ebsOptimizedWhether the Instance is EBS optimized or not (Boolean).enclaveOptionsEnclave options of the instance.ephemeralBlockDevicesEphemeral block device mappings of the Instance.filtersOptional.getPasswordDataOptional.getUserDataOptional.hostIdID of the dedicated host the instance will be assigned to.hostResourceGroupArnARN of the host resource group the instance is associated with.iamInstanceProfileName of the instance profile associated with the Instance.idThe provider-assigned unique ID for this managed resource.instanceIdOptional.instanceStateState of the instance. One of:pending,running,shutting-down,terminated,stopping,stopped. See Instance Lifecycle for more information.instanceTagsOptional.instanceTypeType of the Instance.ipv6AddressesIPv6 addresses associated to the Instance, if applicable. NOTE: Unlike the IPv4 address, this doesn't change if you attach an EIP to the instance.keyNameKey name of the Instance.launchTimeTime the instance was launched.maintenanceOptionsMaintenance and recovery options for the instance.metadataOptionsMetadata options of the Instance.monitoringWhether detailed monitoring is enabled or disabled for the Instance (Boolean).networkInterfaceIdID of the network interface that was created with the Instance.outpostArnARN of the Outpost.passwordDataBase-64 encoded encrypted password data for the instance. Useful for getting the administrator password for instances running Microsoft Windows. This attribute is only exported ifgetPasswordDatais true. See GetPasswordData for more information.placementGroupPlacement group of the Instance.placementGroupIdPlacement group ID of the Instance.placementPartitionNumberNumber of the partition the instance is in.privateDnsPrivate 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.privateDnsNameOptionsOptions for the instance hostname.privateIpPrivate IP address assigned to the Instance.publicDnsPublic DNS name assigned to the Instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.publicIpPublic IP address assigned to the Instance, if applicable. NOTE: If you are using anaws.ec2.Eipwith your instance, you should refer to the EIP's address directly and not usepublicIp, as this field will change after the EIP is attached.regionOptional.rootBlockDevicesRoot block device mappings of the InstancesecondaryPrivateIpsSecondary private IPv4 addresses assigned to the instance's primary network interface (eth0) in a VPC.securityGroupsAssociated security groups.sourceDestCheckWhether the network interface performs source/destination checking (Boolean).subnetIdVPC subnet ID.tagsMap of tags assigned to the Instance.tenancyTenancy of the instance:dedicated,default,host.userDataSHA-1 hash of User Data supplied to the Instance.userDataBase64Base64 encoded contents of User Data supplied to the Instance. This attribute is only exported ifgetUserDatais true.vpcSecurityGroupIdsAssociated 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
getPasswordDatais 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.Eipwith your instance, you should refer to the EIP's address directly and not usepublicIp, 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
-
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
getUserDatais 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