EnvironmentVariable (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codebuild.model.EnvironmentVariable

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EnvironmentVariable
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about an environment variable for a build project or a build.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EnvironmentVariable()

Constructors
Constructor and Description
`EnvironmentVariable()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnvironmentVariable`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` The name or key of the environment variable.
`String`	`getType()` The type of environment variable.
`String`	`getValue()` The value of the environment variable.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setName(String name)` The name or key of the environment variable.
`void`	`setType(String type)` The type of environment variable.
`void`	`setValue(String value)` The value of the environment variable.
`String`	`toString()` Returns a string representation of this object.
`EnvironmentVariable`	`withName(String name)` The name or key of the environment variable.
`EnvironmentVariable`	`withType(EnvironmentVariableType type)` The type of environment variable.
`EnvironmentVariable`	`withType(String type)` The type of environment variable.
`EnvironmentVariable`	`withValue(String value)` The value of the environment variable.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EnvironmentVariable
```
public EnvironmentVariable()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name or key of the environment variable.
    
    Parameters:
    
    name - The name or key of the environment variable.
  - getName
```
public String getName()
```
    The name or key of the environment variable.
    
    Returns:
    
    The name or key of the environment variable.
  - withName
```
public EnvironmentVariable withName(String name)
```
    The name or key of the environment variable.
    
    Parameters:
    
    name - The name or key of the environment variable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValue
```
public void setValue(String value)
```
    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.
    
    Parameters:
    
    value - 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.
  - getValue
```
public String getValue()
```
    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.
    
    Returns:
    
    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.
  - withValue
```
public EnvironmentVariable withValue(String value)
```
    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.
    
    Parameters:
    
    value - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    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.
    Parameters:
    type - 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.
    See Also:
    
    EnvironmentVariableType
  - getType
```
public String getType()
```
    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.
    Returns:
    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.
    See Also:
    
    EnvironmentVariableType
  - withType
```
public EnvironmentVariable withType(String type)
```
    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.
    Parameters:
    type - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentVariableType
  - withType
```
public EnvironmentVariable withType(EnvironmentVariableType type)
```
    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.
    Parameters:
    type - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentVariableType
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EnvironmentVariable clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class EnvironmentVariable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvironmentVariable

Method Detail

setName

getName

withName

setValue

getValue

withValue

setType

getType

withType

withType

toString

equals

hashCode

clone

marshall