@Generated(value="software.amazon.awssdk:codegen") public 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
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.
|
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 |
statusDetails()
Contains additional information about the status of the HSM.
|
String |
statusString()
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 |
subscriptionTypeString()
Returns the value of the SubscriptionType property for this object.
|
DescribeHsmResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
vendorName()
The name of the HSM vendor.
|
String |
vpcId()
The identifier of the VPC that the HSM is in.
|
copy
public String hsmArn()
The ARN of the HSM.
public 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
statusString()
.
HsmStatus
public String statusString()
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
statusString()
.
HsmStatus
public String statusDetails()
Contains additional information about the status of the HSM.
public String availabilityZone()
The Availability Zone that the HSM is in.
public String eniId()
The identifier of the elastic network interface (ENI) attached to the HSM.
public String eniIp()
The IP address assigned to the HSM's ENI.
public 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 subscriptionTypeString()
.
SubscriptionType
public String subscriptionTypeString()
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 subscriptionTypeString()
.
SubscriptionType
public String subscriptionStartDate()
The subscription start date.
public String subscriptionEndDate()
The subscription end date.
public String vpcId()
The identifier of the VPC that the HSM is in.
public String subnetId()
The identifier of the subnet that the HSM is in.
public String iamRoleArn()
The ARN of the IAM role assigned to the HSM.
public String serialNumber()
The serial number of the HSM.
public String vendorName()
The name of the HSM vendor.
public String hsmType()
The HSM model type.
public String softwareVersion()
The HSM software version.
public String sshPublicKey()
The public SSH key.
public String sshKeyLastUpdated()
The date and time that the SSH key was last updated.
public String serverCertUri()
The URI of the certificate server.
public String serverCertLastUpdated()
The date and time that the server certificate was last updated.
public List<String> partitions()
The list of partitions on the HSM.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public DescribeHsmResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeHsmResponse.Builder,DescribeHsmResponse>
toBuilder
in class AwsResponse
public static DescribeHsmResponse.Builder builder()
public static Class<? extends DescribeHsmResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.