Class SimpleCFT

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

Index

Methods

addParameter addParameterGroup applyPack patch toJSON toString toYAML

Methods

addParameter

addParameter(parameter): SimpleCFT
Add a stack parameter including its descriptive info and an optional parameter group.
Parameters
- parameter: ParameterInfo
Returns SimpleCFT
- Defined in src/iac/SimpleCFT.ts:49

addParameterGroup

addParameterGroup(__namedParameters): SimpleCFT
Add a group of stack parameters including their descriptive info and an optional parameter group.
Parameters
- __namedParameters: ParameterGroup
Returns SimpleCFT
- Defined in src/iac/SimpleCFT.ts:58

applyPack

applyPack<ParamsType>(pack, params): SimpleCFT
Apply a pack with configuration to the stack template.
Type Parameters
- ParamsType
Parameters
- pack: ResourcePackApplier<ParamsType>
- params: ParamsType
Returns SimpleCFT
See
IaC for an example.
- Defined in src/iac/SimpleCFT.ts:28

patch

patch(patch): SimpleCFT
Apply a patch to the stack template.
Parameters
- patch: Partial<CloudFormationTemplate>
Returns SimpleCFT
- Defined in src/iac/SimpleCFT.ts:40

toJSON

toJSON(): CloudFormationTemplate
Convert the stack template to a JSON object.

Returns CloudFormationTemplate
- Defined in src/iac/SimpleCFT.ts:84

toString

toString(): string
Convert the stack template to a string.

Returns string
- Defined in src/iac/SimpleCFT.ts:79

toYAML

toYAML(): string
Convert the stack template to a YAML string.

Returns string
- Defined in src/iac/SimpleCFT.ts:89