Contents

require "sfn"

module Sfn
  # Interface for generating plan report
  class Planner
    autoload :Aws, "sfn/planner/aws"

    # Value to flag runtime modification
    RUNTIME_MODIFIED = "__MODIFIED_REFERENCE_VALUE__"

    # @return [Bogo::Ui]
    attr_reader :ui
    # @return [Smash]
    attr_reader :config
    # @return [Array<String>] CLI arguments
    attr_reader :arguments
    # @return [Miasma::Models::Orchestration::Stack] existing remote stack
    attr_reader :origin_stack
    # @return [Hash] custom options
    attr_reader :options

    # Create a new planner instance
    #
    # @param ui [Bogo::Ui]
    # @param config [Smash]
    # @param arguments [Array<String>]
    # @param stack [Miasma::Models::Orchestration::Stack]
    # @param opts [Hash]
    #
    # @return [self]
    def initialize(ui, config, arguments, stack, opts = {})
      @ui = ui
      @config = config
      @arguments = arguments
      @origin_stack = stack
      @options = opts
    end

    # Generate update report
    #
    # @param template [Hash] updated template
    # @param parameters [Hash] runtime parameters for update
    #
    # @return [Miasma::Models::Orchestration::Stack::Plan] report
    def generate_plan(template, parameters)
      raise NotImplementedError
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
sfn-3.1.8	lib/sfn/planner.rb
sfn-3.1.6	lib/sfn/planner.rb
sfn-3.1.4	lib/sfn/planner.rb
sfn-3.1.2	lib/sfn/planner.rb
sfn-3.1.0	lib/sfn/planner.rb
sfn-3.0.32	lib/sfn/planner.rb