AWS SDK for C++  1.9.129
AWS SDK for C++
Public Member Functions | List of all members
Aws::Redshift::Model::Parameter Class Reference

#include <Parameter.h>

Public Member Functions

 Parameter ()
 
 Parameter (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Parameteroperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetParameterName () const
 
bool ParameterNameHasBeenSet () const
 
void SetParameterName (const Aws::String &value)
 
void SetParameterName (Aws::String &&value)
 
void SetParameterName (const char *value)
 
ParameterWithParameterName (const Aws::String &value)
 
ParameterWithParameterName (Aws::String &&value)
 
ParameterWithParameterName (const char *value)
 
const Aws::StringGetParameterValue () const
 
bool ParameterValueHasBeenSet () const
 
void SetParameterValue (const Aws::String &value)
 
void SetParameterValue (Aws::String &&value)
 
void SetParameterValue (const char *value)
 
ParameterWithParameterValue (const Aws::String &value)
 
ParameterWithParameterValue (Aws::String &&value)
 
ParameterWithParameterValue (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
ParameterWithDescription (const Aws::String &value)
 
ParameterWithDescription (Aws::String &&value)
 
ParameterWithDescription (const char *value)
 
const Aws::StringGetSource () const
 
bool SourceHasBeenSet () const
 
void SetSource (const Aws::String &value)
 
void SetSource (Aws::String &&value)
 
void SetSource (const char *value)
 
ParameterWithSource (const Aws::String &value)
 
ParameterWithSource (Aws::String &&value)
 
ParameterWithSource (const char *value)
 
const Aws::StringGetDataType () const
 
bool DataTypeHasBeenSet () const
 
void SetDataType (const Aws::String &value)
 
void SetDataType (Aws::String &&value)
 
void SetDataType (const char *value)
 
ParameterWithDataType (const Aws::String &value)
 
ParameterWithDataType (Aws::String &&value)
 
ParameterWithDataType (const char *value)
 
const Aws::StringGetAllowedValues () const
 
bool AllowedValuesHasBeenSet () const
 
void SetAllowedValues (const Aws::String &value)
 
void SetAllowedValues (Aws::String &&value)
 
void SetAllowedValues (const char *value)
 
ParameterWithAllowedValues (const Aws::String &value)
 
ParameterWithAllowedValues (Aws::String &&value)
 
ParameterWithAllowedValues (const char *value)
 
const ParameterApplyTypeGetApplyType () const
 
bool ApplyTypeHasBeenSet () const
 
void SetApplyType (const ParameterApplyType &value)
 
void SetApplyType (ParameterApplyType &&value)
 
ParameterWithApplyType (const ParameterApplyType &value)
 
ParameterWithApplyType (ParameterApplyType &&value)
 
bool GetIsModifiable () const
 
bool IsModifiableHasBeenSet () const
 
void SetIsModifiable (bool value)
 
ParameterWithIsModifiable (bool value)
 
const Aws::StringGetMinimumEngineVersion () const
 
bool MinimumEngineVersionHasBeenSet () const
 
void SetMinimumEngineVersion (const Aws::String &value)
 
void SetMinimumEngineVersion (Aws::String &&value)
 
void SetMinimumEngineVersion (const char *value)
 
ParameterWithMinimumEngineVersion (const Aws::String &value)
 
ParameterWithMinimumEngineVersion (Aws::String &&value)
 
ParameterWithMinimumEngineVersion (const char *value)
 

Detailed Description

Describes a parameter in a cluster parameter group.

See Also:

AWS API Reference

Definition at line 33 of file Parameter.h.

Constructor & Destructor Documentation

◆ Parameter() [1/2]

Aws::Redshift::Model::Parameter::Parameter ( )

◆ Parameter() [2/2]

Aws::Redshift::Model::Parameter::Parameter ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AllowedValuesHasBeenSet()

bool Aws::Redshift::Model::Parameter::AllowedValuesHasBeenSet ( ) const
inline

The valid range of values for the parameter.

Definition at line 273 of file Parameter.h.

◆ ApplyTypeHasBeenSet()

bool Aws::Redshift::Model::Parameter::ApplyTypeHasBeenSet ( ) const
inline

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.

Definition at line 326 of file Parameter.h.

◆ DataTypeHasBeenSet()

bool Aws::Redshift::Model::Parameter::DataTypeHasBeenSet ( ) const
inline

The data type of the parameter.

Definition at line 232 of file Parameter.h.

◆ DescriptionHasBeenSet()

bool Aws::Redshift::Model::Parameter::DescriptionHasBeenSet ( ) const
inline

A description of the parameter.

Definition at line 150 of file Parameter.h.

◆ GetAllowedValues()

const Aws::String& Aws::Redshift::Model::Parameter::GetAllowedValues ( ) const
inline

The valid range of values for the parameter.

Definition at line 268 of file Parameter.h.

◆ GetApplyType()

const ParameterApplyType& Aws::Redshift::Model::Parameter::GetApplyType ( ) const
inline

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.

Definition at line 315 of file Parameter.h.

◆ GetDataType()

const Aws::String& Aws::Redshift::Model::Parameter::GetDataType ( ) const
inline

The data type of the parameter.

Definition at line 227 of file Parameter.h.

◆ GetDescription()

const Aws::String& Aws::Redshift::Model::Parameter::GetDescription ( ) const
inline

A description of the parameter.

Definition at line 145 of file Parameter.h.

◆ GetIsModifiable()

bool Aws::Redshift::Model::Parameter::GetIsModifiable ( ) const
inline

If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

Definition at line 377 of file Parameter.h.

◆ GetMinimumEngineVersion()

const Aws::String& Aws::Redshift::Model::Parameter::GetMinimumEngineVersion ( ) const
inline

The earliest engine version to which the parameter can apply.

Definition at line 401 of file Parameter.h.

◆ GetParameterName()

const Aws::String& Aws::Redshift::Model::Parameter::GetParameterName ( ) const
inline

The name of the parameter.

Definition at line 47 of file Parameter.h.

◆ GetParameterValue()

const Aws::String& Aws::Redshift::Model::Parameter::GetParameterValue ( ) const
inline

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

Definition at line 90 of file Parameter.h.

◆ GetSource()

const Aws::String& Aws::Redshift::Model::Parameter::GetSource ( ) const
inline

The source of the parameter value, such as "engine-default" or "user".

Definition at line 186 of file Parameter.h.

◆ IsModifiableHasBeenSet()

bool Aws::Redshift::Model::Parameter::IsModifiableHasBeenSet ( ) const
inline

If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

Definition at line 383 of file Parameter.h.

◆ MinimumEngineVersionHasBeenSet()

bool Aws::Redshift::Model::Parameter::MinimumEngineVersionHasBeenSet ( ) const
inline

The earliest engine version to which the parameter can apply.

Definition at line 406 of file Parameter.h.

◆ operator=()

Parameter& Aws::Redshift::Model::Parameter::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::Redshift::Model::Parameter::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::Redshift::Model::Parameter::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ ParameterNameHasBeenSet()

bool Aws::Redshift::Model::Parameter::ParameterNameHasBeenSet ( ) const
inline

The name of the parameter.

Definition at line 52 of file Parameter.h.

◆ ParameterValueHasBeenSet()

bool Aws::Redshift::Model::Parameter::ParameterValueHasBeenSet ( ) const
inline

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

Definition at line 97 of file Parameter.h.

◆ SetAllowedValues() [1/3]

void Aws::Redshift::Model::Parameter::SetAllowedValues ( Aws::String &&  value)
inline

The valid range of values for the parameter.

Definition at line 283 of file Parameter.h.

◆ SetAllowedValues() [2/3]

void Aws::Redshift::Model::Parameter::SetAllowedValues ( const Aws::String value)
inline

The valid range of values for the parameter.

Definition at line 278 of file Parameter.h.

◆ SetAllowedValues() [3/3]

void Aws::Redshift::Model::Parameter::SetAllowedValues ( const char *  value)
inline

The valid range of values for the parameter.

Definition at line 288 of file Parameter.h.

◆ SetApplyType() [1/2]

void Aws::Redshift::Model::Parameter::SetApplyType ( const ParameterApplyType value)
inline

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.

Definition at line 337 of file Parameter.h.

◆ SetApplyType() [2/2]

void Aws::Redshift::Model::Parameter::SetApplyType ( ParameterApplyType &&  value)
inline

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.

Definition at line 348 of file Parameter.h.

◆ SetDataType() [1/3]

void Aws::Redshift::Model::Parameter::SetDataType ( Aws::String &&  value)
inline

The data type of the parameter.

Definition at line 242 of file Parameter.h.

◆ SetDataType() [2/3]

void Aws::Redshift::Model::Parameter::SetDataType ( const Aws::String value)
inline

The data type of the parameter.

Definition at line 237 of file Parameter.h.

◆ SetDataType() [3/3]

void Aws::Redshift::Model::Parameter::SetDataType ( const char *  value)
inline

The data type of the parameter.

Definition at line 247 of file Parameter.h.

◆ SetDescription() [1/3]

void Aws::Redshift::Model::Parameter::SetDescription ( Aws::String &&  value)
inline

A description of the parameter.

Definition at line 160 of file Parameter.h.

◆ SetDescription() [2/3]

void Aws::Redshift::Model::Parameter::SetDescription ( const Aws::String value)
inline

A description of the parameter.

Definition at line 155 of file Parameter.h.

◆ SetDescription() [3/3]

void Aws::Redshift::Model::Parameter::SetDescription ( const char *  value)
inline

A description of the parameter.

Definition at line 165 of file Parameter.h.

◆ SetIsModifiable()

void Aws::Redshift::Model::Parameter::SetIsModifiable ( bool  value)
inline

If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

Definition at line 389 of file Parameter.h.

◆ SetMinimumEngineVersion() [1/3]

void Aws::Redshift::Model::Parameter::SetMinimumEngineVersion ( Aws::String &&  value)
inline

The earliest engine version to which the parameter can apply.

Definition at line 416 of file Parameter.h.

◆ SetMinimumEngineVersion() [2/3]

void Aws::Redshift::Model::Parameter::SetMinimumEngineVersion ( const Aws::String value)
inline

The earliest engine version to which the parameter can apply.

Definition at line 411 of file Parameter.h.

◆ SetMinimumEngineVersion() [3/3]

void Aws::Redshift::Model::Parameter::SetMinimumEngineVersion ( const char *  value)
inline

The earliest engine version to which the parameter can apply.

Definition at line 421 of file Parameter.h.

◆ SetParameterName() [1/3]

void Aws::Redshift::Model::Parameter::SetParameterName ( Aws::String &&  value)
inline

The name of the parameter.

Definition at line 62 of file Parameter.h.

◆ SetParameterName() [2/3]

void Aws::Redshift::Model::Parameter::SetParameterName ( const Aws::String value)
inline

The name of the parameter.

Definition at line 57 of file Parameter.h.

◆ SetParameterName() [3/3]

void Aws::Redshift::Model::Parameter::SetParameterName ( const char *  value)
inline

The name of the parameter.

Definition at line 67 of file Parameter.h.

◆ SetParameterValue() [1/3]

void Aws::Redshift::Model::Parameter::SetParameterValue ( Aws::String &&  value)
inline

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

Definition at line 111 of file Parameter.h.

◆ SetParameterValue() [2/3]

void Aws::Redshift::Model::Parameter::SetParameterValue ( const Aws::String value)
inline

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

Definition at line 104 of file Parameter.h.

◆ SetParameterValue() [3/3]

void Aws::Redshift::Model::Parameter::SetParameterValue ( const char *  value)
inline

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

Definition at line 118 of file Parameter.h.

◆ SetSource() [1/3]

void Aws::Redshift::Model::Parameter::SetSource ( Aws::String &&  value)
inline

The source of the parameter value, such as "engine-default" or "user".

Definition at line 201 of file Parameter.h.

◆ SetSource() [2/3]

void Aws::Redshift::Model::Parameter::SetSource ( const Aws::String value)
inline

The source of the parameter value, such as "engine-default" or "user".

Definition at line 196 of file Parameter.h.

◆ SetSource() [3/3]

void Aws::Redshift::Model::Parameter::SetSource ( const char *  value)
inline

The source of the parameter value, such as "engine-default" or "user".

Definition at line 206 of file Parameter.h.

◆ SourceHasBeenSet()

bool Aws::Redshift::Model::Parameter::SourceHasBeenSet ( ) const
inline

The source of the parameter value, such as "engine-default" or "user".

Definition at line 191 of file Parameter.h.

◆ WithAllowedValues() [1/3]

Parameter& Aws::Redshift::Model::Parameter::WithAllowedValues ( Aws::String &&  value)
inline

The valid range of values for the parameter.

Definition at line 298 of file Parameter.h.

◆ WithAllowedValues() [2/3]

Parameter& Aws::Redshift::Model::Parameter::WithAllowedValues ( const Aws::String value)
inline

The valid range of values for the parameter.

Definition at line 293 of file Parameter.h.

◆ WithAllowedValues() [3/3]

Parameter& Aws::Redshift::Model::Parameter::WithAllowedValues ( const char *  value)
inline

The valid range of values for the parameter.

Definition at line 303 of file Parameter.h.

◆ WithApplyType() [1/2]

Parameter& Aws::Redshift::Model::Parameter::WithApplyType ( const ParameterApplyType value)
inline

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.

Definition at line 359 of file Parameter.h.

◆ WithApplyType() [2/2]

Parameter& Aws::Redshift::Model::Parameter::WithApplyType ( ParameterApplyType &&  value)
inline

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.

Definition at line 370 of file Parameter.h.

◆ WithDataType() [1/3]

Parameter& Aws::Redshift::Model::Parameter::WithDataType ( Aws::String &&  value)
inline

The data type of the parameter.

Definition at line 257 of file Parameter.h.

◆ WithDataType() [2/3]

Parameter& Aws::Redshift::Model::Parameter::WithDataType ( const Aws::String value)
inline

The data type of the parameter.

Definition at line 252 of file Parameter.h.

◆ WithDataType() [3/3]

Parameter& Aws::Redshift::Model::Parameter::WithDataType ( const char *  value)
inline

The data type of the parameter.

Definition at line 262 of file Parameter.h.

◆ WithDescription() [1/3]

Parameter& Aws::Redshift::Model::Parameter::WithDescription ( Aws::String &&  value)
inline

A description of the parameter.

Definition at line 175 of file Parameter.h.

◆ WithDescription() [2/3]

Parameter& Aws::Redshift::Model::Parameter::WithDescription ( const Aws::String value)
inline

A description of the parameter.

Definition at line 170 of file Parameter.h.

◆ WithDescription() [3/3]

Parameter& Aws::Redshift::Model::Parameter::WithDescription ( const char *  value)
inline

A description of the parameter.

Definition at line 180 of file Parameter.h.

◆ WithIsModifiable()

Parameter& Aws::Redshift::Model::Parameter::WithIsModifiable ( bool  value)
inline

If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

Definition at line 395 of file Parameter.h.

◆ WithMinimumEngineVersion() [1/3]

Parameter& Aws::Redshift::Model::Parameter::WithMinimumEngineVersion ( Aws::String &&  value)
inline

The earliest engine version to which the parameter can apply.

Definition at line 431 of file Parameter.h.

◆ WithMinimumEngineVersion() [2/3]

Parameter& Aws::Redshift::Model::Parameter::WithMinimumEngineVersion ( const Aws::String value)
inline

The earliest engine version to which the parameter can apply.

Definition at line 426 of file Parameter.h.

◆ WithMinimumEngineVersion() [3/3]

Parameter& Aws::Redshift::Model::Parameter::WithMinimumEngineVersion ( const char *  value)
inline

The earliest engine version to which the parameter can apply.

Definition at line 436 of file Parameter.h.

◆ WithParameterName() [1/3]

Parameter& Aws::Redshift::Model::Parameter::WithParameterName ( Aws::String &&  value)
inline

The name of the parameter.

Definition at line 77 of file Parameter.h.

◆ WithParameterName() [2/3]

Parameter& Aws::Redshift::Model::Parameter::WithParameterName ( const Aws::String value)
inline

The name of the parameter.

Definition at line 72 of file Parameter.h.

◆ WithParameterName() [3/3]

Parameter& Aws::Redshift::Model::Parameter::WithParameterName ( const char *  value)
inline

The name of the parameter.

Definition at line 82 of file Parameter.h.

◆ WithParameterValue() [1/3]

Parameter& Aws::Redshift::Model::Parameter::WithParameterValue ( Aws::String &&  value)
inline

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

Definition at line 132 of file Parameter.h.

◆ WithParameterValue() [2/3]

Parameter& Aws::Redshift::Model::Parameter::WithParameterValue ( const Aws::String value)
inline

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

Definition at line 125 of file Parameter.h.

◆ WithParameterValue() [3/3]

Parameter& Aws::Redshift::Model::Parameter::WithParameterValue ( const char *  value)
inline

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

Definition at line 139 of file Parameter.h.

◆ WithSource() [1/3]

Parameter& Aws::Redshift::Model::Parameter::WithSource ( Aws::String &&  value)
inline

The source of the parameter value, such as "engine-default" or "user".

Definition at line 216 of file Parameter.h.

◆ WithSource() [2/3]

Parameter& Aws::Redshift::Model::Parameter::WithSource ( const Aws::String value)
inline

The source of the parameter value, such as "engine-default" or "user".

Definition at line 211 of file Parameter.h.

◆ WithSource() [3/3]

Parameter& Aws::Redshift::Model::Parameter::WithSource ( const char *  value)
inline

The source of the parameter value, such as "engine-default" or "user".

Definition at line 221 of file Parameter.h.


The documentation for this class was generated from the following file: