com.amazonaws.services.redshift.model
Class CreateHsmConfigurationRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.redshift.model.CreateHsmConfigurationRequest

All Implemented Interfaces:

Serializable

public class CreateHsmConfigurationRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateHsmConfiguration operation.

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Management Guide.

See Also:

AmazonRedshift.createHsmConfiguration(CreateHsmConfigurationRequest), Serialized Form

Constructor Summary

CreateHsmConfigurationRequest()

Method Summary

boolean	equals(Object obj)
String	getDescription() A text description of the HSM configuration to be created.
String	getHsmConfigurationIdentifier() The identifier to be assigned to the new Amazon Redshift HSM configuration.
String	getHsmIpAddress() The IP address that the Amazon Redshift cluster must use to access the HSM.
String	getHsmPartitionName() The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
String	getHsmPartitionPassword() The password required to access the HSM partition.
String	getHsmServerPublicCertificate() The HSMs public certificate file.
int	hashCode()
void	setDescription(String description) A text description of the HSM configuration to be created.
void	setHsmConfigurationIdentifier(String hsmConfigurationIdentifier) The identifier to be assigned to the new Amazon Redshift HSM configuration.
void	setHsmIpAddress(String hsmIpAddress) The IP address that the Amazon Redshift cluster must use to access the HSM.
void	setHsmPartitionName(String hsmPartitionName) The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
void	setHsmPartitionPassword(String hsmPartitionPassword) The password required to access the HSM partition.
void	setHsmServerPublicCertificate(String hsmServerPublicCertificate) The HSMs public certificate file.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateHsmConfigurationRequest	withDescription(String description) A text description of the HSM configuration to be created.
CreateHsmConfigurationRequest	withHsmConfigurationIdentifier(String hsmConfigurationIdentifier) The identifier to be assigned to the new Amazon Redshift HSM configuration.
CreateHsmConfigurationRequest	withHsmIpAddress(String hsmIpAddress) The IP address that the Amazon Redshift cluster must use to access the HSM.
CreateHsmConfigurationRequest	withHsmPartitionName(String hsmPartitionName) The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
CreateHsmConfigurationRequest	withHsmPartitionPassword(String hsmPartitionPassword) The password required to access the HSM partition.
CreateHsmConfigurationRequest	withHsmServerPublicCertificate(String hsmServerPublicCertificate) The HSMs public certificate file.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateHsmConfigurationRequest

public CreateHsmConfigurationRequest()

Method Detail

getHsmConfigurationIdentifier

public String getHsmConfigurationIdentifier()

The identifier to be assigned to the new Amazon Redshift HSM configuration.

Returns:

The identifier to be assigned to the new Amazon Redshift HSM configuration.

setHsmConfigurationIdentifier

public void setHsmConfigurationIdentifier(String hsmConfigurationIdentifier)

The identifier to be assigned to the new Amazon Redshift HSM configuration.

Parameters:

hsmConfigurationIdentifier - The identifier to be assigned to the new Amazon Redshift HSM configuration.

withHsmConfigurationIdentifier

public CreateHsmConfigurationRequest withHsmConfigurationIdentifier(String hsmConfigurationIdentifier)

The identifier to be assigned to the new Amazon Redshift HSM configuration.

Returns a reference to this object so that method calls can be chained together.

Parameters:

hsmConfigurationIdentifier - The identifier to be assigned to the new Amazon Redshift HSM configuration.

Returns:

A reference to this updated object so that method calls can be chained together.

getDescription

public String getDescription()

A text description of the HSM configuration to be created.

Returns:

A text description of the HSM configuration to be created.

setDescription

public void setDescription(String description)

A text description of the HSM configuration to be created.

Parameters:

description - A text description of the HSM configuration to be created.

withDescription

public CreateHsmConfigurationRequest withDescription(String description)

A text description of the HSM configuration to be created.

Returns a reference to this object so that method calls can be chained together.

Parameters:

description - A text description of the HSM configuration to be created.

Returns:

A reference to this updated object so that method calls can be chained together.

getHsmIpAddress

public String getHsmIpAddress()

The IP address that the Amazon Redshift cluster must use to access the HSM.

Returns:

The IP address that the Amazon Redshift cluster must use to access the HSM.

setHsmIpAddress

public void setHsmIpAddress(String hsmIpAddress)

The IP address that the Amazon Redshift cluster must use to access the HSM.

Parameters:

hsmIpAddress - The IP address that the Amazon Redshift cluster must use to access the HSM.

withHsmIpAddress

public CreateHsmConfigurationRequest withHsmIpAddress(String hsmIpAddress)

The IP address that the Amazon Redshift cluster must use to access the HSM.

Returns a reference to this object so that method calls can be chained together.

Parameters:

hsmIpAddress - The IP address that the Amazon Redshift cluster must use to access the HSM.

Returns:

A reference to this updated object so that method calls can be chained together.

getHsmPartitionName

public String getHsmPartitionName()

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

Returns:

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

setHsmPartitionName

public void setHsmPartitionName(String hsmPartitionName)

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

Parameters:

hsmPartitionName - The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

withHsmPartitionName

public CreateHsmConfigurationRequest withHsmPartitionName(String hsmPartitionName)

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

Returns a reference to this object so that method calls can be chained together.

Parameters:

hsmPartitionName - The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

Returns:

A reference to this updated object so that method calls can be chained together.

getHsmPartitionPassword

public String getHsmPartitionPassword()

The password required to access the HSM partition.

Returns:

The password required to access the HSM partition.

setHsmPartitionPassword

public void setHsmPartitionPassword(String hsmPartitionPassword)

The password required to access the HSM partition.

Parameters:

hsmPartitionPassword - The password required to access the HSM partition.

withHsmPartitionPassword

public CreateHsmConfigurationRequest withHsmPartitionPassword(String hsmPartitionPassword)

The password required to access the HSM partition.

Returns a reference to this object so that method calls can be chained together.

Parameters:

hsmPartitionPassword - The password required to access the HSM partition.

Returns:

A reference to this updated object so that method calls can be chained together.

getHsmServerPublicCertificate

public String getHsmServerPublicCertificate()

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

Returns:

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

setHsmServerPublicCertificate

public void setHsmServerPublicCertificate(String hsmServerPublicCertificate)

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

Parameters:

hsmServerPublicCertificate - The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

withHsmServerPublicCertificate

public CreateHsmConfigurationRequest withHsmServerPublicCertificate(String hsmServerPublicCertificate)

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

Returns a reference to this object so that method calls can be chained together.

Parameters:

hsmServerPublicCertificate - The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object