software.amazon.awscdk.services.codebuild

Interface CfnProject.EnvironmentVariableProperty

All Known Implementing Classes:

CfnProject.EnvironmentVariableProperty.Jsii$Proxy

Enclosing class:

CfnProject

public static interface CfnProject.EnvironmentVariableProperty

`EnvironmentVariable` is a property of the [AWS CodeBuild Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html) property type that specifies the name and value of an environment variable for an AWS CodeBuild project environment. When you use the environment to run a build, these variables are available for your builds to use. `EnvironmentVariable` contains a list of `EnvironmentVariable` property types.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codebuild.*;
 EnvironmentVariableProperty environmentVariableProperty = EnvironmentVariableProperty.builder()
         .name("name")
         .value("value")
         // the properties below are optional
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnProject.EnvironmentVariableProperty.Builder A builder for CfnProject.EnvironmentVariableProperty
static class	CfnProject.EnvironmentVariableProperty.Jsii$Proxy An implementation for CfnProject.EnvironmentVariableProperty

Method Summary

Modifier and Type	Method and Description
static CfnProject.EnvironmentVariableProperty.Builder	builder()
java.lang.String	getName() The name or key of the environment variable.
default java.lang.String	getType() The type of environment variable.
java.lang.String	getValue() The value of the environment variable.

Method Detail

getName

java.lang.String getName()

The name or key of the environment variable.

getValue

java.lang.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 CLI . For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER .

getType

default java.lang.String getType()

The type of environment variable. Valid values include:.

• PARAMETER_STORE : An environment variable stored in 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 .

builder

static CfnProject.EnvironmentVariableProperty.Builder builder()

Returns:

a CfnProject.EnvironmentVariableProperty.Builder of CfnProject.EnvironmentVariableProperty