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

Parameters specified in a Systems Manager document that run on the server * when the command is run.

See Also:

AWS * API Reference

*/ class DocumentParameter { public: AWS_SSM_API DocumentParameter(); AWS_SSM_API DocumentParameter(Aws::Utils::Json::JsonView jsonValue); AWS_SSM_API DocumentParameter& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_SSM_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the parameter.

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

The name of the parameter.

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

The name of the parameter.

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

The name of the parameter.

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

The name of the parameter.

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

The name of the parameter.

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

The name of the parameter.

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

The name of the parameter.

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

The type of parameter. The type can be either String or StringList.

*/ inline const DocumentParameterType& GetType() const{ return m_type; } /** *

The type of parameter. The type can be either String or StringList.

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

The type of parameter. The type can be either String or StringList.

*/ inline void SetType(const DocumentParameterType& value) { m_typeHasBeenSet = true; m_type = value; } /** *

The type of parameter. The type can be either String or StringList.

*/ inline void SetType(DocumentParameterType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

The type of parameter. The type can be either String or StringList.

*/ inline DocumentParameter& WithType(const DocumentParameterType& value) { SetType(value); return *this;} /** *

The type of parameter. The type can be either String or StringList.

*/ inline DocumentParameter& WithType(DocumentParameterType&& value) { SetType(std::move(value)); return *this;} /** *

A description of what the parameter does, how to use it, the default value, * and whether or not the parameter is optional.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

A description of what the parameter does, how to use it, the default value, * and whether or not the parameter is optional.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A description of what the parameter does, how to use it, the default value, * and whether or not the parameter is optional.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

A description of what the parameter does, how to use it, the default value, * and whether or not the parameter is optional.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

A description of what the parameter does, how to use it, the default value, * and whether or not the parameter is optional.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

A description of what the parameter does, how to use it, the default value, * and whether or not the parameter is optional.

*/ inline DocumentParameter& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A description of what the parameter does, how to use it, the default value, * and whether or not the parameter is optional.

*/ inline DocumentParameter& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

A description of what the parameter does, how to use it, the default value, * and whether or not the parameter is optional.

*/ inline DocumentParameter& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

If specified, the default values for the parameters. Parameters without a * default value are required. Parameters with a default value are optional.

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

If specified, the default values for the parameters. Parameters without a * default value are required. Parameters with a default value are optional.

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

If specified, the default values for the parameters. Parameters without a * default value are required. Parameters with a default value are optional.

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

If specified, the default values for the parameters. Parameters without a * default value are required. Parameters with a default value are optional.

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

If specified, the default values for the parameters. Parameters without a * default value are required. Parameters with a default value are optional.

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

If specified, the default values for the parameters. Parameters without a * default value are required. Parameters with a default value are optional.

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

If specified, the default values for the parameters. Parameters without a * default value are required. Parameters with a default value are optional.

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

If specified, the default values for the parameters. Parameters without a * default value are required. Parameters with a default value are optional.

*/ inline DocumentParameter& WithDefaultValue(const char* value) { SetDefaultValue(value); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; DocumentParameterType m_type; bool m_typeHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::String m_defaultValue; bool m_defaultValueHasBeenSet = false; }; } // namespace Model } // namespace SSM } // namespace Aws