@Generated(value="software.amazon.awssdk:codegen") public final class DescribeHsmResponse extends CloudHsmResponse implements ToCopyableBuilder<DescribeHsmResponse.Builder,DescribeHsmResponse>
Contains the output of the DescribeHsm operation.
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeHsmResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
availabilityZone()
The Availability Zone that the HSM is in.
|
static DescribeHsmResponse.Builder |
builder() |
String |
eniId()
The identifier of the elastic network interface (ENI) attached to the HSM.
|
String |
eniIp()
The IP address assigned to the HSM's ENI.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasPartitions()
For responses, this returns true if the service returned a value for the Partitions property.
|
String |
hsmArn()
The ARN of the HSM.
|
String |
hsmType()
The HSM model type.
|
String |
iamRoleArn()
The ARN of the IAM role assigned to the HSM.
|
List<String> |
partitions()
The list of partitions on the HSM.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeHsmResponse.Builder> |
serializableBuilderClass() |
String |
serialNumber()
The serial number of the HSM.
|
String |
serverCertLastUpdated()
The date and time that the server certificate was last updated.
|
String |
serverCertUri()
The URI of the certificate server.
|
String |
softwareVersion()
The HSM software version.
|
String |
sshKeyLastUpdated()
The date and time that the SSH key was last updated.
|
String |
sshPublicKey()
The public SSH key.
|
HsmStatus |
status()
The status of the HSM.
|
String |
statusAsString()
The status of the HSM.
|
String |
statusDetails()
Contains additional information about the status of the HSM.
|
String |
subnetId()
The identifier of the subnet that the HSM is in.
|
String |
subscriptionEndDate()
The subscription end date.
|
String |
subscriptionStartDate()
The subscription start date.
|
SubscriptionType |
subscriptionType()
Returns the value of the SubscriptionType property for this object.
|
String |
subscriptionTypeAsString()
Returns the value of the SubscriptionType property for this object.
|
DescribeHsmResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
vendorName()
The name of the HSM vendor.
|
String |
vpcId()
The identifier of the VPC that the HSM is in.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String hsmArn()
The ARN of the HSM.
public final HsmStatus status()
The status of the HSM.
If the service returns an enum value that is not available in the current SDK version, status will
return HsmStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
statusAsString().
HsmStatuspublic final String statusAsString()
The status of the HSM.
If the service returns an enum value that is not available in the current SDK version, status will
return HsmStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
statusAsString().
HsmStatuspublic final String statusDetails()
Contains additional information about the status of the HSM.
public final String availabilityZone()
The Availability Zone that the HSM is in.
public final String eniId()
The identifier of the elastic network interface (ENI) attached to the HSM.
public final String eniIp()
The IP address assigned to the HSM's ENI.
public final SubscriptionType subscriptionType()
If the service returns an enum value that is not available in the current SDK version, subscriptionType
will return SubscriptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from subscriptionTypeAsString().
SubscriptionTypepublic final String subscriptionTypeAsString()
If the service returns an enum value that is not available in the current SDK version, subscriptionType
will return SubscriptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from subscriptionTypeAsString().
SubscriptionTypepublic final String subscriptionStartDate()
The subscription start date.
public final String subscriptionEndDate()
The subscription end date.
public final String vpcId()
The identifier of the VPC that the HSM is in.
public final String subnetId()
The identifier of the subnet that the HSM is in.
public final String iamRoleArn()
The ARN of the IAM role assigned to the HSM.
public final String serialNumber()
The serial number of the HSM.
public final String vendorName()
The name of the HSM vendor.
public final String hsmType()
The HSM model type.
public final String softwareVersion()
The HSM software version.
public final String sshPublicKey()
The public SSH key.
public final String sshKeyLastUpdated()
The date and time that the SSH key was last updated.
public final String serverCertUri()
The URI of the certificate server.
public final String serverCertLastUpdated()
The date and time that the server certificate was last updated.
public final boolean hasPartitions()
isEmpty() 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.public final List<String> partitions()
The list of partitions on the HSM.
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 hasPartitions() method.
public DescribeHsmResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeHsmResponse.Builder,DescribeHsmResponse>toBuilder in class AwsResponsepublic static DescribeHsmResponse.Builder builder()
public static Class<? extends DescribeHsmResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.