/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace ElasticBeanstalk { namespace Model { /** *

Describes the possible values for a configuration option.

See * Also:

AWS * API Reference

*/ class ConfigurationOptionDescription { public: AWS_ELASTICBEANSTALK_API ConfigurationOptionDescription(); AWS_ELASTICBEANSTALK_API ConfigurationOptionDescription(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_ELASTICBEANSTALK_API ConfigurationOptionDescription& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_ELASTICBEANSTALK_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; AWS_ELASTICBEANSTALK_API void OutputToStream(Aws::OStream& oStream, const char* location) const; /** *

A unique namespace identifying the option's associated AWS resource.

*/ inline const Aws::String& GetNamespace() const{ return m_namespace; } /** *

A unique namespace identifying the option's associated AWS resource.

*/ inline bool NamespaceHasBeenSet() const { return m_namespaceHasBeenSet; } /** *

A unique namespace identifying the option's associated AWS resource.

*/ inline void SetNamespace(const Aws::String& value) { m_namespaceHasBeenSet = true; m_namespace = value; } /** *

A unique namespace identifying the option's associated AWS resource.

*/ inline void SetNamespace(Aws::String&& value) { m_namespaceHasBeenSet = true; m_namespace = std::move(value); } /** *

A unique namespace identifying the option's associated AWS resource.

*/ inline void SetNamespace(const char* value) { m_namespaceHasBeenSet = true; m_namespace.assign(value); } /** *

A unique namespace identifying the option's associated AWS resource.

*/ inline ConfigurationOptionDescription& WithNamespace(const Aws::String& value) { SetNamespace(value); return *this;} /** *

A unique namespace identifying the option's associated AWS resource.

*/ inline ConfigurationOptionDescription& WithNamespace(Aws::String&& value) { SetNamespace(std::move(value)); return *this;} /** *

A unique namespace identifying the option's associated AWS resource.

*/ inline ConfigurationOptionDescription& WithNamespace(const char* value) { SetNamespace(value); return *this;} /** *

The name of the configuration option.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the configuration option.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the configuration option.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the configuration option.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the configuration option.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the configuration option.

*/ inline ConfigurationOptionDescription& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the configuration option.

*/ inline ConfigurationOptionDescription& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the configuration option.

*/ inline ConfigurationOptionDescription& WithName(const char* value) { SetName(value); return *this;} /** *

The default value for this configuration option.

*/ inline const Aws::String& GetDefaultValue() const{ return m_defaultValue; } /** *

The default value for this configuration option.

*/ inline bool DefaultValueHasBeenSet() const { return m_defaultValueHasBeenSet; } /** *

The default value for this configuration option.

*/ inline void SetDefaultValue(const Aws::String& value) { m_defaultValueHasBeenSet = true; m_defaultValue = value; } /** *

The default value for this configuration option.

*/ inline void SetDefaultValue(Aws::String&& value) { m_defaultValueHasBeenSet = true; m_defaultValue = std::move(value); } /** *

The default value for this configuration option.

*/ inline void SetDefaultValue(const char* value) { m_defaultValueHasBeenSet = true; m_defaultValue.assign(value); } /** *

The default value for this configuration option.

*/ inline ConfigurationOptionDescription& WithDefaultValue(const Aws::String& value) { SetDefaultValue(value); return *this;} /** *

The default value for this configuration option.

*/ inline ConfigurationOptionDescription& WithDefaultValue(Aws::String&& value) { SetDefaultValue(std::move(value)); return *this;} /** *

The default value for this configuration option.

*/ inline ConfigurationOptionDescription& WithDefaultValue(const char* value) { SetDefaultValue(value); return *this;} /** *

An indication of which action is required if the value for this configuration * option changes:

  • NoInterruption : There is no * interruption to the environment or application availability.

  • * RestartEnvironment : The environment is entirely restarted, all AWS * resources are deleted and recreated, and the environment is unavailable during * the process.

  • RestartApplicationServer : The * environment is available the entire time. However, a short application outage * occurs when the application servers on the running Amazon EC2 instances are * restarted.

*/ inline const Aws::String& GetChangeSeverity() const{ return m_changeSeverity; } /** *

An indication of which action is required if the value for this configuration * option changes:

  • NoInterruption : There is no * interruption to the environment or application availability.

  • * RestartEnvironment : The environment is entirely restarted, all AWS * resources are deleted and recreated, and the environment is unavailable during * the process.

  • RestartApplicationServer : The * environment is available the entire time. However, a short application outage * occurs when the application servers on the running Amazon EC2 instances are * restarted.

*/ inline bool ChangeSeverityHasBeenSet() const { return m_changeSeverityHasBeenSet; } /** *

An indication of which action is required if the value for this configuration * option changes:

  • NoInterruption : There is no * interruption to the environment or application availability.

  • * RestartEnvironment : The environment is entirely restarted, all AWS * resources are deleted and recreated, and the environment is unavailable during * the process.

  • RestartApplicationServer : The * environment is available the entire time. However, a short application outage * occurs when the application servers on the running Amazon EC2 instances are * restarted.

*/ inline void SetChangeSeverity(const Aws::String& value) { m_changeSeverityHasBeenSet = true; m_changeSeverity = value; } /** *

An indication of which action is required if the value for this configuration * option changes:

  • NoInterruption : There is no * interruption to the environment or application availability.

  • * RestartEnvironment : The environment is entirely restarted, all AWS * resources are deleted and recreated, and the environment is unavailable during * the process.

  • RestartApplicationServer : The * environment is available the entire time. However, a short application outage * occurs when the application servers on the running Amazon EC2 instances are * restarted.

*/ inline void SetChangeSeverity(Aws::String&& value) { m_changeSeverityHasBeenSet = true; m_changeSeverity = std::move(value); } /** *

An indication of which action is required if the value for this configuration * option changes:

  • NoInterruption : There is no * interruption to the environment or application availability.

  • * RestartEnvironment : The environment is entirely restarted, all AWS * resources are deleted and recreated, and the environment is unavailable during * the process.

  • RestartApplicationServer : The * environment is available the entire time. However, a short application outage * occurs when the application servers on the running Amazon EC2 instances are * restarted.

*/ inline void SetChangeSeverity(const char* value) { m_changeSeverityHasBeenSet = true; m_changeSeverity.assign(value); } /** *

An indication of which action is required if the value for this configuration * option changes:

  • NoInterruption : There is no * interruption to the environment or application availability.

  • * RestartEnvironment : The environment is entirely restarted, all AWS * resources are deleted and recreated, and the environment is unavailable during * the process.

  • RestartApplicationServer : The * environment is available the entire time. However, a short application outage * occurs when the application servers on the running Amazon EC2 instances are * restarted.

*/ inline ConfigurationOptionDescription& WithChangeSeverity(const Aws::String& value) { SetChangeSeverity(value); return *this;} /** *

An indication of which action is required if the value for this configuration * option changes:

  • NoInterruption : There is no * interruption to the environment or application availability.

  • * RestartEnvironment : The environment is entirely restarted, all AWS * resources are deleted and recreated, and the environment is unavailable during * the process.

  • RestartApplicationServer : The * environment is available the entire time. However, a short application outage * occurs when the application servers on the running Amazon EC2 instances are * restarted.

*/ inline ConfigurationOptionDescription& WithChangeSeverity(Aws::String&& value) { SetChangeSeverity(std::move(value)); return *this;} /** *

An indication of which action is required if the value for this configuration * option changes:

  • NoInterruption : There is no * interruption to the environment or application availability.

  • * RestartEnvironment : The environment is entirely restarted, all AWS * resources are deleted and recreated, and the environment is unavailable during * the process.

  • RestartApplicationServer : The * environment is available the entire time. However, a short application outage * occurs when the application servers on the running Amazon EC2 instances are * restarted.

*/ inline ConfigurationOptionDescription& WithChangeSeverity(const char* value) { SetChangeSeverity(value); return *this;} /** *

An indication of whether the user defined this configuration option:

    *
  • true : This configuration option was defined by the user. * It is a valid choice for specifying if this as an Option to Remove * when updating configuration settings.

  • false : * This configuration was not defined by the user.

Constraint: * You can remove only UserDefined options from a configuration.

*

Valid Values: true | false

*/ inline bool GetUserDefined() const{ return m_userDefined; } /** *

An indication of whether the user defined this configuration option:

    *
  • true : This configuration option was defined by the user. * It is a valid choice for specifying if this as an Option to Remove * when updating configuration settings.

  • false : * This configuration was not defined by the user.

Constraint: * You can remove only UserDefined options from a configuration.

*

Valid Values: true | false

*/ inline bool UserDefinedHasBeenSet() const { return m_userDefinedHasBeenSet; } /** *

An indication of whether the user defined this configuration option:

    *
  • true : This configuration option was defined by the user. * It is a valid choice for specifying if this as an Option to Remove * when updating configuration settings.

  • false : * This configuration was not defined by the user.

Constraint: * You can remove only UserDefined options from a configuration.

*

Valid Values: true | false

*/ inline void SetUserDefined(bool value) { m_userDefinedHasBeenSet = true; m_userDefined = value; } /** *

An indication of whether the user defined this configuration option:

    *
  • true : This configuration option was defined by the user. * It is a valid choice for specifying if this as an Option to Remove * when updating configuration settings.

  • false : * This configuration was not defined by the user.

Constraint: * You can remove only UserDefined options from a configuration.

*

Valid Values: true | false

*/ inline ConfigurationOptionDescription& WithUserDefined(bool value) { SetUserDefined(value); return *this;} /** *

An indication of which type of values this option has and whether it is * allowable to select one or more than one of the possible values:

  • *

    Scalar : Values for this option are a single selection from the * possible values, or an unformatted string, or numeric value governed by the * MIN/MAX/Regex constraints.

  • List : * Values for this option are multiple selections from the possible values.

    *
  • Boolean : Values for this option are either * true or false .

  • Json : * Values for this option are a JSON representation of a * ConfigDocument.

*/ inline const ConfigurationOptionValueType& GetValueType() const{ return m_valueType; } /** *

An indication of which type of values this option has and whether it is * allowable to select one or more than one of the possible values:

  • *

    Scalar : Values for this option are a single selection from the * possible values, or an unformatted string, or numeric value governed by the * MIN/MAX/Regex constraints.

  • List : * Values for this option are multiple selections from the possible values.

    *
  • Boolean : Values for this option are either * true or false .

  • Json : * Values for this option are a JSON representation of a * ConfigDocument.

*/ inline bool ValueTypeHasBeenSet() const { return m_valueTypeHasBeenSet; } /** *

An indication of which type of values this option has and whether it is * allowable to select one or more than one of the possible values:

  • *

    Scalar : Values for this option are a single selection from the * possible values, or an unformatted string, or numeric value governed by the * MIN/MAX/Regex constraints.

  • List : * Values for this option are multiple selections from the possible values.

    *
  • Boolean : Values for this option are either * true or false .

  • Json : * Values for this option are a JSON representation of a * ConfigDocument.

*/ inline void SetValueType(const ConfigurationOptionValueType& value) { m_valueTypeHasBeenSet = true; m_valueType = value; } /** *

An indication of which type of values this option has and whether it is * allowable to select one or more than one of the possible values:

  • *

    Scalar : Values for this option are a single selection from the * possible values, or an unformatted string, or numeric value governed by the * MIN/MAX/Regex constraints.

  • List : * Values for this option are multiple selections from the possible values.

    *
  • Boolean : Values for this option are either * true or false .

  • Json : * Values for this option are a JSON representation of a * ConfigDocument.

*/ inline void SetValueType(ConfigurationOptionValueType&& value) { m_valueTypeHasBeenSet = true; m_valueType = std::move(value); } /** *

An indication of which type of values this option has and whether it is * allowable to select one or more than one of the possible values:

  • *

    Scalar : Values for this option are a single selection from the * possible values, or an unformatted string, or numeric value governed by the * MIN/MAX/Regex constraints.

  • List : * Values for this option are multiple selections from the possible values.

    *
  • Boolean : Values for this option are either * true or false .

  • Json : * Values for this option are a JSON representation of a * ConfigDocument.

*/ inline ConfigurationOptionDescription& WithValueType(const ConfigurationOptionValueType& value) { SetValueType(value); return *this;} /** *

An indication of which type of values this option has and whether it is * allowable to select one or more than one of the possible values:

  • *

    Scalar : Values for this option are a single selection from the * possible values, or an unformatted string, or numeric value governed by the * MIN/MAX/Regex constraints.

  • List : * Values for this option are multiple selections from the possible values.

    *
  • Boolean : Values for this option are either * true or false .

  • Json : * Values for this option are a JSON representation of a * ConfigDocument.

*/ inline ConfigurationOptionDescription& WithValueType(ConfigurationOptionValueType&& value) { SetValueType(std::move(value)); return *this;} /** *

If specified, values for the configuration option are selected from this * list.

*/ inline const Aws::Vector& GetValueOptions() const{ return m_valueOptions; } /** *

If specified, values for the configuration option are selected from this * list.

*/ inline bool ValueOptionsHasBeenSet() const { return m_valueOptionsHasBeenSet; } /** *

If specified, values for the configuration option are selected from this * list.

*/ inline void SetValueOptions(const Aws::Vector& value) { m_valueOptionsHasBeenSet = true; m_valueOptions = value; } /** *

If specified, values for the configuration option are selected from this * list.

*/ inline void SetValueOptions(Aws::Vector&& value) { m_valueOptionsHasBeenSet = true; m_valueOptions = std::move(value); } /** *

If specified, values for the configuration option are selected from this * list.

*/ inline ConfigurationOptionDescription& WithValueOptions(const Aws::Vector& value) { SetValueOptions(value); return *this;} /** *

If specified, values for the configuration option are selected from this * list.

*/ inline ConfigurationOptionDescription& WithValueOptions(Aws::Vector&& value) { SetValueOptions(std::move(value)); return *this;} /** *

If specified, values for the configuration option are selected from this * list.

*/ inline ConfigurationOptionDescription& AddValueOptions(const Aws::String& value) { m_valueOptionsHasBeenSet = true; m_valueOptions.push_back(value); return *this; } /** *

If specified, values for the configuration option are selected from this * list.

*/ inline ConfigurationOptionDescription& AddValueOptions(Aws::String&& value) { m_valueOptionsHasBeenSet = true; m_valueOptions.push_back(std::move(value)); return *this; } /** *

If specified, values for the configuration option are selected from this * list.

*/ inline ConfigurationOptionDescription& AddValueOptions(const char* value) { m_valueOptionsHasBeenSet = true; m_valueOptions.push_back(value); return *this; } /** *

If specified, the configuration option must be a numeric value greater than * this value.

*/ inline int GetMinValue() const{ return m_minValue; } /** *

If specified, the configuration option must be a numeric value greater than * this value.

*/ inline bool MinValueHasBeenSet() const { return m_minValueHasBeenSet; } /** *

If specified, the configuration option must be a numeric value greater than * this value.

*/ inline void SetMinValue(int value) { m_minValueHasBeenSet = true; m_minValue = value; } /** *

If specified, the configuration option must be a numeric value greater than * this value.

*/ inline ConfigurationOptionDescription& WithMinValue(int value) { SetMinValue(value); return *this;} /** *

If specified, the configuration option must be a numeric value less than this * value.

*/ inline int GetMaxValue() const{ return m_maxValue; } /** *

If specified, the configuration option must be a numeric value less than this * value.

*/ inline bool MaxValueHasBeenSet() const { return m_maxValueHasBeenSet; } /** *

If specified, the configuration option must be a numeric value less than this * value.

*/ inline void SetMaxValue(int value) { m_maxValueHasBeenSet = true; m_maxValue = value; } /** *

If specified, the configuration option must be a numeric value less than this * value.

*/ inline ConfigurationOptionDescription& WithMaxValue(int value) { SetMaxValue(value); return *this;} /** *

If specified, the configuration option must be a string value no longer than * this value.

*/ inline int GetMaxLength() const{ return m_maxLength; } /** *

If specified, the configuration option must be a string value no longer than * this value.

*/ inline bool MaxLengthHasBeenSet() const { return m_maxLengthHasBeenSet; } /** *

If specified, the configuration option must be a string value no longer than * this value.

*/ inline void SetMaxLength(int value) { m_maxLengthHasBeenSet = true; m_maxLength = value; } /** *

If specified, the configuration option must be a string value no longer than * this value.

*/ inline ConfigurationOptionDescription& WithMaxLength(int value) { SetMaxLength(value); return *this;} /** *

If specified, the configuration option must be a string value that satisfies * this regular expression.

*/ inline const OptionRestrictionRegex& GetRegex() const{ return m_regex; } /** *

If specified, the configuration option must be a string value that satisfies * this regular expression.

*/ inline bool RegexHasBeenSet() const { return m_regexHasBeenSet; } /** *

If specified, the configuration option must be a string value that satisfies * this regular expression.

*/ inline void SetRegex(const OptionRestrictionRegex& value) { m_regexHasBeenSet = true; m_regex = value; } /** *

If specified, the configuration option must be a string value that satisfies * this regular expression.

*/ inline void SetRegex(OptionRestrictionRegex&& value) { m_regexHasBeenSet = true; m_regex = std::move(value); } /** *

If specified, the configuration option must be a string value that satisfies * this regular expression.

*/ inline ConfigurationOptionDescription& WithRegex(const OptionRestrictionRegex& value) { SetRegex(value); return *this;} /** *

If specified, the configuration option must be a string value that satisfies * this regular expression.

*/ inline ConfigurationOptionDescription& WithRegex(OptionRestrictionRegex&& value) { SetRegex(std::move(value)); return *this;} private: Aws::String m_namespace; bool m_namespaceHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_defaultValue; bool m_defaultValueHasBeenSet = false; Aws::String m_changeSeverity; bool m_changeSeverityHasBeenSet = false; bool m_userDefined; bool m_userDefinedHasBeenSet = false; ConfigurationOptionValueType m_valueType; bool m_valueTypeHasBeenSet = false; Aws::Vector m_valueOptions; bool m_valueOptionsHasBeenSet = false; int m_minValue; bool m_minValueHasBeenSet = false; int m_maxValue; bool m_maxValueHasBeenSet = false; int m_maxLength; bool m_maxLengthHasBeenSet = false; OptionRestrictionRegex m_regex; bool m_regexHasBeenSet = false; }; } // namespace Model } // namespace ElasticBeanstalk } // namespace Aws