Interface IDeserializerSettings

Defines properties required by the CloudFormation deserializer.

An object inherited from this interface is returned by a call to Build(). You should dispose this object following template deserialization to free any resources that are internally allocated such as streams and readers.

Inherited Members

IDisposable.Dispose()

Namespace: Firefly.CloudFormationParser.Serialization.Settings

Assembly: Firefly.CloudFormationParser.dll

Syntax

public interface IDeserializerSettings : IDisposable

Properties

ExcludeConditionalResources

Gets a value indicating whether to exclude resources and outputs nullified by the evaluation of conditions.

When this is true, the results of the evaluation of conditions in the Conditions block of the template using the values of the parameters as supplied by ParameterValues are used to eliminate any resource or output where its Condition property evaluates to false from the template object returned by the call to Deserialize(IDeserializerSettings)

Declaration

bool ExcludeConditionalResources { get; }

Property Value

Type	Description
Boolean	true if conditional objects should be excluded; otherwise, false.

ParameterValues

Gets an optional dictionary of values to assign to parameters.

If left unset, then parameter defaults where present will be used in evaluations, or where there is no declared default value, the default for the type - empty string, zero for number etc.

When deserializing directly from an existing CloudFormation Stack, current values of parameters will be retrieved from the stack and populated here. The API will not return values for parameters flagged NoEcho, therefore if you want to be able to evaluate values for these parameters, pass a dictionary of the values you want to use to WithParameterValues(IDictionary<String, Object>), and these will be merged with the remaining parameters from the stack.

Declaration

IDictionary<string, object> ParameterValues { get; }

Property Value

Type	Description
IDictionary<String, Object>	The parameter values.

S3Client

Gets the S3 client to use for any implied S3 operations, such as retrieving nested stacks or includes.

Declaration

IAmazonS3 S3Client { get; }

Property Value

Type	Description
Amazon.S3.IAmazonS3	The S3 client.

Methods

GetContentAsync()

Gets the template content. This should be implemented as an async method.

Implementations should prepare the template data as a reader from the information passed to the implementation's constructor. It is the job of the implementation to dispose of any resources involved in this operation after the template has been read.

Declaration

Task<TextReader> GetContentAsync()

Returns

Type	Description
Task<TextReader>	A reader positioned at the start of the template to parse.