com.amazonaws.cloudhsm.jce.provider

Class CloudHsmClusterBuilder

java.lang.Object

com.amazonaws.cloudhsm.jce.provider.CloudHsmClusterBuilder

public class CloudHsmClusterBuilder
extends java.lang.Object

This is the builder class for the CloudHSM cluster config CloudHsmCluster.

Method Summary

Modifier and Type	Method and Description
CloudHsmCluster	build() Constructs the CloudHsmCluster with the input provided to the builder.
CloudHsmClusterBuilder	withClientCertFilePath(java.lang.String clientCertFilePath) Sets the client certificate file used to connect with mTLS to a cluster server over E2E.
CloudHsmClusterBuilder	withClientPrivateKeyFilePath(java.lang.String clientPrivateKeyFilePath) Sets the client private key file used to connect with mTLS to a cluster server over E2E.
CloudHsmClusterBuilder	withClusterType(java.lang.String clusterType) Sets the type of the cluster which the configuration has been provided for.
CloudHsmClusterBuilder	withClusterUniqueIdentifier(java.lang.String clusterUniqueIdentifier) Sets the uniqueIdentifier for a provider.
CloudHsmClusterBuilder	withHsmCAFilePath(java.lang.String hsmCAFilePath) Sets the CA file required to connect to a cluster server over E2E.
CloudHsmClusterBuilder	withOptions(java.lang.Object optionalParameter, java.lang.Object optionalParameterValue) Sets an optional parameter.
CloudHsmClusterBuilder	withProxyHostnamesConfig(CloudHsmProxyHostnamesConfig proxyHostnamesConfig) Sets the proxy hostnames to specify the proxy type and mapping hsm hostnames to proxy hostnames.
CloudHsmClusterBuilder	withServer(CloudHsmServer server) Sets the reference to the server configuration (for example, network config).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withClusterUniqueIdentifier

public CloudHsmClusterBuilder withClusterUniqueIdentifier(java.lang.String clusterUniqueIdentifier)

Sets the uniqueIdentifier for a provider.

If the uniqueIdentifier is not provided, an internal identifier based on UUID will be generated and used. One example of the generated uniqueIdentifier is "CloudHSM-5f901b70-df55-42d7-9426-416c538e2235".

The generated uniqueIdentifier will be used as the provider name and same identifier string can be used to lookup the provider.

If the uniqueIdentifier is already registered with JCE, exception is thrown.

Parameters:

clusterUniqueIdentifier - The identifier that can uniquely identify the provider.

Returns:

The current instance of the builder CloudHsmClusterBuilder.

withOptions

public CloudHsmClusterBuilder withOptions(java.lang.Object optionalParameter,
                                          java.lang.Object optionalParameterValue)
                                   throws java.security.InvalidParameterException

Sets an optional parameter.

Parameters:

optionalParameter - A parameter of type OptionalParameters.

optionalParameterValue - The value of the optional parameter passed above.

Returns:

The current instance of the builder CloudHsmClusterBuilder.

Throws:

java.security.InvalidParameterException - when optional parameter value is not of the expected type.

See Also:

OptionalParameters

withClusterType

public CloudHsmClusterBuilder withClusterType(java.lang.String clusterType)

Sets the type of the cluster which the configuration has been provided for.

Parameters:

clusterType - The type of the cluster.

Returns:

The current instance of the builder CloudHsmClusterBuilder.

withHsmCAFilePath

public CloudHsmClusterBuilder withHsmCAFilePath(java.lang.String hsmCAFilePath)

Sets the CA file required to connect to a cluster server over E2E.

Parameters:

hsmCAFilePath - The HSM CA certificate file path.

Returns:

The current instance of the builder CloudHsmClusterBuilder.

withClientCertFilePath

public CloudHsmClusterBuilder withClientCertFilePath(java.lang.String clientCertFilePath)

Sets the client certificate file used to connect with mTLS to a cluster server over E2E.

Parameters:

clientCertFilePath - The client certificate file path.

Returns:

The current instance of the builder CloudHsmClusterBuilder.

withClientPrivateKeyFilePath

public CloudHsmClusterBuilder withClientPrivateKeyFilePath(java.lang.String clientPrivateKeyFilePath)

Sets the client private key file used to connect with mTLS to a cluster server over E2E.

Parameters:

clientPrivateKeyFilePath - The client private key file path.

Returns:

The current instance of the builder CloudHsmClusterBuilder.

withServer

public CloudHsmClusterBuilder withServer(CloudHsmServer server)

Sets the reference to the server configuration (for example, network config). This will store unique HsmIPs only. When the duplicate HsmIPs are specified, they will be ignored.

Parameters:

server - CloudHSM server.

Returns:

The current instance of the builder CloudHsmClusterBuilder.

withProxyHostnamesConfig

public CloudHsmClusterBuilder withProxyHostnamesConfig(CloudHsmProxyHostnamesConfig proxyHostnamesConfig)

Sets the proxy hostnames to specify the proxy type and mapping hsm hostnames to proxy hostnames.

Parameters:

proxyHostnamesConfig - proxy hostnames related configuration

Returns:

current instance of the builder CloudHsmClusterBuilder.

build

public CloudHsmCluster build()
                      throws java.security.InvalidParameterException

Constructs the CloudHsmCluster with the input provided to the builder.

Returns:

new object of CloudHsmCluster.

Throws:

java.security.InvalidParameterException - when the value of the provided optional parameter(s) does not match with the expected type.