AWS SDK for C++  1.9.109
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodePipeline::Model::ActionConfigurationProperty Class Reference

#include <ActionConfigurationProperty.h>

Public Member Functions

 ActionConfigurationProperty ()
 
 ActionConfigurationProperty (Aws::Utils::Json::JsonView jsonValue)
 
ActionConfigurationPropertyoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ActionConfigurationPropertyWithName (const Aws::String &value)
 
ActionConfigurationPropertyWithName (Aws::String &&value)
 
ActionConfigurationPropertyWithName (const char *value)
 
bool GetRequired () const
 
bool RequiredHasBeenSet () const
 
void SetRequired (bool value)
 
ActionConfigurationPropertyWithRequired (bool value)
 
bool GetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (bool value)
 
ActionConfigurationPropertyWithKey (bool value)
 
bool GetSecret () const
 
bool SecretHasBeenSet () const
 
void SetSecret (bool value)
 
ActionConfigurationPropertyWithSecret (bool value)
 
bool GetQueryable () const
 
bool QueryableHasBeenSet () const
 
void SetQueryable (bool value)
 
ActionConfigurationPropertyWithQueryable (bool value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
ActionConfigurationPropertyWithDescription (const Aws::String &value)
 
ActionConfigurationPropertyWithDescription (Aws::String &&value)
 
ActionConfigurationPropertyWithDescription (const char *value)
 
const ActionConfigurationPropertyTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ActionConfigurationPropertyType &value)
 
void SetType (ActionConfigurationPropertyType &&value)
 
ActionConfigurationPropertyWithType (const ActionConfigurationPropertyType &value)
 
ActionConfigurationPropertyWithType (ActionConfigurationPropertyType &&value)
 

Detailed Description

Represents information about an action configuration property.

See Also:

AWS API Reference

Definition at line 33 of file ActionConfigurationProperty.h.

Constructor & Destructor Documentation

◆ ActionConfigurationProperty() [1/2]

Aws::CodePipeline::Model::ActionConfigurationProperty::ActionConfigurationProperty ( )

◆ ActionConfigurationProperty() [2/2]

Aws::CodePipeline::Model::ActionConfigurationProperty::ActionConfigurationProperty ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DescriptionHasBeenSet()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::DescriptionHasBeenSet ( ) const
inline

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

Definition at line 225 of file ActionConfigurationProperty.h.

◆ GetDescription()

const Aws::String& Aws::CodePipeline::Model::ActionConfigurationProperty::GetDescription ( ) const
inline

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

Definition at line 219 of file ActionConfigurationProperty.h.

◆ GetKey()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::GetKey ( ) const
inline

Whether the configuration property is a key.

Definition at line 107 of file ActionConfigurationProperty.h.

◆ GetName()

const Aws::String& Aws::CodePipeline::Model::ActionConfigurationProperty::GetName ( ) const
inline

The name of the action configuration property.

Definition at line 45 of file ActionConfigurationProperty.h.

◆ GetQueryable()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::GetQueryable ( ) const
inline

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.

Definition at line 176 of file ActionConfigurationProperty.h.

◆ GetRequired()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::GetRequired ( ) const
inline

Whether the configuration property is a required value.

Definition at line 86 of file ActionConfigurationProperty.h.

◆ GetSecret()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::GetSecret ( ) const
inline

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.

Definition at line 133 of file ActionConfigurationProperty.h.

◆ GetType()

const ActionConfigurationPropertyType& Aws::CodePipeline::Model::ActionConfigurationProperty::GetType ( ) const
inline

The type of the configuration property.

Definition at line 267 of file ActionConfigurationProperty.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::CodePipeline::Model::ActionConfigurationProperty::Jsonize ( ) const

◆ KeyHasBeenSet()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::KeyHasBeenSet ( ) const
inline

Whether the configuration property is a key.

Definition at line 112 of file ActionConfigurationProperty.h.

◆ NameHasBeenSet()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::NameHasBeenSet ( ) const
inline

The name of the action configuration property.

Definition at line 50 of file ActionConfigurationProperty.h.

◆ operator=()

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ QueryableHasBeenSet()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::QueryableHasBeenSet ( ) const
inline

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.

Definition at line 188 of file ActionConfigurationProperty.h.

◆ RequiredHasBeenSet()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::RequiredHasBeenSet ( ) const
inline

Whether the configuration property is a required value.

Definition at line 91 of file ActionConfigurationProperty.h.

◆ SecretHasBeenSet()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::SecretHasBeenSet ( ) const
inline

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.

Definition at line 143 of file ActionConfigurationProperty.h.

◆ SetDescription() [1/3]

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetDescription ( Aws::String &&  value)
inline

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

Definition at line 237 of file ActionConfigurationProperty.h.

◆ SetDescription() [2/3]

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetDescription ( const Aws::String value)
inline

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

Definition at line 231 of file ActionConfigurationProperty.h.

◆ SetDescription() [3/3]

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetDescription ( const char *  value)
inline

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

Definition at line 243 of file ActionConfigurationProperty.h.

◆ SetKey()

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetKey ( bool  value)
inline

Whether the configuration property is a key.

Definition at line 117 of file ActionConfigurationProperty.h.

◆ SetName() [1/3]

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetName ( Aws::String &&  value)
inline

The name of the action configuration property.

Definition at line 60 of file ActionConfigurationProperty.h.

◆ SetName() [2/3]

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetName ( const Aws::String value)
inline

The name of the action configuration property.

Definition at line 55 of file ActionConfigurationProperty.h.

◆ SetName() [3/3]

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetName ( const char *  value)
inline

The name of the action configuration property.

Definition at line 65 of file ActionConfigurationProperty.h.

◆ SetQueryable()

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetQueryable ( bool  value)
inline

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.

Definition at line 200 of file ActionConfigurationProperty.h.

◆ SetRequired()

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetRequired ( bool  value)
inline

Whether the configuration property is a required value.

Definition at line 96 of file ActionConfigurationProperty.h.

◆ SetSecret()

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetSecret ( bool  value)
inline

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.

Definition at line 153 of file ActionConfigurationProperty.h.

◆ SetType() [1/2]

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetType ( ActionConfigurationPropertyType &&  value)
inline

The type of the configuration property.

Definition at line 282 of file ActionConfigurationProperty.h.

◆ SetType() [2/2]

void Aws::CodePipeline::Model::ActionConfigurationProperty::SetType ( const ActionConfigurationPropertyType value)
inline

The type of the configuration property.

Definition at line 277 of file ActionConfigurationProperty.h.

◆ TypeHasBeenSet()

bool Aws::CodePipeline::Model::ActionConfigurationProperty::TypeHasBeenSet ( ) const
inline

The type of the configuration property.

Definition at line 272 of file ActionConfigurationProperty.h.

◆ WithDescription() [1/3]

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithDescription ( Aws::String &&  value)
inline

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

Definition at line 255 of file ActionConfigurationProperty.h.

◆ WithDescription() [2/3]

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithDescription ( const Aws::String value)
inline

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

Definition at line 249 of file ActionConfigurationProperty.h.

◆ WithDescription() [3/3]

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithDescription ( const char *  value)
inline

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

Definition at line 261 of file ActionConfigurationProperty.h.

◆ WithKey()

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithKey ( bool  value)
inline

Whether the configuration property is a key.

Definition at line 122 of file ActionConfigurationProperty.h.

◆ WithName() [1/3]

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithName ( Aws::String &&  value)
inline

The name of the action configuration property.

Definition at line 75 of file ActionConfigurationProperty.h.

◆ WithName() [2/3]

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithName ( const Aws::String value)
inline

The name of the action configuration property.

Definition at line 70 of file ActionConfigurationProperty.h.

◆ WithName() [3/3]

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithName ( const char *  value)
inline

The name of the action configuration property.

Definition at line 80 of file ActionConfigurationProperty.h.

◆ WithQueryable()

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithQueryable ( bool  value)
inline

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.

Definition at line 212 of file ActionConfigurationProperty.h.

◆ WithRequired()

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithRequired ( bool  value)
inline

Whether the configuration property is a required value.

Definition at line 101 of file ActionConfigurationProperty.h.

◆ WithSecret()

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithSecret ( bool  value)
inline

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.

Definition at line 163 of file ActionConfigurationProperty.h.

◆ WithType() [1/2]

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithType ( ActionConfigurationPropertyType &&  value)
inline

The type of the configuration property.

Definition at line 292 of file ActionConfigurationProperty.h.

◆ WithType() [2/2]

ActionConfigurationProperty& Aws::CodePipeline::Model::ActionConfigurationProperty::WithType ( const ActionConfigurationPropertyType value)
inline

The type of the configuration property.

Definition at line 287 of file ActionConfigurationProperty.h.


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