AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodeBuild::Model::EnvironmentVariable Class Reference

#include <EnvironmentVariable.h>

Public Member Functions

 EnvironmentVariable ()
 
 EnvironmentVariable (Aws::Utils::Json::JsonView jsonValue)
 
EnvironmentVariableoperator= (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)
 
EnvironmentVariableWithName (const Aws::String &value)
 
EnvironmentVariableWithName (Aws::String &&value)
 
EnvironmentVariableWithName (const char *value)
 
const Aws::StringGetValue () const
 
bool ValueHasBeenSet () const
 
void SetValue (const Aws::String &value)
 
void SetValue (Aws::String &&value)
 
void SetValue (const char *value)
 
EnvironmentVariableWithValue (const Aws::String &value)
 
EnvironmentVariableWithValue (Aws::String &&value)
 
EnvironmentVariableWithValue (const char *value)
 
const EnvironmentVariableTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const EnvironmentVariableType &value)
 
void SetType (EnvironmentVariableType &&value)
 
EnvironmentVariableWithType (const EnvironmentVariableType &value)
 
EnvironmentVariableWithType (EnvironmentVariableType &&value)
 

Detailed Description

Information about an environment variable for a build project or a build.

See Also:

AWS API Reference

Definition at line 33 of file EnvironmentVariable.h.

Constructor & Destructor Documentation

◆ EnvironmentVariable() [1/2]

Aws::CodeBuild::Model::EnvironmentVariable::EnvironmentVariable ( )

◆ EnvironmentVariable() [2/2]

Aws::CodeBuild::Model::EnvironmentVariable::EnvironmentVariable ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetName()

const Aws::String& Aws::CodeBuild::Model::EnvironmentVariable::GetName ( ) const
inline

The name or key of the environment variable.

Definition at line 45 of file EnvironmentVariable.h.

◆ GetType()

const EnvironmentVariableType& Aws::CodeBuild::Model::EnvironmentVariable::GetType ( ) const
inline

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.

  • PLAINTEXT: An environment variable in plain text format. This is the default value.

  • SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.

Definition at line 186 of file EnvironmentVariable.h.

◆ GetValue()

const Aws::String& Aws::CodeBuild::Model::EnvironmentVariable::GetValue ( ) const
inline

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Definition at line 92 of file EnvironmentVariable.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::CodeBuild::Model::EnvironmentVariable::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::CodeBuild::Model::EnvironmentVariable::NameHasBeenSet ( ) const
inline

The name or key of the environment variable.

Definition at line 50 of file EnvironmentVariable.h.

◆ operator=()

EnvironmentVariable& Aws::CodeBuild::Model::EnvironmentVariable::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetName() [1/3]

void Aws::CodeBuild::Model::EnvironmentVariable::SetName ( const Aws::String value)
inline

The name or key of the environment variable.

Definition at line 55 of file EnvironmentVariable.h.

◆ SetName() [2/3]

void Aws::CodeBuild::Model::EnvironmentVariable::SetName ( Aws::String &&  value)
inline

The name or key of the environment variable.

Definition at line 60 of file EnvironmentVariable.h.

◆ SetName() [3/3]

void Aws::CodeBuild::Model::EnvironmentVariable::SetName ( const char *  value)
inline

The name or key of the environment variable.

Definition at line 65 of file EnvironmentVariable.h.

◆ SetType() [1/2]

void Aws::CodeBuild::Model::EnvironmentVariable::SetType ( const EnvironmentVariableType value)
inline

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.

  • PLAINTEXT: An environment variable in plain text format. This is the default value.

  • SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.

Definition at line 218 of file EnvironmentVariable.h.

◆ SetType() [2/2]

void Aws::CodeBuild::Model::EnvironmentVariable::SetType ( EnvironmentVariableType &&  value)
inline

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.

  • PLAINTEXT: An environment variable in plain text format. This is the default value.

  • SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.

Definition at line 234 of file EnvironmentVariable.h.

◆ SetValue() [1/3]

void Aws::CodeBuild::Model::EnvironmentVariable::SetValue ( const Aws::String value)
inline

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Definition at line 114 of file EnvironmentVariable.h.

◆ SetValue() [2/3]

void Aws::CodeBuild::Model::EnvironmentVariable::SetValue ( Aws::String &&  value)
inline

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Definition at line 125 of file EnvironmentVariable.h.

◆ SetValue() [3/3]

void Aws::CodeBuild::Model::EnvironmentVariable::SetValue ( const char *  value)
inline

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Definition at line 136 of file EnvironmentVariable.h.

◆ TypeHasBeenSet()

bool Aws::CodeBuild::Model::EnvironmentVariable::TypeHasBeenSet ( ) const
inline

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.

  • PLAINTEXT: An environment variable in plain text format. This is the default value.

  • SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.

Definition at line 202 of file EnvironmentVariable.h.

◆ ValueHasBeenSet()

bool Aws::CodeBuild::Model::EnvironmentVariable::ValueHasBeenSet ( ) const
inline

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Definition at line 103 of file EnvironmentVariable.h.

◆ WithName() [1/3]

EnvironmentVariable& Aws::CodeBuild::Model::EnvironmentVariable::WithName ( const Aws::String value)
inline

The name or key of the environment variable.

Definition at line 70 of file EnvironmentVariable.h.

◆ WithName() [2/3]

EnvironmentVariable& Aws::CodeBuild::Model::EnvironmentVariable::WithName ( Aws::String &&  value)
inline

The name or key of the environment variable.

Definition at line 75 of file EnvironmentVariable.h.

◆ WithName() [3/3]

EnvironmentVariable& Aws::CodeBuild::Model::EnvironmentVariable::WithName ( const char *  value)
inline

The name or key of the environment variable.

Definition at line 80 of file EnvironmentVariable.h.

◆ WithType() [1/2]

EnvironmentVariable& Aws::CodeBuild::Model::EnvironmentVariable::WithType ( const EnvironmentVariableType value)
inline

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.

  • PLAINTEXT: An environment variable in plain text format. This is the default value.

  • SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.

Definition at line 250 of file EnvironmentVariable.h.

◆ WithType() [2/2]

EnvironmentVariable& Aws::CodeBuild::Model::EnvironmentVariable::WithType ( EnvironmentVariableType &&  value)
inline

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.

  • PLAINTEXT: An environment variable in plain text format. This is the default value.

  • SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.

Definition at line 266 of file EnvironmentVariable.h.

◆ WithValue() [1/3]

EnvironmentVariable& Aws::CodeBuild::Model::EnvironmentVariable::WithValue ( const Aws::String value)
inline

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Definition at line 147 of file EnvironmentVariable.h.

◆ WithValue() [2/3]

EnvironmentVariable& Aws::CodeBuild::Model::EnvironmentVariable::WithValue ( Aws::String &&  value)
inline

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Definition at line 158 of file EnvironmentVariable.h.

◆ WithValue() [3/3]

EnvironmentVariable& Aws::CodeBuild::Model::EnvironmentVariable::WithValue ( const char *  value)
inline

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

Definition at line 169 of file EnvironmentVariable.h.


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