Class GetInstanceResult


  • public final class GetInstanceResult
    extends java.lang.Object
    • Method Detail

      • ami

        public java.lang.String ami()
        Returns:
        ID of the AMI used to launch the instance.
      • arn

        public java.lang.String arn()
        Returns:
        ARN of the instance.
      • associatePublicIpAddress

        public java.lang.Boolean associatePublicIpAddress()
        Returns:
        Whether or not the Instance is associated with a public IP address or not (Boolean).
      • availabilityZone

        public java.lang.String availabilityZone()
        Returns:
        Availability zone of the Instance.
      • disableApiStop

        public java.lang.Boolean disableApiStop()
        Returns:
        Whether or not EC2 Instance Stop Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) is enabled (Boolean).
      • disableApiTermination

        public java.lang.Boolean disableApiTermination()
        Returns:
        Whether or not [EC2 Instance Termination Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingDisableAPITermination) is enabled (Boolean).
      • ebsBlockDevices

        public java.util.List<GetInstanceEbsBlockDevice> ebsBlockDevices()
        Returns:
        EBS block device mappings of the Instance.
      • ebsOptimized

        public java.lang.Boolean ebsOptimized()
        Returns:
        Whether the Instance is EBS optimized or not (Boolean).
      • enclaveOptions

        public java.util.List<GetInstanceEnclaveOption> enclaveOptions()
        Returns:
        Enclave options of the instance.
      • ephemeralBlockDevices

        public java.util.List<GetInstanceEphemeralBlockDevice> ephemeralBlockDevices()
        Returns:
        Ephemeral block device mappings of the Instance.
      • getPasswordData

        public java.util.Optional<java.lang.Boolean> getPasswordData()
      • getUserData

        public java.util.Optional<java.lang.Boolean> getUserData()
      • hostId

        public java.lang.String hostId()
        Returns:
        ID of the dedicated host the instance will be assigned to.
      • hostResourceGroupArn

        public java.lang.String hostResourceGroupArn()
        Returns:
        ARN of the host resource group the instance is associated with.
      • iamInstanceProfile

        public java.lang.String iamInstanceProfile()
        Returns:
        Name of the instance profile associated with the Instance.
      • id

        public java.lang.String id()
        Returns:
        The provider-assigned unique ID for this managed resource.
      • instanceId

        public java.util.Optional<java.lang.String> instanceId()
      • instanceState

        public java.lang.String instanceState()
        Returns:
        State of the instance. One of: `pending`, `running`, `shutting-down`, `terminated`, `stopping`, `stopped`. See [Instance Lifecycle](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) for more information.
      • instanceTags

        public java.util.Map<java.lang.String,​java.lang.String> instanceTags()
      • instanceType

        public java.lang.String instanceType()
        Returns:
        Type of the Instance.
      • ipv6Addresses

        public java.util.List<java.lang.String> ipv6Addresses()
        Returns:
        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

        public java.lang.String keyName()
        Returns:
        Key name of the Instance.
      • launchTime

        public java.lang.String launchTime()
        Returns:
        Time the instance was launched.
      • maintenanceOptions

        public java.util.List<GetInstanceMaintenanceOption> maintenanceOptions()
        Returns:
        Maintenance and recovery options for the instance.
      • metadataOptions

        public java.util.List<GetInstanceMetadataOption> metadataOptions()
        Returns:
        Metadata options of the Instance.
      • monitoring

        public java.lang.Boolean monitoring()
        Returns:
        Whether detailed monitoring is enabled or disabled for the Instance (Boolean).
      • networkInterfaceId

        public java.lang.String networkInterfaceId()
        Returns:
        ID of the network interface that was created with the Instance.
      • outpostArn

        public java.lang.String outpostArn()
        Returns:
        ARN of the Outpost.
      • passwordData

        public java.lang.String passwordData()
        Returns:
        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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetPasswordData.html) for more information.
      • placementGroup

        public java.lang.String placementGroup()
        Returns:
        Placement group of the Instance.
      • placementGroupId

        public java.lang.String placementGroupId()
        Returns:
        Placement group ID of the Instance.
      • placementPartitionNumber

        public java.lang.Integer placementPartitionNumber()
        Returns:
        Number of the partition the instance is in.
      • privateDns

        public java.lang.String privateDns()
        Returns:
        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.
      • privateIp

        public java.lang.String privateIp()
        Returns:
        Private IP address assigned to the Instance.
      • publicDns

        public java.lang.String publicDns()
        Returns:
        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 java.lang.String publicIp()
        Returns:
        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

        public java.lang.String region()
      • rootBlockDevices

        public java.util.List<GetInstanceRootBlockDevice> rootBlockDevices()
        Returns:
        Root block device mappings of the Instance
      • secondaryPrivateIps

        public java.util.List<java.lang.String> secondaryPrivateIps()
        Returns:
        Secondary private IPv4 addresses assigned to the instance's primary network interface (eth0) in a VPC.
      • securityGroups

        public java.util.List<java.lang.String> securityGroups()
        Returns:
        Associated security groups.
      • sourceDestCheck

        public java.lang.Boolean sourceDestCheck()
        Returns:
        Whether the network interface performs source/destination checking (Boolean).
      • subnetId

        public java.lang.String subnetId()
        Returns:
        VPC subnet ID.
      • tags

        public java.util.Map<java.lang.String,​java.lang.String> tags()
        Returns:
        Map of tags assigned to the Instance.
      • tenancy

        public java.lang.String tenancy()
        Returns:
        Tenancy of the instance: `dedicated`, `default`, `host`.
      • userData

        public java.lang.String userData()
        Returns:
        SHA-1 hash of User Data supplied to the Instance.
      • userDataBase64

        public java.lang.String userDataBase64()
        Returns:
        Base64 encoded contents of User Data supplied to the Instance. This attribute is only exported if `getUserData` is true.
      • vpcSecurityGroupIds

        public java.util.List<java.lang.String> vpcSecurityGroupIds()
        Returns:
        Associated security groups in a non-default VPC.