Class: AWSCDK::Pipes::CfnPipe::BatchEnvironmentVariableProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pipes::CfnPipe::BatchEnvironmentVariableProperty

Defined in:

pipes/cfn_pipe.rb

Overview

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.

See Also:

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

Instance Attribute Summary

• #name ⇒ String^? readonly

  The name of the key-value pair.

• #value ⇒ String^? readonly

  The value of the key-value pair.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name: nil, value: nil) ⇒ BatchEnvironmentVariableProperty constructor

  A new instance of BatchEnvironmentVariableProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name: nil, value: nil) ⇒ BatchEnvironmentVariableProperty

Returns a new instance of BatchEnvironmentVariableProperty.

Parameters:

• name (String, nil) (defaults to: nil) —

  The name of the key-value pair.

• value (String, nil) (defaults to: nil) —

  The value of the key-value pair.

# File 'pipes/cfn_pipe.rb', line 885

def initialize(name: nil, value: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless @value.nil?
end

Instance Attribute Details

#name ⇒ String^? (readonly)

The name of the key-value pair.

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

Returns:

• (String, nil)

See Also:

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

# File 'pipes/cfn_pipe.rb', line 898

def name
  @name
end

#value ⇒ String^? (readonly)

The value of the key-value pair.

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

Returns:

• (String, nil)

See Also:

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

# File 'pipes/cfn_pipe.rb', line 905

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pipes/cfn_pipe.rb', line 907

def self.jsii_properties
  {
    :name => "name",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pipes/cfn_pipe.rb', line 914

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "value" => @value,
  })
  result.compact
end