/** * 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 CodePipeline { namespace Model { /** *

Represents information about an action configuration property.

See * Also:

AWS * API Reference

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

The name of the action configuration property.

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

The name of the action configuration property.

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

The name of the action configuration property.

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

The name of the action configuration property.

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

The name of the action configuration property.

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

The name of the action configuration property.

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

The name of the action configuration property.

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

The name of the action configuration property.

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

Whether the configuration property is a required value.

*/ inline bool GetRequired() const{ return m_required; } /** *

Whether the configuration property is a required value.

*/ inline bool RequiredHasBeenSet() const { return m_requiredHasBeenSet; } /** *

Whether the configuration property is a required value.

*/ inline void SetRequired(bool value) { m_requiredHasBeenSet = true; m_required = value; } /** *

Whether the configuration property is a required value.

*/ inline ActionConfigurationProperty& WithRequired(bool value) { SetRequired(value); return *this;} /** *

Whether the configuration property is a key.

*/ inline bool GetKey() const{ return m_key; } /** *

Whether the configuration property is a key.

*/ inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } /** *

Whether the configuration property is a key.

*/ inline void SetKey(bool value) { m_keyHasBeenSet = true; m_key = value; } /** *

Whether the configuration property is a key.

*/ inline ActionConfigurationProperty& WithKey(bool value) { SetKey(value); return *this;} /** *

Whether the configuration property is secret. Secrets are hidden from all * calls except for GetJobDetails, * GetThirdPartyJobDetails, PollForJobs, and * PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * * without changing any other values of the action preserves the previous * value of the secret.

*/ inline bool GetSecret() const{ return m_secret; } /** *

Whether the configuration property is secret. Secrets are hidden from all * calls except for GetJobDetails, * GetThirdPartyJobDetails, PollForJobs, and * PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * * without changing any other values of the action preserves the previous * value of the secret.

*/ inline bool SecretHasBeenSet() const { return m_secretHasBeenSet; } /** *

Whether the configuration property is secret. Secrets are hidden from all * calls except for GetJobDetails, * GetThirdPartyJobDetails, PollForJobs, and * PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * * without changing any other values of the action preserves the previous * value of the secret.

*/ inline void SetSecret(bool value) { m_secretHasBeenSet = true; m_secret = value; } /** *

Whether the configuration property is secret. Secrets are hidden from all * calls except for GetJobDetails, * GetThirdPartyJobDetails, PollForJobs, and * PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * * without changing any other values of the action preserves the previous * value of the secret.

*/ inline ActionConfigurationProperty& WithSecret(bool value) { SetSecret(value); return *this;} /** *

Indicates that the property is used with PollForJobs. When * creating a custom action, an action can have up to one queryable property. If it * has one, that property must be both required and not secret.

If you * create a pipeline with a custom action type, and that custom action contains a * queryable property, the value for that configuration property is subject to * other restrictions. The value must be less than or equal to twenty (20) * characters. The value can contain only alphanumeric characters, underscores, and * hyphens.

*/ inline bool GetQueryable() const{ return m_queryable; } /** *

Indicates that the property is used with PollForJobs. When * creating a custom action, an action can have up to one queryable property. If it * has one, that property must be both required and not secret.

If you * create a pipeline with a custom action type, and that custom action contains a * queryable property, the value for that configuration property is subject to * other restrictions. The value must be less than or equal to twenty (20) * characters. The value can contain only alphanumeric characters, underscores, and * hyphens.

*/ inline bool QueryableHasBeenSet() const { return m_queryableHasBeenSet; } /** *

Indicates that the property is used with PollForJobs. When * creating a custom action, an action can have up to one queryable property. If it * has one, that property must be both required and not secret.

If you * create a pipeline with a custom action type, and that custom action contains a * queryable property, the value for that configuration property is subject to * other restrictions. The value must be less than or equal to twenty (20) * characters. The value can contain only alphanumeric characters, underscores, and * hyphens.

*/ inline void SetQueryable(bool value) { m_queryableHasBeenSet = true; m_queryable = value; } /** *

Indicates that the property is used with PollForJobs. When * creating a custom action, an action can have up to one queryable property. If it * has one, that property must be both required and not secret.

If you * create a pipeline with a custom action type, and that custom action contains a * queryable property, the value for that configuration property is subject to * other restrictions. The value must be less than or equal to twenty (20) * characters. The value can contain only alphanumeric characters, underscores, and * hyphens.

*/ inline ActionConfigurationProperty& WithQueryable(bool value) { SetQueryable(value); return *this;} /** *

The description of the action configuration property that is displayed to * users.

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

The description of the action configuration property that is displayed to * users.

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

The description of the action configuration property that is displayed to * users.

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

The description of the action configuration property that is displayed to * users.

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

The description of the action configuration property that is displayed to * users.

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

The description of the action configuration property that is displayed to * users.

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

The description of the action configuration property that is displayed to * users.

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

The description of the action configuration property that is displayed to * users.

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

The type of the configuration property.

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

The type of the configuration property.

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

The type of the configuration property.

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

The type of the configuration property.

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

The type of the configuration property.

*/ inline ActionConfigurationProperty& WithType(const ActionConfigurationPropertyType& value) { SetType(value); return *this;} /** *

The type of the configuration property.

*/ inline ActionConfigurationProperty& WithType(ActionConfigurationPropertyType&& value) { SetType(std::move(value)); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; bool m_required; bool m_requiredHasBeenSet = false; bool m_key; bool m_keyHasBeenSet = false; bool m_secret; bool m_secretHasBeenSet = false; bool m_queryable; bool m_queryableHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; ActionConfigurationPropertyType m_type; bool m_typeHasBeenSet = false; }; } // namespace Model } // namespace CodePipeline } // namespace Aws