Cluster (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudhsmv2.model.Cluster

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Cluster
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about an AWS CloudHSM cluster.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Cluster()

Constructors
Constructor and Description
`Cluster()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Cluster`	`addSubnetMappingEntry(String key, String value)`
`Cluster`	`clearSubnetMappingEntries()` Removes all the entries added into SubnetMapping.
`Cluster`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBackupPolicy()` The cluster's backup policy.
`Certificates`	`getCertificates()` Contains one or more certificates or a certificate signing request (CSR).
`String`	`getClusterId()` The cluster's identifier (ID).
`Date`	`getCreateTimestamp()` The date and time when the cluster was created.
`List<Hsm>`	`getHsms()` Contains information about the HSMs in the cluster.
`String`	`getHsmType()` The type of HSM that the cluster contains.
`String`	`getPreCoPassword()` The default password for the cluster's Pre-Crypto Officer (PRECO) user.
`String`	`getSecurityGroup()` The identifier (ID) of the cluster's security group.
`String`	`getSourceBackupId()` The identifier (ID) of the backup used to create the cluster.
`String`	`getState()` The cluster's state.
`String`	`getStateMessage()` A description of the cluster's state.
`Map<String,String>`	`getSubnetMapping()` A map of the cluster's subnets and their corresponding Availability Zones.
`String`	`getVpcId()` The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBackupPolicy(String backupPolicy)` The cluster's backup policy.
`void`	`setCertificates(Certificates certificates)` Contains one or more certificates or a certificate signing request (CSR).
`void`	`setClusterId(String clusterId)` The cluster's identifier (ID).
`void`	`setCreateTimestamp(Date createTimestamp)` The date and time when the cluster was created.
`void`	`setHsms(Collection<Hsm> hsms)` Contains information about the HSMs in the cluster.
`void`	`setHsmType(String hsmType)` The type of HSM that the cluster contains.
`void`	`setPreCoPassword(String preCoPassword)` The default password for the cluster's Pre-Crypto Officer (PRECO) user.
`void`	`setSecurityGroup(String securityGroup)` The identifier (ID) of the cluster's security group.
`void`	`setSourceBackupId(String sourceBackupId)` The identifier (ID) of the backup used to create the cluster.
`void`	`setState(String state)` The cluster's state.
`void`	`setStateMessage(String stateMessage)` A description of the cluster's state.
`void`	`setSubnetMapping(Map<String,String> subnetMapping)` A map of the cluster's subnets and their corresponding Availability Zones.
`void`	`setVpcId(String vpcId)` The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Cluster`	`withBackupPolicy(BackupPolicy backupPolicy)` The cluster's backup policy.
`Cluster`	`withBackupPolicy(String backupPolicy)` The cluster's backup policy.
`Cluster`	`withCertificates(Certificates certificates)` Contains one or more certificates or a certificate signing request (CSR).
`Cluster`	`withClusterId(String clusterId)` The cluster's identifier (ID).
`Cluster`	`withCreateTimestamp(Date createTimestamp)` The date and time when the cluster was created.
`Cluster`	`withHsms(Collection<Hsm> hsms)` Contains information about the HSMs in the cluster.
`Cluster`	`withHsms(Hsm... hsms)` Contains information about the HSMs in the cluster.
`Cluster`	`withHsmType(String hsmType)` The type of HSM that the cluster contains.
`Cluster`	`withPreCoPassword(String preCoPassword)` The default password for the cluster's Pre-Crypto Officer (PRECO) user.
`Cluster`	`withSecurityGroup(String securityGroup)` The identifier (ID) of the cluster's security group.
`Cluster`	`withSourceBackupId(String sourceBackupId)` The identifier (ID) of the backup used to create the cluster.
`Cluster`	`withState(ClusterState state)` The cluster's state.
`Cluster`	`withState(String state)` The cluster's state.
`Cluster`	`withStateMessage(String stateMessage)` A description of the cluster's state.
`Cluster`	`withSubnetMapping(Map<String,String> subnetMapping)` A map of the cluster's subnets and their corresponding Availability Zones.
`Cluster`	`withVpcId(String vpcId)` The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Cluster
```
public Cluster()
```
- Method Detail
  - setBackupPolicy
```
public void setBackupPolicy(String backupPolicy)
```
    The cluster's backup policy.
    
    Parameters:
    
    backupPolicy - The cluster's backup policy.
    
    See Also:
    
    BackupPolicy
  - getBackupPolicy
```
public String getBackupPolicy()
```
    The cluster's backup policy.
    
    Returns:
    
    The cluster's backup policy.
    
    See Also:
    
    BackupPolicy
  - withBackupPolicy
```
public Cluster withBackupPolicy(String backupPolicy)
```
    The cluster's backup policy.
    
    Parameters:
    
    backupPolicy - The cluster's backup policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BackupPolicy
  - withBackupPolicy
```
public Cluster withBackupPolicy(BackupPolicy backupPolicy)
```
    The cluster's backup policy.
    
    Parameters:
    
    backupPolicy - The cluster's backup policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BackupPolicy
  - setClusterId
```
public void setClusterId(String clusterId)
```
    The cluster's identifier (ID).
    
    Parameters:
    
    clusterId - The cluster's identifier (ID).
  - getClusterId
```
public String getClusterId()
```
    The cluster's identifier (ID).
    
    Returns:
    
    The cluster's identifier (ID).
  - withClusterId
```
public Cluster withClusterId(String clusterId)
```
    The cluster's identifier (ID).
    
    Parameters:
    
    clusterId - The cluster's identifier (ID).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateTimestamp
```
public void setCreateTimestamp(Date createTimestamp)
```
    The date and time when the cluster was created.
    
    Parameters:
    
    createTimestamp - The date and time when the cluster was created.
  - getCreateTimestamp
```
public Date getCreateTimestamp()
```
    The date and time when the cluster was created.
    
    Returns:
    
    The date and time when the cluster was created.
  - withCreateTimestamp
```
public Cluster withCreateTimestamp(Date createTimestamp)
```
    The date and time when the cluster was created.
    
    Parameters:
    
    createTimestamp - The date and time when the cluster was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getHsms
```
public List<Hsm> getHsms()
```
    Contains information about the HSMs in the cluster.
    
    Returns:
    
    Contains information about the HSMs in the cluster.
  - setHsms
```
public void setHsms(Collection<Hsm> hsms)
```
    Contains information about the HSMs in the cluster.
    
    Parameters:
    
    hsms - Contains information about the HSMs in the cluster.
  - withHsms
```
public Cluster withHsms(Hsm... hsms)
```
    Contains information about the HSMs in the cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setHsms(java.util.Collection) or withHsms(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    hsms - Contains information about the HSMs in the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withHsms
```
public Cluster withHsms(Collection<Hsm> hsms)
```
    Contains information about the HSMs in the cluster.
    
    Parameters:
    
    hsms - Contains information about the HSMs in the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHsmType
```
public void setHsmType(String hsmType)
```
    The type of HSM that the cluster contains.
    
    Parameters:
    
    hsmType - The type of HSM that the cluster contains.
  - getHsmType
```
public String getHsmType()
```
    The type of HSM that the cluster contains.
    
    Returns:
    
    The type of HSM that the cluster contains.
  - withHsmType
```
public Cluster withHsmType(String hsmType)
```
    The type of HSM that the cluster contains.
    
    Parameters:
    
    hsmType - The type of HSM that the cluster contains.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreCoPassword
```
public void setPreCoPassword(String preCoPassword)
```
    The default password for the cluster's Pre-Crypto Officer (PRECO) user.
    
    Parameters:
    
    preCoPassword - The default password for the cluster's Pre-Crypto Officer (PRECO) user.
  - getPreCoPassword
```
public String getPreCoPassword()
```
    The default password for the cluster's Pre-Crypto Officer (PRECO) user.
    
    Returns:
    
    The default password for the cluster's Pre-Crypto Officer (PRECO) user.
  - withPreCoPassword
```
public Cluster withPreCoPassword(String preCoPassword)
```
    The default password for the cluster's Pre-Crypto Officer (PRECO) user.
    
    Parameters:
    
    preCoPassword - The default password for the cluster's Pre-Crypto Officer (PRECO) user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityGroup
```
public void setSecurityGroup(String securityGroup)
```
    The identifier (ID) of the cluster's security group.
    
    Parameters:
    
    securityGroup - The identifier (ID) of the cluster's security group.
  - getSecurityGroup
```
public String getSecurityGroup()
```
    The identifier (ID) of the cluster's security group.
    
    Returns:
    
    The identifier (ID) of the cluster's security group.
  - withSecurityGroup
```
public Cluster withSecurityGroup(String securityGroup)
```
    The identifier (ID) of the cluster's security group.
    
    Parameters:
    
    securityGroup - The identifier (ID) of the cluster's security group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceBackupId
```
public void setSourceBackupId(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.
    
    Parameters:
    
    sourceBackupId - The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
  - getSourceBackupId
```
public String getSourceBackupId()
```
    The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
    
    Returns:
    
    The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
  - withSourceBackupId
```
public Cluster withSourceBackupId(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.
    
    Parameters:
    
    sourceBackupId - The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The cluster's state.
    
    Parameters:
    
    state - The cluster's state.
    
    See Also:
    
    ClusterState
  - getState
```
public String getState()
```
    The cluster's state.
    
    Returns:
    
    The cluster's state.
    
    See Also:
    
    ClusterState
  - withState
```
public Cluster withState(String state)
```
    The cluster's state.
    
    Parameters:
    
    state - The cluster's state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterState
  - withState
```
public Cluster withState(ClusterState state)
```
    The cluster's state.
    
    Parameters:
    
    state - The cluster's state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterState
  - setStateMessage
```
public void setStateMessage(String stateMessage)
```
    A description of the cluster's state.
    
    Parameters:
    
    stateMessage - A description of the cluster's state.
  - getStateMessage
```
public String getStateMessage()
```
    A description of the cluster's state.
    
    Returns:
    
    A description of the cluster's state.
  - withStateMessage
```
public Cluster withStateMessage(String stateMessage)
```
    A description of the cluster's state.
    
    Parameters:
    
    stateMessage - A description of the cluster's state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubnetMapping
```
public Map<String,String> getSubnetMapping()
```
    A map of the cluster's subnets and their corresponding Availability Zones.
    
    Returns:
    
    A map of the cluster's subnets and their corresponding Availability Zones.
  - setSubnetMapping
```
public void setSubnetMapping(Map<String,String> subnetMapping)
```
    A map of the cluster's subnets and their corresponding Availability Zones.
    
    Parameters:
    
    subnetMapping - A map of the cluster's subnets and their corresponding Availability Zones.
  - withSubnetMapping
```
public Cluster withSubnetMapping(Map<String,String> subnetMapping)
```
    A map of the cluster's subnets and their corresponding Availability Zones.
    
    Parameters:
    
    subnetMapping - A map of the cluster's subnets and their corresponding Availability Zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSubnetMappingEntry
```
public Cluster addSubnetMappingEntry(String key,
                                     String value)
```
  - clearSubnetMappingEntries
```
public Cluster clearSubnetMappingEntries()
```
    Removes all the entries added into SubnetMapping.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcId
```
public void setVpcId(String vpcId)
```
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    
    Parameters:
    
    vpcId - The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
  - getVpcId
```
public String getVpcId()
```
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    
    Returns:
    
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
  - withVpcId
```
public Cluster withVpcId(String vpcId)
```
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    
    Parameters:
    
    vpcId - The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCertificates
```
public void setCertificates(Certificates certificates)
```
    Contains one or more certificates or a certificate signing request (CSR).
    
    Parameters:
    
    certificates - Contains one or more certificates or a certificate signing request (CSR).
  - getCertificates
```
public Certificates getCertificates()
```
    Contains one or more certificates or a certificate signing request (CSR).
    
    Returns:
    
    Contains one or more certificates or a certificate signing request (CSR).
  - withCertificates
```
public Cluster withCertificates(Certificates certificates)
```
    Contains one or more certificates or a certificate signing request (CSR).
    
    Parameters:
    
    certificates - Contains one or more certificates or a certificate signing request (CSR).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Cluster clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Cluster

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cluster

Method Detail

setBackupPolicy

getBackupPolicy

withBackupPolicy

withBackupPolicy

setClusterId

getClusterId

withClusterId

setCreateTimestamp

getCreateTimestamp

withCreateTimestamp

getHsms

setHsms

withHsms

withHsms

setHsmType

getHsmType

withHsmType

setPreCoPassword

getPreCoPassword

withPreCoPassword

setSecurityGroup

getSecurityGroup

withSecurityGroup

setSourceBackupId

getSourceBackupId

withSourceBackupId

setState

getState

withState

withState

setStateMessage

getStateMessage

withStateMessage

getSubnetMapping

setSubnetMapping

withSubnetMapping

addSubnetMappingEntry

clearSubnetMappingEntries

setVpcId

getVpcId

withVpcId

setCertificates

getCertificates

withCertificates

toString

equals

hashCode

clone

marshall