@Generated(value="software.amazon.awssdk:codegen") public class Cluster extends Object implements StructuredPojo, ToCopyableBuilder<Cluster.Builder,Cluster>
Contains information about an AWS CloudHSM cluster.
Modifier and Type | Class and Description |
---|---|
static interface |
Cluster.Builder |
Modifier and Type | Method and Description |
---|---|
BackupPolicy |
backupPolicy()
The cluster's backup policy.
|
String |
backupPolicyString()
The cluster's backup policy.
|
static Cluster.Builder |
builder() |
Certificates |
certificates()
Contains one or more certificates or a certificate signing request (CSR).
|
String |
clusterId()
The cluster's identifier (ID).
|
Instant |
createTimestamp()
The date and time when the cluster was created.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<Hsm> |
hsms()
Contains information about the HSMs in the cluster.
|
String |
hsmType()
The type of HSM that the cluster contains.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
preCoPassword()
The default password for the cluster's Pre-Crypto Officer (PRECO) user.
|
String |
securityGroup()
The identifier (ID) of the cluster's security group.
|
static Class<? extends Cluster.Builder> |
serializableBuilderClass() |
String |
sourceBackupId()
The identifier (ID) of the backup used to create the cluster.
|
ClusterState |
state()
The cluster's state.
|
String |
stateMessage()
A description of the cluster's state.
|
String |
stateString()
The cluster's state.
|
Map<String,String> |
subnetMapping()
A map of the cluster's subnets and their corresponding Availability Zones.
|
Cluster.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
vpcId()
The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
|
copy
public BackupPolicy backupPolicy()
The cluster's backup policy.
If the service returns an enum value that is not available in the current SDK version, backupPolicy
will
return BackupPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
backupPolicyString()
.
BackupPolicy
public String backupPolicyString()
The cluster's backup policy.
If the service returns an enum value that is not available in the current SDK version, backupPolicy
will
return BackupPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
backupPolicyString()
.
BackupPolicy
public String clusterId()
The cluster's identifier (ID).
public Instant createTimestamp()
The date and time when the cluster was created.
public List<Hsm> hsms()
Contains information about the HSMs in the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String hsmType()
The type of HSM that the cluster contains.
public String preCoPassword()
The default password for the cluster's Pre-Crypto Officer (PRECO) user.
public String securityGroup()
The identifier (ID) of the cluster's security group.
public String sourceBackupId()
The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
public ClusterState state()
The cluster's state.
If the service returns an enum value that is not available in the current SDK version, state
will return
ClusterState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateString()
.
ClusterState
public String stateString()
The cluster's state.
If the service returns an enum value that is not available in the current SDK version, state
will return
ClusterState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateString()
.
ClusterState
public String stateMessage()
A description of the cluster's state.
public Map<String,String> subnetMapping()
A map of the cluster's subnets and their corresponding Availability Zones.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String vpcId()
The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
public Certificates certificates()
Contains one or more certificates or a certificate signing request (CSR).
public Cluster.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Cluster.Builder,Cluster>
public static Cluster.Builder builder()
public static Class<? extends Cluster.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.