Package software.amazon.awssdk.services.elasticache.model

Class Parameter

java.lang.Object

software.amazon.awssdk.services.elasticache.model.Parameter

All Implemented Interfaces:

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

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

Describes an individual setting that controls some aspect of ElastiCache behavior.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Parameter.Builder

Method Summary

Modifier and Type	Method	Description
String	allowedValues()	The valid range of values for the parameter.
static Parameter.Builder	builder()
ChangeType	changeType()	Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied.
String	changeTypeAsString()	Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied.
String	dataType()	The valid data type for the parameter.
String	description()	A description of the parameter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	isModifiable()	Indicates whether (true) or not (false) the parameter can be modified.
String	minimumEngineVersion()	The earliest cache engine version to which the parameter can apply.
String	parameterName()	The name of the parameter.
String	parameterValue()	The value of the parameter.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Parameter.Builder>	serializableBuilderClass()
String	source()	The source of the parameter.
Parameter.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

parameterName

public final String parameterName()

The name of the parameter.

Returns:

The name of the parameter.

parameterValue

public final String parameterValue()

The value of the parameter.

Returns:

The value of the parameter.

description

public final String description()

A description of the parameter.

Returns:

A description of the parameter.

source

public final String source()

The source of the parameter.

Returns:

The source of the parameter.

dataType

public final String dataType()

The valid data type for the parameter.

Returns:

The valid data type for the parameter.

allowedValues

public final String allowedValues()

The valid range of values for the parameter.

Returns:

The valid range of values for the parameter.

isModifiable

public final Boolean isModifiable()

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

Returns:

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

minimumEngineVersion

public final String minimumEngineVersion()

The earliest cache engine version to which the parameter can apply.

Returns:

The earliest cache engine version to which the parameter can apply.

changeType

public final ChangeType changeType()

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

If the service returns an enum value that is not available in the current SDK version, changeType will return ChangeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from changeTypeAsString().

Returns:

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

See Also:

ChangeType

changeTypeAsString

public final String changeTypeAsString()

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

If the service returns an enum value that is not available in the current SDK version, changeType will return ChangeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from changeTypeAsString().

Returns:

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

See Also:

ChangeType

toBuilder

public Parameter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Parameter.Builder,Parameter>

builder

public static Parameter.Builder builder()

serializableBuilderClass

public static Class<? extends Parameter.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo