GetInstanceResult

data class GetInstanceResult(val affinity: InstanceAffinity? = null, val blockDeviceMappings: List<InstanceBlockDeviceMapping>? = null, val creditSpecification: CreditSpecificationProperties? = null, val disableApiTermination: Boolean? = null, val ebsOptimized: Boolean? = null, val hostId: String? = null, val iamInstanceProfile: String? = null, val instanceId: String? = null, val instanceInitiatedShutdownBehavior: String? = null, val instanceType: String? = null, val kernelId: String? = null, val monitoring: Boolean? = null, val privateDnsName: String? = null, val privateDnsNameOptions: InstancePrivateDnsNameOptions? = null, val privateIp: String? = null, val publicDnsName: String? = null, val publicIp: String? = null, val ramdiskId: String? = null, val securityGroupIds: List<String>? = null, val sourceDestCheck: Boolean? = null, val ssmAssociations: List<InstanceSsmAssociation>? = null, val state: InstanceState? = null, val tags: List<Tag>? = null, val tenancy: String? = null, val userData: String? = null, val volumes: List<InstanceVolume>? = null, val vpcId: String? = null)

Constructors

Link copied to clipboard
constructor(affinity: InstanceAffinity? = null, blockDeviceMappings: List<InstanceBlockDeviceMapping>? = null, creditSpecification: CreditSpecificationProperties? = null, disableApiTermination: Boolean? = null, ebsOptimized: Boolean? = null, hostId: String? = null, iamInstanceProfile: String? = null, instanceId: String? = null, instanceInitiatedShutdownBehavior: String? = null, instanceType: String? = null, kernelId: String? = null, monitoring: Boolean? = null, privateDnsName: String? = null, privateDnsNameOptions: InstancePrivateDnsNameOptions? = null, privateIp: String? = null, publicDnsName: String? = null, publicIp: String? = null, ramdiskId: String? = null, securityGroupIds: List<String>? = null, sourceDestCheck: Boolean? = null, ssmAssociations: List<InstanceSsmAssociation>? = null, state: InstanceState? = null, tags: List<Tag>? = null, tenancy: String? = null, userData: String? = null, volumes: List<InstanceVolume>? = null, vpcId: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

The block device mapping entries that defines the block devices to attach to the instance at launch.

Link copied to clipboard

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.

Link copied to clipboard

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.

Link copied to clipboard
val ebsOptimized: Boolean? = null

Indicates whether the instance is optimized for Amazon EBS I/O.

Link copied to clipboard
val hostId: String? = null

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.

Link copied to clipboard

The IAM instance profile.

Link copied to clipboard
val instanceId: String? = null

The EC2 Instance ID.

Link copied to clipboard

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Link copied to clipboard
val instanceType: String? = null

The instance type.

Link copied to clipboard
val kernelId: String? = null

The ID of the kernel.

Link copied to clipboard
val monitoring: Boolean? = null

Specifies whether detailed monitoring is enabled for the instance.

Link copied to clipboard
val privateDnsName: String? = null

The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.

Link copied to clipboard

The options for the instance hostname.

Link copied to clipboard
val privateIp: String? = null

The private IP address of the specified instance. For example: 10.24.34.0.

Link copied to clipboard
val publicDnsName: String? = null

The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.

Link copied to clipboard
val publicIp: String? = null

The public IP address of the specified instance. For example: 192.0.2.0.

Link copied to clipboard
val ramdiskId: String? = null

The ID of the RAM disk to select.

Link copied to clipboard

The IDs of the security groups.

Link copied to clipboard

Specifies whether to enable an instance launched in a VPC to perform NAT.

Link copied to clipboard

The SSM document and parameter values in AWS Systems Manager to associate with this instance.

Link copied to clipboard
val state: InstanceState? = null

The current state of the instance.

Link copied to clipboard
val tags: List<Tag>? = null

The tags to add to the instance.

Link copied to clipboard
val tenancy: String? = null

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.

Link copied to clipboard
val userData: String? = null

The user data to make available to the instance.

Link copied to clipboard

The volumes to attach to the instance.

Link copied to clipboard
val vpcId: String? = null

The ID of the VPC that the instance is running in.