cloudformation-plus-plus: cfn template preprocessor
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

93 lines
1.7 KiB

<?php
declare(strict_types=1);
namespace App\Engine;
/**
* Configure the compilation process or provide state.
*
* @author Adam Pippin <hello@adampippin.ca>
*/
interface IOptions
{
/**
* Set variables for use in template.
*
* @param array<string, mixed> $variables
* @return void
*/
public function setVariables(array $variables): void;
/**
* Retrieve all variables set.
*
* @return array<string,mixed>
*/
public function getVariables(): array;
/**
* Retrieve the value of a single variable.
*
* @param string $name
* @return mixed
*/
public function getVariable(string $name);
/**
* Set a single variable.
*
* @param string $name
* @param mixed $value
* @return void
*/
public function setVariable(string $name, $value): void;
/**
* Check if a variable exists.
*
* @param string $name
* @return bool
*/
public function hasVariable(string $name): bool;
/**
* Set parameters to send to cloudformation.
*
* @param array<string, mixed> $parameters
* @return void
*/
public function setParameters(array $parameters): void;
/**
* Retrieve all parameters set.
*
* @return array<string,mixed>
*/
public function getParameters(): array;
/**
* Retrieve the value of a single parameter.
*
* @param string $name
* @return mixed
*/
public function getParameter(string $name);
/**
* Set a single parameter.
*
* @param string $name
* @param mixed $value
* @return void
*/
public function setParameter(string $name, $value): void;
/**
* Check if a parameter exists.
*
* @param string $name
* @return bool
*/
public function hasParameter(string $name): bool;
}