466 lines
16 KiB
C++
466 lines
16 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/docdb/DocDB_EXPORTS.h>
|
|
#include <aws/core/utils/memory/stl/AWSStreamFwd.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/docdb/model/ApplyMethod.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Xml
|
|
{
|
|
class XmlNode;
|
|
} // namespace Xml
|
|
} // namespace Utils
|
|
namespace DocDB
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Detailed information about an individual parameter.</p><p><h3>See Also:</h3>
|
|
* <a href="http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Parameter">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_DOCDB_API Parameter
|
|
{
|
|
public:
|
|
Parameter();
|
|
Parameter(const Aws::Utils::Xml::XmlNode& xmlNode);
|
|
Parameter& operator=(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;
|
|
|
|
|
|
/**
|
|
* <p>Specifies the name of the parameter.</p>
|
|
*/
|
|
inline const Aws::String& GetParameterName() const{ return m_parameterName; }
|
|
|
|
/**
|
|
* <p>Specifies the name of the parameter.</p>
|
|
*/
|
|
inline bool ParameterNameHasBeenSet() const { return m_parameterNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Specifies the name of the parameter.</p>
|
|
*/
|
|
inline void SetParameterName(const Aws::String& value) { m_parameterNameHasBeenSet = true; m_parameterName = value; }
|
|
|
|
/**
|
|
* <p>Specifies the name of the parameter.</p>
|
|
*/
|
|
inline void SetParameterName(Aws::String&& value) { m_parameterNameHasBeenSet = true; m_parameterName = std::move(value); }
|
|
|
|
/**
|
|
* <p>Specifies the name of the parameter.</p>
|
|
*/
|
|
inline void SetParameterName(const char* value) { m_parameterNameHasBeenSet = true; m_parameterName.assign(value); }
|
|
|
|
/**
|
|
* <p>Specifies the name of the parameter.</p>
|
|
*/
|
|
inline Parameter& WithParameterName(const Aws::String& value) { SetParameterName(value); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the name of the parameter.</p>
|
|
*/
|
|
inline Parameter& WithParameterName(Aws::String&& value) { SetParameterName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the name of the parameter.</p>
|
|
*/
|
|
inline Parameter& WithParameterName(const char* value) { SetParameterName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Specifies the value of the parameter.</p>
|
|
*/
|
|
inline const Aws::String& GetParameterValue() const{ return m_parameterValue; }
|
|
|
|
/**
|
|
* <p>Specifies the value of the parameter.</p>
|
|
*/
|
|
inline bool ParameterValueHasBeenSet() const { return m_parameterValueHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Specifies the value of the parameter.</p>
|
|
*/
|
|
inline void SetParameterValue(const Aws::String& value) { m_parameterValueHasBeenSet = true; m_parameterValue = value; }
|
|
|
|
/**
|
|
* <p>Specifies the value of the parameter.</p>
|
|
*/
|
|
inline void SetParameterValue(Aws::String&& value) { m_parameterValueHasBeenSet = true; m_parameterValue = std::move(value); }
|
|
|
|
/**
|
|
* <p>Specifies the value of the parameter.</p>
|
|
*/
|
|
inline void SetParameterValue(const char* value) { m_parameterValueHasBeenSet = true; m_parameterValue.assign(value); }
|
|
|
|
/**
|
|
* <p>Specifies the value of the parameter.</p>
|
|
*/
|
|
inline Parameter& WithParameterValue(const Aws::String& value) { SetParameterValue(value); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the value of the parameter.</p>
|
|
*/
|
|
inline Parameter& WithParameterValue(Aws::String&& value) { SetParameterValue(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the value of the parameter.</p>
|
|
*/
|
|
inline Parameter& WithParameterValue(const char* value) { SetParameterValue(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Provides a description of the parameter.</p>
|
|
*/
|
|
inline const Aws::String& GetDescription() const{ return m_description; }
|
|
|
|
/**
|
|
* <p>Provides a description of the parameter.</p>
|
|
*/
|
|
inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Provides a description of the parameter.</p>
|
|
*/
|
|
inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
|
|
|
|
/**
|
|
* <p>Provides a description of the parameter.</p>
|
|
*/
|
|
inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
|
|
|
|
/**
|
|
* <p>Provides a description of the parameter.</p>
|
|
*/
|
|
inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
|
|
|
|
/**
|
|
* <p>Provides a description of the parameter.</p>
|
|
*/
|
|
inline Parameter& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
|
|
|
|
/**
|
|
* <p>Provides a description of the parameter.</p>
|
|
*/
|
|
inline Parameter& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Provides a description of the parameter.</p>
|
|
*/
|
|
inline Parameter& WithDescription(const char* value) { SetDescription(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Indicates the source of the parameter value.</p>
|
|
*/
|
|
inline const Aws::String& GetSource() const{ return m_source; }
|
|
|
|
/**
|
|
* <p>Indicates the source of the parameter value.</p>
|
|
*/
|
|
inline bool SourceHasBeenSet() const { return m_sourceHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Indicates the source of the parameter value.</p>
|
|
*/
|
|
inline void SetSource(const Aws::String& value) { m_sourceHasBeenSet = true; m_source = value; }
|
|
|
|
/**
|
|
* <p>Indicates the source of the parameter value.</p>
|
|
*/
|
|
inline void SetSource(Aws::String&& value) { m_sourceHasBeenSet = true; m_source = std::move(value); }
|
|
|
|
/**
|
|
* <p>Indicates the source of the parameter value.</p>
|
|
*/
|
|
inline void SetSource(const char* value) { m_sourceHasBeenSet = true; m_source.assign(value); }
|
|
|
|
/**
|
|
* <p>Indicates the source of the parameter value.</p>
|
|
*/
|
|
inline Parameter& WithSource(const Aws::String& value) { SetSource(value); return *this;}
|
|
|
|
/**
|
|
* <p>Indicates the source of the parameter value.</p>
|
|
*/
|
|
inline Parameter& WithSource(Aws::String&& value) { SetSource(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Indicates the source of the parameter value.</p>
|
|
*/
|
|
inline Parameter& WithSource(const char* value) { SetSource(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Specifies the engine-specific parameters type.</p>
|
|
*/
|
|
inline const Aws::String& GetApplyType() const{ return m_applyType; }
|
|
|
|
/**
|
|
* <p>Specifies the engine-specific parameters type.</p>
|
|
*/
|
|
inline bool ApplyTypeHasBeenSet() const { return m_applyTypeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Specifies the engine-specific parameters type.</p>
|
|
*/
|
|
inline void SetApplyType(const Aws::String& value) { m_applyTypeHasBeenSet = true; m_applyType = value; }
|
|
|
|
/**
|
|
* <p>Specifies the engine-specific parameters type.</p>
|
|
*/
|
|
inline void SetApplyType(Aws::String&& value) { m_applyTypeHasBeenSet = true; m_applyType = std::move(value); }
|
|
|
|
/**
|
|
* <p>Specifies the engine-specific parameters type.</p>
|
|
*/
|
|
inline void SetApplyType(const char* value) { m_applyTypeHasBeenSet = true; m_applyType.assign(value); }
|
|
|
|
/**
|
|
* <p>Specifies the engine-specific parameters type.</p>
|
|
*/
|
|
inline Parameter& WithApplyType(const Aws::String& value) { SetApplyType(value); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the engine-specific parameters type.</p>
|
|
*/
|
|
inline Parameter& WithApplyType(Aws::String&& value) { SetApplyType(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the engine-specific parameters type.</p>
|
|
*/
|
|
inline Parameter& WithApplyType(const char* value) { SetApplyType(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Specifies the valid data type for the parameter.</p>
|
|
*/
|
|
inline const Aws::String& GetDataType() const{ return m_dataType; }
|
|
|
|
/**
|
|
* <p>Specifies the valid data type for the parameter.</p>
|
|
*/
|
|
inline bool DataTypeHasBeenSet() const { return m_dataTypeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Specifies the valid data type for the parameter.</p>
|
|
*/
|
|
inline void SetDataType(const Aws::String& value) { m_dataTypeHasBeenSet = true; m_dataType = value; }
|
|
|
|
/**
|
|
* <p>Specifies the valid data type for the parameter.</p>
|
|
*/
|
|
inline void SetDataType(Aws::String&& value) { m_dataTypeHasBeenSet = true; m_dataType = std::move(value); }
|
|
|
|
/**
|
|
* <p>Specifies the valid data type for the parameter.</p>
|
|
*/
|
|
inline void SetDataType(const char* value) { m_dataTypeHasBeenSet = true; m_dataType.assign(value); }
|
|
|
|
/**
|
|
* <p>Specifies the valid data type for the parameter.</p>
|
|
*/
|
|
inline Parameter& WithDataType(const Aws::String& value) { SetDataType(value); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the valid data type for the parameter.</p>
|
|
*/
|
|
inline Parameter& WithDataType(Aws::String&& value) { SetDataType(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the valid data type for the parameter.</p>
|
|
*/
|
|
inline Parameter& WithDataType(const char* value) { SetDataType(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Specifies the valid range of values for the parameter.</p>
|
|
*/
|
|
inline const Aws::String& GetAllowedValues() const{ return m_allowedValues; }
|
|
|
|
/**
|
|
* <p>Specifies the valid range of values for the parameter.</p>
|
|
*/
|
|
inline bool AllowedValuesHasBeenSet() const { return m_allowedValuesHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Specifies the valid range of values for the parameter.</p>
|
|
*/
|
|
inline void SetAllowedValues(const Aws::String& value) { m_allowedValuesHasBeenSet = true; m_allowedValues = value; }
|
|
|
|
/**
|
|
* <p>Specifies the valid range of values for the parameter.</p>
|
|
*/
|
|
inline void SetAllowedValues(Aws::String&& value) { m_allowedValuesHasBeenSet = true; m_allowedValues = std::move(value); }
|
|
|
|
/**
|
|
* <p>Specifies the valid range of values for the parameter.</p>
|
|
*/
|
|
inline void SetAllowedValues(const char* value) { m_allowedValuesHasBeenSet = true; m_allowedValues.assign(value); }
|
|
|
|
/**
|
|
* <p>Specifies the valid range of values for the parameter.</p>
|
|
*/
|
|
inline Parameter& WithAllowedValues(const Aws::String& value) { SetAllowedValues(value); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the valid range of values for the parameter.</p>
|
|
*/
|
|
inline Parameter& WithAllowedValues(Aws::String&& value) { SetAllowedValues(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies the valid range of values for the parameter.</p>
|
|
*/
|
|
inline Parameter& WithAllowedValues(const char* value) { SetAllowedValues(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p> Indicates whether (<code>true</code>) or not (<code>false</code>) the
|
|
* parameter can be modified. Some parameters have security or operational
|
|
* implications that prevent them from being changed. </p>
|
|
*/
|
|
inline bool GetIsModifiable() const{ return m_isModifiable; }
|
|
|
|
/**
|
|
* <p> Indicates whether (<code>true</code>) or not (<code>false</code>) the
|
|
* parameter can be modified. Some parameters have security or operational
|
|
* implications that prevent them from being changed. </p>
|
|
*/
|
|
inline bool IsModifiableHasBeenSet() const { return m_isModifiableHasBeenSet; }
|
|
|
|
/**
|
|
* <p> Indicates whether (<code>true</code>) or not (<code>false</code>) the
|
|
* parameter can be modified. Some parameters have security or operational
|
|
* implications that prevent them from being changed. </p>
|
|
*/
|
|
inline void SetIsModifiable(bool value) { m_isModifiableHasBeenSet = true; m_isModifiable = value; }
|
|
|
|
/**
|
|
* <p> Indicates whether (<code>true</code>) or not (<code>false</code>) the
|
|
* parameter can be modified. Some parameters have security or operational
|
|
* implications that prevent them from being changed. </p>
|
|
*/
|
|
inline Parameter& WithIsModifiable(bool value) { SetIsModifiable(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The earliest engine version to which the parameter can apply.</p>
|
|
*/
|
|
inline const Aws::String& GetMinimumEngineVersion() const{ return m_minimumEngineVersion; }
|
|
|
|
/**
|
|
* <p>The earliest engine version to which the parameter can apply.</p>
|
|
*/
|
|
inline bool MinimumEngineVersionHasBeenSet() const { return m_minimumEngineVersionHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The earliest engine version to which the parameter can apply.</p>
|
|
*/
|
|
inline void SetMinimumEngineVersion(const Aws::String& value) { m_minimumEngineVersionHasBeenSet = true; m_minimumEngineVersion = value; }
|
|
|
|
/**
|
|
* <p>The earliest engine version to which the parameter can apply.</p>
|
|
*/
|
|
inline void SetMinimumEngineVersion(Aws::String&& value) { m_minimumEngineVersionHasBeenSet = true; m_minimumEngineVersion = std::move(value); }
|
|
|
|
/**
|
|
* <p>The earliest engine version to which the parameter can apply.</p>
|
|
*/
|
|
inline void SetMinimumEngineVersion(const char* value) { m_minimumEngineVersionHasBeenSet = true; m_minimumEngineVersion.assign(value); }
|
|
|
|
/**
|
|
* <p>The earliest engine version to which the parameter can apply.</p>
|
|
*/
|
|
inline Parameter& WithMinimumEngineVersion(const Aws::String& value) { SetMinimumEngineVersion(value); return *this;}
|
|
|
|
/**
|
|
* <p>The earliest engine version to which the parameter can apply.</p>
|
|
*/
|
|
inline Parameter& WithMinimumEngineVersion(Aws::String&& value) { SetMinimumEngineVersion(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The earliest engine version to which the parameter can apply.</p>
|
|
*/
|
|
inline Parameter& WithMinimumEngineVersion(const char* value) { SetMinimumEngineVersion(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Indicates when to apply parameter updates.</p>
|
|
*/
|
|
inline const ApplyMethod& GetApplyMethod() const{ return m_applyMethod; }
|
|
|
|
/**
|
|
* <p>Indicates when to apply parameter updates.</p>
|
|
*/
|
|
inline bool ApplyMethodHasBeenSet() const { return m_applyMethodHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Indicates when to apply parameter updates.</p>
|
|
*/
|
|
inline void SetApplyMethod(const ApplyMethod& value) { m_applyMethodHasBeenSet = true; m_applyMethod = value; }
|
|
|
|
/**
|
|
* <p>Indicates when to apply parameter updates.</p>
|
|
*/
|
|
inline void SetApplyMethod(ApplyMethod&& value) { m_applyMethodHasBeenSet = true; m_applyMethod = std::move(value); }
|
|
|
|
/**
|
|
* <p>Indicates when to apply parameter updates.</p>
|
|
*/
|
|
inline Parameter& WithApplyMethod(const ApplyMethod& value) { SetApplyMethod(value); return *this;}
|
|
|
|
/**
|
|
* <p>Indicates when to apply parameter updates.</p>
|
|
*/
|
|
inline Parameter& WithApplyMethod(ApplyMethod&& value) { SetApplyMethod(std::move(value)); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_parameterName;
|
|
bool m_parameterNameHasBeenSet;
|
|
|
|
Aws::String m_parameterValue;
|
|
bool m_parameterValueHasBeenSet;
|
|
|
|
Aws::String m_description;
|
|
bool m_descriptionHasBeenSet;
|
|
|
|
Aws::String m_source;
|
|
bool m_sourceHasBeenSet;
|
|
|
|
Aws::String m_applyType;
|
|
bool m_applyTypeHasBeenSet;
|
|
|
|
Aws::String m_dataType;
|
|
bool m_dataTypeHasBeenSet;
|
|
|
|
Aws::String m_allowedValues;
|
|
bool m_allowedValuesHasBeenSet;
|
|
|
|
bool m_isModifiable;
|
|
bool m_isModifiableHasBeenSet;
|
|
|
|
Aws::String m_minimumEngineVersion;
|
|
bool m_minimumEngineVersionHasBeenSet;
|
|
|
|
ApplyMethod m_applyMethod;
|
|
bool m_applyMethodHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace DocDB
|
|
} // namespace Aws
|