Package software.amazon.awscdk.services.pipes

Interface CfnPipe.BatchEnvironmentVariableProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.BatchEnvironmentVariableProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.BatchEnvironmentVariableProperty
extends software.amazon.jsii.JsiiSerializable

The environment variables to send to the container.

You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

Environment variables cannot start with " AWS Batch ". This naming convention is reserved for variables that AWS Batch sets.

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.pipes.*;
 BatchEnvironmentVariableProperty batchEnvironmentVariableProperty = BatchEnvironmentVariableProperty.builder()
         .name("name")
         .value("value")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchenvironmentvariable.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipe.BatchEnvironmentVariableProperty.Builder	builder()
default String	getName()	The name of the key-value pair.
default String	getValue()	The value of the key-value pair.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

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

The name of the key-value pair.

For environment variables, this is the name of the environment variable.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchenvironmentvariable.html#cfn-pipes-pipe-batchenvironmentvariable-name

getValue

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

The value of the key-value pair.

For environment variables, this is the value of the environment variable.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchenvironmentvariable.html#cfn-pipes-pipe-batchenvironmentvariable-value

builder

@Stability(Stable)
static CfnPipe.BatchEnvironmentVariableProperty.Builder builder()

Returns:

a CfnPipe.BatchEnvironmentVariableProperty.Builder of CfnPipe.BatchEnvironmentVariableProperty