@resistdesign/voltra
    Preparing search index...

    Class SimpleCFT

    The basis for your stack template. Apply packs, patches, parameters and parameter groups. Access the template property for the resulting CloudFormation template.

    Example:

    import { SimpleCFT } from "./SimpleCFT";

    const template = new SimpleCFT()
      .addParameter({
        Group: "App",
        ParameterId: "AppName",
        Label: "App Name",
        Parameter: { Type: "String", Default: "voltra" },
      })
      .patch({ Description: "My stack" });

    console.log(template.toString());
    Index

    Constructors

    constructor

    Methods

    addParameter addParameterGroup applyPack modify patch toJSON toString toYAML

    Properties

    template

    Constructors

    • Create a SimpleCFT template wrapper.

      Parameters

      • template: CloudFormationTemplate = ...

        Initial CloudFormation template.

      Returns SimpleCFT

    Methods

    • Apply a patch to the stack template.

      Parameters

      • patch: Partial<CloudFormationTemplate>

        Template patch to merge.

      Returns SimpleCFT

    • Convert the stack template to a JSON object.

      Returns CloudFormationTemplate

      Template JSON object.

    • Convert the stack template to a string.

      Returns string

      JSON string representation of the template.

    • Convert the stack template to a YAML string.

      Returns string

      YAML string representation of the template.

    Properties

    template: CloudFormationTemplate = ...

    Initial CloudFormation template.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties