@Generated(value="software.amazon.awssdk:codegen") public class Instance extends Object implements StructuredPojo, ToCopyableBuilder<Instance.Builder,Instance>
Describes an instance.
Modifier and Type | Class and Description |
---|---|
static interface |
Instance.Builder |
Modifier and Type | Method and Description |
---|---|
String |
agentVersion()
The agent version.
|
String |
amiId()
A custom AMI ID to be used to create the instance.
|
Architecture |
architecture()
The instance architecture: "i386" or "x86_64".
|
String |
architectureString()
The instance architecture: "i386" or "x86_64".
|
String |
arn()
Returns the value of the Arn property for this object.
|
AutoScalingType |
autoScalingType()
For load-based or time-based instances, the type.
|
String |
autoScalingTypeString()
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
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.
|
RootDeviceType |
rootDeviceType()
The instance's root device type.
|
String |
rootDeviceTypeString()
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() |
VirtualizationType |
virtualizationType()
The instance's virtualization type:
paravirtual or hvm . |
String |
virtualizationTypeString()
The instance's virtualization type:
paravirtual or hvm . |
copy
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.
INHERIT
if the instance inherits the default
stack setting or to a a version number for a fixed agent version.public String amiId()
A custom AMI ID to be used to create the instance. For more information, see Instances
public Architecture architecture()
The instance architecture: "i386" or "x86_64".
If the service returns an enum value that is not available in the current SDK version, architecture
will
return Architecture.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
architectureString()
.
Architecture
public String architectureString()
The instance architecture: "i386" or "x86_64".
If the service returns an enum value that is not available in the current SDK version, architecture
will
return Architecture.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
architectureString()
.
Architecture
public String arn()
public AutoScalingType autoScalingType()
For load-based or time-based instances, the type.
If the service returns an enum value that is not available in the current SDK version, autoScalingType
will return AutoScalingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from autoScalingTypeString()
.
AutoScalingType
public String autoScalingTypeString()
For load-based or time-based instances, the type.
If the service returns an enum value that is not available in the current SDK version, autoScalingType
will return AutoScalingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from autoScalingTypeString()
.
AutoScalingType
public String availabilityZone()
The instance Availability Zone. For more information, see Regions and Endpoints.
public List<BlockDeviceMapping> blockDeviceMappings()
An array of BlockDeviceMapping
objects that specify the instance's block device mappings.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
BlockDeviceMapping
objects that specify the instance's block device mappings.public String createdAt()
The time that the instance was created.
public Boolean ebsOptimized()
Whether this is an Amazon EBS-optimized instance.
public String ec2InstanceId()
The ID of the associated Amazon EC2 instance.
public String ecsClusterArn()
For container instances, the Amazon ECS cluster's ARN.
public String ecsContainerInstanceArn()
For container instances, the instance's ARN.
public String elasticIp()
The instance Elastic IP address .
public String hostname()
The instance host name.
public String infrastructureClass()
For registered instances, the infrastructure class: ec2
or on-premises
.
ec2
or on-premises
.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.
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.
public String instanceId()
The instance ID.
public String instanceProfileArn()
The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
public String instanceType()
The instance type, such as t2.micro
.
t2.micro
.public String lastServiceErrorId()
The ID of the last service error. For more information, call DescribeServiceErrors.
public List<String> layerIds()
An array containing the instance layer IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String os()
The instance's operating system.
public String platform()
The instance's platform.
public String privateDns()
The instance's private DNS name.
public String privateIp()
The instance's private IP address.
public String publicDns()
The instance public DNS name.
public String publicIp()
The instance public IP address.
public String registeredBy()
For registered instances, who performed the registration.
public String reportedAgentVersion()
The instance's reported AWS OpsWorks Stacks agent version.
public ReportedOs reportedOs()
For registered instances, the reported operating system.
public RootDeviceType rootDeviceType()
The instance's root device type. For more information, see Storage for the Root Device.
If the service returns an enum value that is not available in the current SDK version, rootDeviceType
will return RootDeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from rootDeviceTypeString()
.
RootDeviceType
public String rootDeviceTypeString()
The instance's root device type. For more information, see Storage for the Root Device.
If the service returns an enum value that is not available in the current SDK version, rootDeviceType
will return RootDeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from rootDeviceTypeString()
.
RootDeviceType
public String rootDeviceVolumeId()
The root device volume ID.
public List<String> securityGroupIds()
An array containing the instance security group IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String sshHostDsaKeyFingerprint()
The SSH key's Deep Security Agent (DSA) fingerprint.
public String sshHostRsaKeyFingerprint()
The SSH key's RSA fingerprint.
public String sshKeyName()
The instance's Amazon EC2 key-pair name.
public String stackId()
The stack ID.
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
booting
connection_lost
online
pending
rebooting
requested
running_setup
setup_failed
shutting_down
start_failed
stop_failed
stopped
stopping
terminated
terminating
public String subnetId()
The instance's subnet ID; applicable only if the stack is running in a VPC.
public String tenancy()
The instance's tenancy option, such as dedicated
or host
.
dedicated
or host
.public VirtualizationType virtualizationType()
The instance's virtualization type: paravirtual
or hvm
.
If the service returns an enum value that is not available in the current SDK version,
virtualizationType
will return VirtualizationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from virtualizationTypeString()
.
paravirtual
or hvm
.VirtualizationType
public String virtualizationTypeString()
The instance's virtualization type: paravirtual
or hvm
.
If the service returns an enum value that is not available in the current SDK version,
virtualizationType
will return VirtualizationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from virtualizationTypeString()
.
paravirtual
or hvm
.VirtualizationType
public Instance.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Instance.Builder,Instance>
public static Instance.Builder builder()
public static Class<? extends Instance.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.