software.amazon.awssdk.services.redshift.model

Class HsmConfiguration

java.lang.Object

software.amazon.awssdk.services.redshift.model.HsmConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HsmConfiguration.Builder,HsmConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class HsmConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HsmConfiguration.Builder,HsmConfiguration>

Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HsmConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static HsmConfiguration.Builder	builder()
String	description() A text description of the HSM configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	hsmConfigurationIdentifier() The name of the Amazon Redshift HSM configuration.
String	hsmIpAddress() The IP address that the Amazon Redshift cluster must use to access the HSM.
String	hsmPartitionName() The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
List<SdkField<?>>	sdkFields()
static Class<? extends HsmConfiguration.Builder>	serializableBuilderClass()
List<Tag>	tags() The list of tags for the HSM configuration.
HsmConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hsmConfigurationIdentifier

public final String hsmConfigurationIdentifier()

The name of the Amazon Redshift HSM configuration.

Returns:

The name of the Amazon Redshift HSM configuration.

description

public final String description()

A text description of the HSM configuration.

Returns:

A text description of the HSM configuration.

hsmIpAddress

public final String hsmIpAddress()

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.

hsmPartitionName

public final String hsmPartitionName()

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

The list of tags for the HSM configuration.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The list of tags for the HSM configuration.

toBuilder

public HsmConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HsmConfiguration.Builder,HsmConfiguration>

builder

public static HsmConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends HsmConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo