API Documentation

FigTransformer

class container_transform.fig.FigTransformer(filename, output_type=None)

A transformer for Fig

To use this class:

transformer = FigTransformer('./fig.yml')
output = transformer.transform()
print(json.dumps(output, indent=4))

__init__(filename, output_type=None)

Parameters:

• filename (str) – The file to be loaded
• output_type (str) – The output type for the transformer

transform(input_data=None)

Transform the YAML into an ECS task

transform_environment(environment)

Transform the fig environment into an ECS environment list

Parameters:environment (dict or list) – The Fig environment Return type:list of dict

transform_memory(memory)

Transform the memory into MB

Parameters:memory (str) – Fig memory definition. (1g, 24k) Returns:The memory in MB Return type:int

transform_port_mappings(port_mappings)

Transform the fig port mappings to ECS mappings

Parameters:port_mappings (list) – The fig port mappings Returns:the ECS port mappings Return type:list

BaseTransformer

class container_transform.transformer.BaseTransformer(filename, output_type=None)

The base class for Transformer classes to inherit from.

Basic usage should look like

transformer = MyTransformer('./my-file.txt')
output = transformer.transform()
print(json.dumps(output, indent=4))

__init__(filename, output_type=None)

Parameters:

• filename (str) – The file to be loaded
• output_type (str) – The output type for the transformer

convert_container(container)

Converts a given dictionary to an output container definition

Parameters:container (dict) – The container definitions as a dictionary Return type:dict Returns:A output_type container definition

read_file(filename)

Parameters:filename (str) – The location of the file to read

read_stream(stream)

Override this method and parse the stream to be passed to self.transform()

Parameters:stream (file) – A file-like object

transform(input_data=None)

Override this method and iteratively call self.convert_container() to transform all input from the input stream to an ECS config.

transform_command(command)

Override this to transform the runtime CMD

transform_cpu(cpu)

Override this to transform CPU

transform_entrypoint(entrypoint)

Override this to transform the container entrypoint

transform_environment(environment)

Override this to transform environment variables

transform_memory(memory)

Override this to transform memory

transform_port_mappings(port_mappings)

Override this to transform port mappings