@Generated(value="software.amazon.awssdk:codegen") public final class EnvironmentVariable extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>
Information about an environment variable for a build project or a build.
Modifier and Type | Class and Description |
---|---|
static interface |
EnvironmentVariable.Builder |
Modifier and Type | Method and Description |
---|---|
static EnvironmentVariable.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
name()
The name or key of the environment variable.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends EnvironmentVariable.Builder> |
serializableBuilderClass() |
EnvironmentVariable.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
EnvironmentVariableType |
type()
The type of environment variable.
|
String |
typeAsString()
The type of environment variable.
|
String |
value()
The value of the environment variable.
|
copy
public final String name()
The name or key of the environment variable.
public final 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
.
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
.
public final 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.
If the service returns an enum value that is not available in the current SDK version, type
will return
EnvironmentVariableType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
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.
EnvironmentVariableType
public final String typeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, type
will return
EnvironmentVariableType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
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.
EnvironmentVariableType
public EnvironmentVariable.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<EnvironmentVariable.Builder,EnvironmentVariable>
public static EnvironmentVariable.Builder builder()
public static Class<? extends EnvironmentVariable.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.