Class AwsEc2InstanceDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsEc2InstanceDetails.Builder,
AwsEc2InstanceDetails>
The details of an Amazon EC2 instance.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the IpV4Addresses property.final boolean
For responses, this returns true if the service returned a value for the IpV6Addresses property.final boolean
For responses, this returns true if the service returned a value for the NetworkInterfaces property.final String
The IAM profile ARN of the instance.final String
imageId()
The Amazon Machine Image (AMI) ID of the instance.The IPv4 addresses associated with the instance.The IPv6 addresses associated with the instance.final String
keyName()
The key name associated with the instance.final String
Indicates when the instance was launched.Details about the metadata options for the Amazon EC2 instance.Describes the type of monitoring that’s turned on for an instance.The identifiers of the network interfaces for the EC2 instance.static Class
<? extends AwsEc2InstanceDetails.Builder> final String
subnetId()
The identifier of the subnet that the instance was launched in.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
type()
The instance type of the instance.final String
The virtualization type of the Amazon Machine Image (AMI) required to launch the instance.final String
vpcId()
The identifier of the VPC that the instance was launched in.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The instance type of the instance.
- Returns:
- The instance type of the instance.
-
imageId
The Amazon Machine Image (AMI) ID of the instance.
- Returns:
- The Amazon Machine Image (AMI) ID of the instance.
-
hasIpV4Addresses
public final boolean hasIpV4Addresses()For responses, this returns true if the service returned a value for the IpV4Addresses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
ipV4Addresses
The IPv4 addresses associated with the instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasIpV4Addresses()
method.- Returns:
- The IPv4 addresses associated with the instance.
-
hasIpV6Addresses
public final boolean hasIpV6Addresses()For responses, this returns true if the service returned a value for the IpV6Addresses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
ipV6Addresses
The IPv6 addresses associated with the instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasIpV6Addresses()
method.- Returns:
- The IPv6 addresses associated with the instance.
-
keyName
The key name associated with the instance.
- Returns:
- The key name associated with the instance.
-
iamInstanceProfileArn
The IAM profile ARN of the instance.
- Returns:
- The IAM profile ARN of the instance.
-
vpcId
The identifier of the VPC that the instance was launched in.
- Returns:
- The identifier of the VPC that the instance was launched in.
-
subnetId
The identifier of the subnet that the instance was launched in.
- Returns:
- The identifier of the subnet that the instance was launched in.
-
launchedAt
Indicates when the instance was launched.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
- Returns:
- Indicates when the instance was launched.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
-
-
-
hasNetworkInterfaces
public final boolean hasNetworkInterfaces()For responses, this returns true if the service returned a value for the NetworkInterfaces property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
networkInterfaces
The identifiers of the network interfaces for the EC2 instance. The details for each network interface are in a corresponding
AwsEc2NetworkInterfacesDetails
object.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasNetworkInterfaces()
method.- Returns:
- The identifiers of the network interfaces for the EC2 instance. The details for each network interface
are in a corresponding
AwsEc2NetworkInterfacesDetails
object.
-
virtualizationType
The virtualization type of the Amazon Machine Image (AMI) required to launch the instance.
- Returns:
- The virtualization type of the Amazon Machine Image (AMI) required to launch the instance.
-
metadataOptions
Details about the metadata options for the Amazon EC2 instance.
- Returns:
- Details about the metadata options for the Amazon EC2 instance.
-
monitoring
Describes the type of monitoring that’s turned on for an instance.
- Returns:
- Describes the type of monitoring that’s turned on for an instance.
-
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 interfaceToCopyableBuilder<AwsEc2InstanceDetails.Builder,
AwsEc2InstanceDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-