Instance (AWS SDK for Java - 2.0.0-preview-1)

java.lang.Object
- software.amazon.awssdk.services.opsworks.model.Instance

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<Instance.Builder,Instance>

@Generated("software.amazon.awssdk:codegen")
public class Instance
extends Object
implements StructuredPojo, ToCopyableBuilder<Instance.Builder,Instance>

Describes an instance.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Instance.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`Instance.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`agentVersion()`	The agent version.
`String`	`amiId()`	A custom AMI ID to be used to create the instance.
`String`	`architecture()`	The instance architecture: "i386" or "x86_64".
`String`	`arn()`
`String`	`autoScalingType()`	For load-based or time-based instances, the type.
`String`	`availabilityZone()`	The instance Availability Zone.
`List<BlockDeviceMapping>`	`blockDeviceMappings()`	An array of `BlockDeviceMapping` objects that specify the instance's block device mappings.
`static Instance.Builder`	`builder()`
`String`	`createdAt()`	The time that the instance was created.
`Boolean`	`ebsOptimized()`	Whether this is an Amazon EBS-optimized instance.
`String`	`ec2InstanceId()`	The ID of the associated Amazon EC2 instance.
`String`	`ecsClusterArn()`	For container instances, the Amazon ECS cluster's ARN.
`String`	`ecsContainerInstanceArn()`	For container instances, the instance's ARN.
`String`	`elasticIp()`	The instance Elastic IP address .
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`hostname()`	The instance host name.
`String`	`infrastructureClass()`	For registered instances, the infrastructure class: `ec2` or `on-premises`.
`Boolean`	`installUpdatesOnBoot()`	Whether to install operating system and package updates when the instance boots.
`String`	`instanceId()`	The instance ID.
`String`	`instanceProfileArn()`	The ARN of the instance's IAM profile.
`String`	`instanceType()`	The instance type, such as `t2.micro`.
`String`	`lastServiceErrorId()`	The ID of the last service error.
`List<String>`	`layerIds()`	An array containing the instance layer IDs.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`os()`	The instance's operating system.
`String`	`platform()`	The instance's platform.
`String`	`privateDns()`	The instance's private DNS name.
`String`	`privateIp()`	The instance's private IP address.
`String`	`publicDns()`	The instance public DNS name.
`String`	`publicIp()`	The instance public IP address.
`String`	`registeredBy()`	For registered instances, who performed the registration.
`String`	`reportedAgentVersion()`	The instance's reported AWS OpsWorks Stacks agent version.
`ReportedOs`	`reportedOs()`	For registered instances, the reported operating system.
`String`	`rootDeviceType()`	The instance's root device type.
`String`	`rootDeviceVolumeId()`	The root device volume ID.
`List<String>`	`securityGroupIds()`	An array containing the instance security group IDs.
`static Class<? extends Instance.Builder>`	`serializableBuilderClass()`
`String`	`sshHostDsaKeyFingerprint()`	The SSH key's Deep Security Agent (DSA) fingerprint.
`String`	`sshHostRsaKeyFingerprint()`	The SSH key's RSA fingerprint.
`String`	`sshKeyName()`	The instance's Amazon EC2 key-pair name.
`String`	`stackId()`	The stack ID.
`String`	`status()`	The instance status:
`String`	`subnetId()`	The instance's subnet ID; applicable only if the stack is running in a VPC.
`String`	`tenancy()`	The instance's tenancy option, such as `dedicated` or `host`.
`Instance.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`virtualizationType()`	The instance's virtualization type: `paravirtual` or `hvm`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - agentVersion
```
public String agentVersion()
```
    The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version.
    
    Returns:
    
    The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version.
  - amiId
```
public String amiId()
```
    A custom AMI ID to be used to create the instance. For more information, see Instances
    
    Returns:
    
    A custom AMI ID to be used to create the instance. For more information, see Instances
  - architecture
```
public String architecture()
```
    The instance architecture: "i386" or "x86_64".
    
    Returns:
    
    The instance architecture: "i386" or "x86_64".
    
    See Also:
    
    Architecture
  - arn
```
public String arn()
```
    Returns:
  - autoScalingType
```
public String autoScalingType()
```
    For load-based or time-based instances, the type.
    
    Returns:
    
    For load-based or time-based instances, the type.
    
    See Also:
    
    AutoScalingType
  - availabilityZone
```
public String availabilityZone()
```
    The instance Availability Zone. For more information, see Regions and Endpoints.
    
    Returns:
    
    The instance Availability Zone. For more information, see Regions and Endpoints.
  - blockDeviceMappings
```
public List<BlockDeviceMapping> blockDeviceMappings()
```
    An array of BlockDeviceMapping objects that specify the instance's block device mappings.
    
    Returns:
    
    An array of BlockDeviceMapping objects that specify the instance's block device mappings.
  - createdAt
```
public String createdAt()
```
    The time that the instance was created.
    
    Returns:
    
    The time that the instance was created.
  - ebsOptimized
```
public Boolean ebsOptimized()
```
    Whether this is an Amazon EBS-optimized instance.
    
    Returns:
    
    Whether this is an Amazon EBS-optimized instance.
  - ec2InstanceId
```
public String ec2InstanceId()
```
    The ID of the associated Amazon EC2 instance.
    
    Returns:
    
    The ID of the associated Amazon EC2 instance.
  - ecsClusterArn
```
public String ecsClusterArn()
```
    For container instances, the Amazon ECS cluster's ARN.
    
    Returns:
    
    For container instances, the Amazon ECS cluster's ARN.
  - ecsContainerInstanceArn
```
public String ecsContainerInstanceArn()
```
    For container instances, the instance's ARN.
    
    Returns:
    
    For container instances, the instance's ARN.
  - elasticIp
```
public String elasticIp()
```
    The instance Elastic IP address .
    
    Returns:
    
    The instance Elastic IP address .
  - hostname
```
public String hostname()
```
    The instance host name.
    
    Returns:
    
    The instance host name.
  - infrastructureClass
```
public String infrastructureClass()
```
    For registered instances, the infrastructure class: ec2 or on-premises.
    
    Returns:
    
    For registered instances, the infrastructure class: ec2 or on-premises.
  - installUpdatesOnBoot
```
public Boolean installUpdatesOnBoot()
```
    Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
    
    We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
    
    Returns:
    
    Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
    
    We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
  - instanceId
```
public String instanceId()
```
    The instance ID.
    
    Returns:
    
    The instance ID.
  - instanceProfileArn
```
public String instanceProfileArn()
```
    The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
    
    Returns:
    
    The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
  - instanceType
```
public String instanceType()
```
    The instance type, such as t2.micro.
    
    Returns:
    
    The instance type, such as t2.micro.
  - lastServiceErrorId
```
public String lastServiceErrorId()
```
    The ID of the last service error. For more information, call DescribeServiceErrors.
    
    Returns:
    
    The ID of the last service error. For more information, call DescribeServiceErrors.
  - layerIds
```
public List<String> layerIds()
```
    An array containing the instance layer IDs.
    
    Returns:
    
    An array containing the instance layer IDs.
  - os
```
public String os()
```
    The instance's operating system.
    
    Returns:
    
    The instance's operating system.
  - platform
```
public String platform()
```
    The instance's platform.
    
    Returns:
    
    The instance's platform.
  - privateDns
```
public String privateDns()
```
    The instance's private DNS name.
    
    Returns:
    
    The instance's private DNS name.
  - privateIp
```
public String privateIp()
```
    The instance's private IP address.
    
    Returns:
    
    The instance's private IP address.
  - publicDns
```
public String publicDns()
```
    The instance public DNS name.
    
    Returns:
    
    The instance public DNS name.
  - publicIp
```
public String publicIp()
```
    The instance public IP address.
    
    Returns:
    
    The instance public IP address.
  - registeredBy
```
public String registeredBy()
```
    For registered instances, who performed the registration.
    
    Returns:
    
    For registered instances, who performed the registration.
  - reportedAgentVersion
```
public String reportedAgentVersion()
```
    The instance's reported AWS OpsWorks Stacks agent version.
    
    Returns:
    
    The instance's reported AWS OpsWorks Stacks agent version.
  - reportedOs
```
public ReportedOs reportedOs()
```
    For registered instances, the reported operating system.
    
    Returns:
    
    For registered instances, the reported operating system.
  - rootDeviceType
```
public String rootDeviceType()
```
    The instance's root device type. For more information, see Storage for the Root Device.
    
    Returns:
    
    The instance's root device type. For more information, see Storage for the Root Device.
    
    See Also:
    
    RootDeviceType
  - rootDeviceVolumeId
```
public String rootDeviceVolumeId()
```
    The root device volume ID.
    
    Returns:
    
    The root device volume ID.
  - securityGroupIds
```
public List<String> securityGroupIds()
```
    An array containing the instance security group IDs.
    
    Returns:
    
    An array containing the instance security group IDs.
  - sshHostDsaKeyFingerprint
```
public String sshHostDsaKeyFingerprint()
```
    The SSH key's Deep Security Agent (DSA) fingerprint.
    
    Returns:
    
    The SSH key's Deep Security Agent (DSA) fingerprint.
  - sshHostRsaKeyFingerprint
```
public String sshHostRsaKeyFingerprint()
```
    The SSH key's RSA fingerprint.
    
    Returns:
    
    The SSH key's RSA fingerprint.
  - sshKeyName
```
public String sshKeyName()
```
    The instance's Amazon EC2 key-pair name.
    
    Returns:
    
    The instance's Amazon EC2 key-pair name.
  - stackId
```
public String stackId()
```
    The stack ID.
    
    Returns:
    
    The stack ID.
  - status
```
public String status()
```
    The instance status:
    - booting
    - connection_lost
    - online
    - pending
    - rebooting
    - requested
    - running_setup
    - setup_failed
    - shutting_down
    - start_failed
    - stop_failed
    - stopped
    - stopping
    - terminated
    - terminating
    Returns:
    The instance status:
    
    booting
    
    connection_lost
    
    online
    
    pending
    
    rebooting
    
    requested
    
    running_setup
    
    setup_failed
    
    shutting_down
    
    start_failed
    
    stop_failed
    
    stopped
    
    stopping
    
    terminated
    
    terminating
  - subnetId
```
public String subnetId()
```
    The instance's subnet ID; applicable only if the stack is running in a VPC.
    
    Returns:
    
    The instance's subnet ID; applicable only if the stack is running in a VPC.
  - tenancy
```
public String tenancy()
```
    The instance's tenancy option, such as dedicated or host.
    
    Returns:
    
    The instance's tenancy option, such as dedicated or host.
  - virtualizationType
```
public String virtualizationType()
```
    The instance's virtualization type: paravirtual or hvm.
    
    Returns:
    
    The instance's virtualization type: paravirtual or hvm.
    
    See Also:
    
    VirtualizationType
  - toBuilder
```
public Instance.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Instance.Builder,Instance>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Instance.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Instance.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class Instance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

agentVersion

amiId

architecture

arn

autoScalingType

availabilityZone

blockDeviceMappings

createdAt

ebsOptimized

ec2InstanceId

ecsClusterArn

ecsContainerInstanceArn

elasticIp

hostname

infrastructureClass

installUpdatesOnBoot

instanceId

instanceProfileArn

instanceType

lastServiceErrorId

layerIds

os

platform

privateDns

privateIp

publicDns

publicIp

registeredBy

reportedAgentVersion

reportedOs

rootDeviceType

rootDeviceVolumeId

securityGroupIds

sshHostDsaKeyFingerprint

sshHostRsaKeyFingerprint

sshKeyName

stackId

status

subnetId

tenancy

virtualizationType

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall