Package software.amazon.awscdk.services.codebuild

Interface CfnProject.EnvironmentVariableProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProject.EnvironmentVariableProperty.Jsii$Proxy

Enclosing class:

CfnProject

@Stability(Stable)
public static interface CfnProject.EnvironmentVariableProperty
extends software.amazon.jsii.JsiiSerializable

EnvironmentVariable is a property of the AWS CodeBuild Project Environment 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name or key of the environment variable.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-name

getValue

@Stability(Stable)
@NotNull
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. 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-value

getType

@Stability(Stable)
@Nullable
default String getType()

The type of environment variable. Valid values include:.

• PARAMETER_STORE : An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, 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 . For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the AWS CodeBuild User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-type

builder

@Stability(Stable)
static CfnProject.EnvironmentVariableProperty.Builder builder()

Returns:

a CfnProject.EnvironmentVariableProperty.Builder of CfnProject.EnvironmentVariableProperty