AWS SDK for C++  1.8.155
AWS SDK for C++
Public Member Functions | List of all members
Aws::RDS::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::StringGetApplyType () const
 
bool ApplyTypeHasBeenSet () const
 
void SetApplyType (const Aws::String &value)
 
void SetApplyType (Aws::String &&value)
 
void SetApplyType (const char *value)
 
ParameterWithApplyType (const Aws::String &value)
 
ParameterWithApplyType (Aws::String &&value)
 
ParameterWithApplyType (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)
 
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)
 
const ApplyMethodGetApplyMethod () const
 
bool ApplyMethodHasBeenSet () const
 
void SetApplyMethod (const ApplyMethod &value)
 
void SetApplyMethod (ApplyMethod &&value)
 
ParameterWithApplyMethod (const ApplyMethod &value)
 
ParameterWithApplyMethod (ApplyMethod &&value)
 
const Aws::Vector< Aws::String > & GetSupportedEngineModes () const
 
bool SupportedEngineModesHasBeenSet () const
 
void SetSupportedEngineModes (const Aws::Vector< Aws::String > &value)
 
void SetSupportedEngineModes (Aws::Vector< Aws::String > &&value)
 
ParameterWithSupportedEngineModes (const Aws::Vector< Aws::String > &value)
 
ParameterWithSupportedEngineModes (Aws::Vector< Aws::String > &&value)
 
ParameterAddSupportedEngineModes (const Aws::String &value)
 
ParameterAddSupportedEngineModes (Aws::String &&value)
 
ParameterAddSupportedEngineModes (const char *value)
 

Detailed Description

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

See Also:

AWS API Reference

Definition at line 37 of file Parameter.h.

Constructor & Destructor Documentation

◆ Parameter() [1/2]

Aws::RDS::Model::Parameter::Parameter ( )

◆ Parameter() [2/2]

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

Member Function Documentation

◆ AddSupportedEngineModes() [1/3]

Parameter& Aws::RDS::Model::Parameter::AddSupportedEngineModes ( Aws::String &&  value)
inline

The valid DB engine modes.

Definition at line 474 of file Parameter.h.

◆ AddSupportedEngineModes() [2/3]

Parameter& Aws::RDS::Model::Parameter::AddSupportedEngineModes ( const Aws::String value)
inline

The valid DB engine modes.

Definition at line 469 of file Parameter.h.

◆ AddSupportedEngineModes() [3/3]

Parameter& Aws::RDS::Model::Parameter::AddSupportedEngineModes ( const char *  value)
inline

The valid DB engine modes.

Definition at line 479 of file Parameter.h.

◆ AllowedValuesHasBeenSet()

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

Specifies the valid range of values for the parameter.

Definition at line 302 of file Parameter.h.

◆ ApplyMethodHasBeenSet()

bool Aws::RDS::Model::Parameter::ApplyMethodHasBeenSet ( ) const
inline

Indicates when to apply parameter updates.

Definition at line 413 of file Parameter.h.

◆ ApplyTypeHasBeenSet()

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

Specifies the engine specific parameters type.

Definition at line 220 of file Parameter.h.

◆ DataTypeHasBeenSet()

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

Specifies the valid data type for the parameter.

Definition at line 261 of file Parameter.h.

◆ DescriptionHasBeenSet()

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

Provides a description of the parameter.

Definition at line 138 of file Parameter.h.

◆ GetAllowedValues()

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

Specifies the valid range of values for the parameter.

Definition at line 297 of file Parameter.h.

◆ GetApplyMethod()

const ApplyMethod& Aws::RDS::Model::Parameter::GetApplyMethod ( ) const
inline

Indicates when to apply parameter updates.

Definition at line 408 of file Parameter.h.

◆ GetApplyType()

const Aws::String& Aws::RDS::Model::Parameter::GetApplyType ( ) const
inline

Specifies the engine specific parameters type.

Definition at line 215 of file Parameter.h.

◆ GetDataType()

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

Specifies the valid data type for the parameter.

Definition at line 256 of file Parameter.h.

◆ GetDescription()

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

Provides a description of the parameter.

Definition at line 133 of file Parameter.h.

◆ GetIsModifiable()

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

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

Definition at line 340 of file Parameter.h.

◆ GetMinimumEngineVersion()

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

The earliest engine version to which the parameter can apply.

Definition at line 367 of file Parameter.h.

◆ GetParameterName()

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

Specifies the name of the parameter.

Definition at line 51 of file Parameter.h.

◆ GetParameterValue()

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

Specifies the value of the parameter.

Definition at line 92 of file Parameter.h.

◆ GetSource()

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

Indicates the source of the parameter value.

Definition at line 174 of file Parameter.h.

◆ GetSupportedEngineModes()

const Aws::Vector<Aws::String>& Aws::RDS::Model::Parameter::GetSupportedEngineModes ( ) const
inline

The valid DB engine modes.

Definition at line 439 of file Parameter.h.

◆ IsModifiableHasBeenSet()

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

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

Definition at line 347 of file Parameter.h.

◆ MinimumEngineVersionHasBeenSet()

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

The earliest engine version to which the parameter can apply.

Definition at line 372 of file Parameter.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ ParameterNameHasBeenSet()

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

Specifies the name of the parameter.

Definition at line 56 of file Parameter.h.

◆ ParameterValueHasBeenSet()

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

Specifies the value of the parameter.

Definition at line 97 of file Parameter.h.

◆ SetAllowedValues() [1/3]

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

Specifies the valid range of values for the parameter.

Definition at line 312 of file Parameter.h.

◆ SetAllowedValues() [2/3]

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

Specifies the valid range of values for the parameter.

Definition at line 307 of file Parameter.h.

◆ SetAllowedValues() [3/3]

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

Specifies the valid range of values for the parameter.

Definition at line 317 of file Parameter.h.

◆ SetApplyMethod() [1/2]

void Aws::RDS::Model::Parameter::SetApplyMethod ( ApplyMethod &&  value)
inline

Indicates when to apply parameter updates.

Definition at line 423 of file Parameter.h.

◆ SetApplyMethod() [2/2]

void Aws::RDS::Model::Parameter::SetApplyMethod ( const ApplyMethod value)
inline

Indicates when to apply parameter updates.

Definition at line 418 of file Parameter.h.

◆ SetApplyType() [1/3]

void Aws::RDS::Model::Parameter::SetApplyType ( Aws::String &&  value)
inline

Specifies the engine specific parameters type.

Definition at line 230 of file Parameter.h.

◆ SetApplyType() [2/3]

void Aws::RDS::Model::Parameter::SetApplyType ( const Aws::String value)
inline

Specifies the engine specific parameters type.

Definition at line 225 of file Parameter.h.

◆ SetApplyType() [3/3]

void Aws::RDS::Model::Parameter::SetApplyType ( const char *  value)
inline

Specifies the engine specific parameters type.

Definition at line 235 of file Parameter.h.

◆ SetDataType() [1/3]

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

Specifies the valid data type for the parameter.

Definition at line 271 of file Parameter.h.

◆ SetDataType() [2/3]

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

Specifies the valid data type for the parameter.

Definition at line 266 of file Parameter.h.

◆ SetDataType() [3/3]

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

Specifies the valid data type for the parameter.

Definition at line 276 of file Parameter.h.

◆ SetDescription() [1/3]

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

Provides a description of the parameter.

Definition at line 148 of file Parameter.h.

◆ SetDescription() [2/3]

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

Provides a description of the parameter.

Definition at line 143 of file Parameter.h.

◆ SetDescription() [3/3]

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

Provides a description of the parameter.

Definition at line 153 of file Parameter.h.

◆ SetIsModifiable()

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

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

Definition at line 354 of file Parameter.h.

◆ SetMinimumEngineVersion() [1/3]

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

The earliest engine version to which the parameter can apply.

Definition at line 382 of file Parameter.h.

◆ SetMinimumEngineVersion() [2/3]

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

The earliest engine version to which the parameter can apply.

Definition at line 377 of file Parameter.h.

◆ SetMinimumEngineVersion() [3/3]

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

The earliest engine version to which the parameter can apply.

Definition at line 387 of file Parameter.h.

◆ SetParameterName() [1/3]

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

Specifies the name of the parameter.

Definition at line 66 of file Parameter.h.

◆ SetParameterName() [2/3]

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

Specifies the name of the parameter.

Definition at line 61 of file Parameter.h.

◆ SetParameterName() [3/3]

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

Specifies the name of the parameter.

Definition at line 71 of file Parameter.h.

◆ SetParameterValue() [1/3]

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

Specifies the value of the parameter.

Definition at line 107 of file Parameter.h.

◆ SetParameterValue() [2/3]

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

Specifies the value of the parameter.

Definition at line 102 of file Parameter.h.

◆ SetParameterValue() [3/3]

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

Specifies the value of the parameter.

Definition at line 112 of file Parameter.h.

◆ SetSource() [1/3]

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

Indicates the source of the parameter value.

Definition at line 189 of file Parameter.h.

◆ SetSource() [2/3]

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

Indicates the source of the parameter value.

Definition at line 184 of file Parameter.h.

◆ SetSource() [3/3]

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

Indicates the source of the parameter value.

Definition at line 194 of file Parameter.h.

◆ SetSupportedEngineModes() [1/2]

void Aws::RDS::Model::Parameter::SetSupportedEngineModes ( Aws::Vector< Aws::String > &&  value)
inline

The valid DB engine modes.

Definition at line 454 of file Parameter.h.

◆ SetSupportedEngineModes() [2/2]

void Aws::RDS::Model::Parameter::SetSupportedEngineModes ( const Aws::Vector< Aws::String > &  value)
inline

The valid DB engine modes.

Definition at line 449 of file Parameter.h.

◆ SourceHasBeenSet()

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

Indicates the source of the parameter value.

Definition at line 179 of file Parameter.h.

◆ SupportedEngineModesHasBeenSet()

bool Aws::RDS::Model::Parameter::SupportedEngineModesHasBeenSet ( ) const
inline

The valid DB engine modes.

Definition at line 444 of file Parameter.h.

◆ WithAllowedValues() [1/3]

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

Specifies the valid range of values for the parameter.

Definition at line 327 of file Parameter.h.

◆ WithAllowedValues() [2/3]

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

Specifies the valid range of values for the parameter.

Definition at line 322 of file Parameter.h.

◆ WithAllowedValues() [3/3]

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

Specifies the valid range of values for the parameter.

Definition at line 332 of file Parameter.h.

◆ WithApplyMethod() [1/2]

Parameter& Aws::RDS::Model::Parameter::WithApplyMethod ( ApplyMethod &&  value)
inline

Indicates when to apply parameter updates.

Definition at line 433 of file Parameter.h.

◆ WithApplyMethod() [2/2]

Parameter& Aws::RDS::Model::Parameter::WithApplyMethod ( const ApplyMethod value)
inline

Indicates when to apply parameter updates.

Definition at line 428 of file Parameter.h.

◆ WithApplyType() [1/3]

Parameter& Aws::RDS::Model::Parameter::WithApplyType ( Aws::String &&  value)
inline

Specifies the engine specific parameters type.

Definition at line 245 of file Parameter.h.

◆ WithApplyType() [2/3]

Parameter& Aws::RDS::Model::Parameter::WithApplyType ( const Aws::String value)
inline

Specifies the engine specific parameters type.

Definition at line 240 of file Parameter.h.

◆ WithApplyType() [3/3]

Parameter& Aws::RDS::Model::Parameter::WithApplyType ( const char *  value)
inline

Specifies the engine specific parameters type.

Definition at line 250 of file Parameter.h.

◆ WithDataType() [1/3]

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

Specifies the valid data type for the parameter.

Definition at line 286 of file Parameter.h.

◆ WithDataType() [2/3]

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

Specifies the valid data type for the parameter.

Definition at line 281 of file Parameter.h.

◆ WithDataType() [3/3]

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

Specifies the valid data type for the parameter.

Definition at line 291 of file Parameter.h.

◆ WithDescription() [1/3]

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

Provides a description of the parameter.

Definition at line 163 of file Parameter.h.

◆ WithDescription() [2/3]

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

Provides a description of the parameter.

Definition at line 158 of file Parameter.h.

◆ WithDescription() [3/3]

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

Provides a description of the parameter.

Definition at line 168 of file Parameter.h.

◆ WithIsModifiable()

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

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

Definition at line 361 of file Parameter.h.

◆ WithMinimumEngineVersion() [1/3]

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

The earliest engine version to which the parameter can apply.

Definition at line 397 of file Parameter.h.

◆ WithMinimumEngineVersion() [2/3]

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

The earliest engine version to which the parameter can apply.

Definition at line 392 of file Parameter.h.

◆ WithMinimumEngineVersion() [3/3]

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

The earliest engine version to which the parameter can apply.

Definition at line 402 of file Parameter.h.

◆ WithParameterName() [1/3]

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

Specifies the name of the parameter.

Definition at line 81 of file Parameter.h.

◆ WithParameterName() [2/3]

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

Specifies the name of the parameter.

Definition at line 76 of file Parameter.h.

◆ WithParameterName() [3/3]

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

Specifies the name of the parameter.

Definition at line 86 of file Parameter.h.

◆ WithParameterValue() [1/3]

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

Specifies the value of the parameter.

Definition at line 122 of file Parameter.h.

◆ WithParameterValue() [2/3]

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

Specifies the value of the parameter.

Definition at line 117 of file Parameter.h.

◆ WithParameterValue() [3/3]

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

Specifies the value of the parameter.

Definition at line 127 of file Parameter.h.

◆ WithSource() [1/3]

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

Indicates the source of the parameter value.

Definition at line 204 of file Parameter.h.

◆ WithSource() [2/3]

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

Indicates the source of the parameter value.

Definition at line 199 of file Parameter.h.

◆ WithSource() [3/3]

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

Indicates the source of the parameter value.

Definition at line 209 of file Parameter.h.

◆ WithSupportedEngineModes() [1/2]

Parameter& Aws::RDS::Model::Parameter::WithSupportedEngineModes ( Aws::Vector< Aws::String > &&  value)
inline

The valid DB engine modes.

Definition at line 464 of file Parameter.h.

◆ WithSupportedEngineModes() [2/2]

Parameter& Aws::RDS::Model::Parameter::WithSupportedEngineModes ( const Aws::Vector< Aws::String > &  value)
inline

The valid DB engine modes.

Definition at line 459 of file Parameter.h.


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