Parameter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.redshift.model.Parameter

All Implemented Interfaces:

Serializable, Cloneable
```
public class Parameter
extends Object
implements Serializable, Cloneable
```
Describes a parameter in a cluster parameter group.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Parameter()

Constructors
Constructor and Description
`Parameter()`

Method Summary

Methods
Modifier and Type	Method and Description
`Parameter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAllowedValues()` The valid range of values for the parameter.
`String`	`getApplyType()` Specifies how to apply the WLM configuration parameter.
`String`	`getDataType()` The data type of the parameter.
`String`	`getDescription()` A description of the parameter.
`Boolean`	`getIsModifiable()` If `true`, the parameter can be modified.
`String`	`getMinimumEngineVersion()` The earliest engine version to which the parameter can apply.
`String`	`getParameterName()` The name of the parameter.
`String`	`getParameterValue()` The value of the parameter.
`String`	`getSource()` The source of the parameter value, such as "engine-default" or "user".
`int`	`hashCode()`
`Boolean`	`isModifiable()` If `true`, the parameter can be modified.
`void`	`setAllowedValues(String allowedValues)` The valid range of values for the parameter.
`void`	`setApplyType(ParameterApplyType applyType)` Specifies how to apply the WLM configuration parameter.
`void`	`setApplyType(String applyType)` Specifies how to apply the WLM configuration parameter.
`void`	`setDataType(String dataType)` The data type of the parameter.
`void`	`setDescription(String description)` A description of the parameter.
`void`	`setIsModifiable(Boolean isModifiable)` If `true`, the parameter can be modified.
`void`	`setMinimumEngineVersion(String minimumEngineVersion)` The earliest engine version to which the parameter can apply.
`void`	`setParameterName(String parameterName)` The name of the parameter.
`void`	`setParameterValue(String parameterValue)` The value of the parameter.
`void`	`setSource(String source)` The source of the parameter value, such as "engine-default" or "user".
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Parameter`	`withAllowedValues(String allowedValues)` The valid range of values for the parameter.
`Parameter`	`withApplyType(ParameterApplyType applyType)` Specifies how to apply the WLM configuration parameter.
`Parameter`	`withApplyType(String applyType)` Specifies how to apply the WLM configuration parameter.
`Parameter`	`withDataType(String dataType)` The data type of the parameter.
`Parameter`	`withDescription(String description)` A description of the parameter.
`Parameter`	`withIsModifiable(Boolean isModifiable)` If `true`, the parameter can be modified.
`Parameter`	`withMinimumEngineVersion(String minimumEngineVersion)` The earliest engine version to which the parameter can apply.
`Parameter`	`withParameterName(String parameterName)` The name of the parameter.
`Parameter`	`withParameterValue(String parameterValue)` The value of the parameter.
`Parameter`	`withSource(String source)` The source of the parameter value, such as "engine-default" or "user".

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

- Constructor Detail
  - Parameter
```
public Parameter()
```
- Method Detail
  - getParameterName
```
public String getParameterName()
```
    The name of the parameter.
    
    Returns:
    The name of the parameter.
  - setParameterName
```
public void setParameterName(String parameterName)
```
    The name of the parameter.
    
    Parameters:
    parameterName - The name of the parameter.
  - withParameterName
```
public Parameter withParameterName(String parameterName)
```
    The name of the parameter.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    parameterName - The name of the parameter.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getParameterValue
```
public String getParameterValue()
```
    The value of the parameter.
    
    Returns:
    The value of the parameter.
  - setParameterValue
```
public void setParameterValue(String parameterValue)
```
    The value of the parameter.
    
    Parameters:
    parameterValue - The value of the parameter.
  - withParameterValue
```
public Parameter withParameterValue(String parameterValue)
```
    The value of the parameter.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    parameterValue - The value of the parameter.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    A description of the parameter.
    
    Returns:
    A description of the parameter.
  - setDescription
```
public void setDescription(String description)
```
    A description of the parameter.
    
    Parameters:
    description - A description of the parameter.
  - withDescription
```
public Parameter withDescription(String description)
```
    A description of the parameter.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    description - A description of the parameter.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSource
```
public String getSource()
```
    The source of the parameter value, such as "engine-default" or "user".
    
    Returns:
    The source of the parameter value, such as "engine-default" or "user".
  - setSource
```
public void setSource(String source)
```
    The source of the parameter value, such as "engine-default" or "user".
    
    Parameters:
    source - The source of the parameter value, such as "engine-default" or "user".
  - withSource
```
public Parameter withSource(String source)
```
    The source of the parameter value, such as "engine-default" or "user".
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    source - The source of the parameter value, such as "engine-default" or "user".
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDataType
```
public String getDataType()
```
    The data type of the parameter.
    
    Returns:
    The data type of the parameter.
  - setDataType
```
public void setDataType(String dataType)
```
    The data type of the parameter.
    
    Parameters:
    dataType - The data type of the parameter.
  - withDataType
```
public Parameter withDataType(String dataType)
```
    The data type of the parameter.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    dataType - The data type of the parameter.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAllowedValues
```
public String getAllowedValues()
```
    The valid range of values for the parameter.
    
    Returns:
    The valid range of values for the parameter.
  - setAllowedValues
```
public void setAllowedValues(String allowedValues)
```
    The valid range of values for the parameter.
    
    Parameters:
    allowedValues - The valid range of values for the parameter.
  - withAllowedValues
```
public Parameter withAllowedValues(String allowedValues)
```
    The valid range of values for the parameter.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    allowedValues - The valid range of values for the parameter.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getApplyType
```
public String getApplyType()
```
    Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    Constraints:
    Allowed Values: static, dynamic
    
    Returns:
    Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    See Also:
    ParameterApplyType
  - setApplyType
```
public void setApplyType(String applyType)
```
    Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    Constraints:
    Allowed Values: static, dynamic
    
    Parameters:
    applyType - Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    See Also:
    ParameterApplyType
  - withApplyType
```
public Parameter withApplyType(String applyType)
```
    Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: static, dynamic
    
    Parameters:
    applyType - Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    ParameterApplyType
  - setApplyType
```
public void setApplyType(ParameterApplyType applyType)
```
    Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    Constraints:
    Allowed Values: static, dynamic
    
    Parameters:
    applyType - Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    See Also:
    ParameterApplyType
  - withApplyType
```
public Parameter withApplyType(ParameterApplyType applyType)
```
    Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: static, dynamic
    
    Parameters:
    applyType - Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    ParameterApplyType
  - isModifiable
```
public Boolean isModifiable()
```
    If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
    
    Returns:
    If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
  - setIsModifiable
```
public void setIsModifiable(Boolean isModifiable)
```
    If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
    
    Parameters:
    isModifiable - If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
  - withIsModifiable
```
public Parameter withIsModifiable(Boolean isModifiable)
```
    If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    isModifiable - If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getIsModifiable
```
public Boolean getIsModifiable()
```
    If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
    
    Returns:
    If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
  - getMinimumEngineVersion
```
public String getMinimumEngineVersion()
```
    The earliest engine version to which the parameter can apply.
    
    Returns:
    The earliest engine version to which the parameter can apply.
  - setMinimumEngineVersion
```
public void setMinimumEngineVersion(String minimumEngineVersion)
```
    The earliest engine version to which the parameter can apply.
    
    Parameters:
    minimumEngineVersion - The earliest engine version to which the parameter can apply.
  - withMinimumEngineVersion
```
public Parameter withMinimumEngineVersion(String minimumEngineVersion)
```
    The earliest engine version to which the parameter can apply.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    minimumEngineVersion - The earliest engine version to which the parameter can apply.
    
    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
  - clone
```
public Parameter clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class Parameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Parameter

Method Detail

getParameterName

setParameterName

withParameterName

getParameterValue

setParameterValue

withParameterValue

getDescription

setDescription

withDescription

getSource

setSource

withSource

getDataType

setDataType

withDataType

getAllowedValues

setAllowedValues

withAllowedValues

getApplyType

setApplyType

withApplyType

setApplyType

withApplyType

isModifiable

setIsModifiable

withIsModifiable

getIsModifiable

getMinimumEngineVersion

setMinimumEngineVersion

withMinimumEngineVersion

toString

hashCode

equals

clone