Class SubIntrinsic

Represents the Fn::Sub intrinsic.

Inheritance
Object
AbstractIntrinsic
SubIntrinsic
Inherited Members
Namespace: Firefly.CloudFormationParser.Intrinsics.Functions
Assembly: Firefly.CloudFormationParser.dll
Syntax
public class SubIntrinsic : AbstractIntrinsic, IIntrinsic, IEnumerable<object>, IEnumerable

Constructors

| Improve this Doc View Source

SubIntrinsic()

Initializes a new instance of the SubIntrinsic class.

Declaration
public SubIntrinsic()
| Improve this Doc View Source

SubIntrinsic(Object, Boolean)

Initializes a new instance of the SubIntrinsic class.

Declaration
public SubIntrinsic(object value, bool useLongForm)
Parameters
Type Name Description
Object value

The value.
Boolean useLongForm

If set to true, emit long form of intrinsic when serializing.
| Improve this Doc View Source

SubIntrinsic(String)

Initializes a new instance of the SubIntrinsic class.

Declaration
public SubIntrinsic(string expression)
Parameters
Type Name Description
String expression

The expression.
| Improve this Doc View Source

SubIntrinsic(String, IDictionary<String, Object>)

Initializes a new instance of the SubIntrinsic class.

Declaration
public SubIntrinsic(string expression, IDictionary<string, object> substitutions)
Parameters
Type Name Description
String expression

The expression.
IDictionary<String, Object> substitutions

The substitutions.

Fields

| Improve this Doc View Source

Tag

The tag

Declaration
public const string Tag = "!Sub"
Field Value
Type Description
String

Properties

| Improve this Doc View Source

Expression

Gets or sets the expression.

Declaration
public string Expression { get; set; }
Property Value
Type Description
String

The expression.
| Improve this Doc View Source

ImplicitReferences

Gets the implicit references, that is any !Ref inferred by interpolated arguments in the expression

Declaration
public List<IReferenceIntrinsic> ImplicitReferences { get; }
Property Value
Type Description
List<IReferenceIntrinsic>

The implicit references.
| Improve this Doc View Source

Items

Gets or sets the item list for the intrinsic

Declaration
public List<object> Items { get; protected set; }
Property Value
Type Description
List<Object>

The items.
| Improve this Doc View Source

LongName

Gets the long name of the intrinsic.

Declaration
public override string LongName { get; }
Property Value
Type Description
String

The long name.
Overrides
| Improve this Doc View Source

Substitutions

Gets or sets the substitutions.

Declaration
public Dictionary<string, object> Substitutions { get; set; }
Property Value
Type Description
Dictionary<String, Object>

The substitutions.
| Improve this Doc View Source

TagName

Gets the YAML tag name.

Declaration
public override string TagName { get; }
Property Value
Type Description
String

The name of the tag.
Overrides
| Improve this Doc View Source

Type

Gets the intrinsic type for this intrinsic.

Declaration
public override IntrinsicType Type { get; }
Property Value
Type Description
IntrinsicType

The type.
Overrides

Methods

| Improve this Doc View Source

Evaluate(ITemplate)

Evaluates the result of the intrinsic function.

Declaration
public override object Evaluate(ITemplate template)
Parameters
Type Name Description
ITemplate template

Reference to the template being processed
Returns
Type Description
Object

The result.
Overrides
| Improve this Doc View Source

GetReferencedObjects(ITemplate)

Gets a list of referenced resources and/or parameters in this expression

Declaration
public override IEnumerable<string> GetReferencedObjects(ITemplate template)
Parameters
Type Name Description
ITemplate template

Reference to the template being processed
Returns
Type Description
IEnumerable<String>

List of references
Overrides
| Improve this Doc View Source

SetValue(IEnumerable<Object>)

Sets the values for the intrinsic.

This is a list of objects, whose length depends on the number of properties (usually list elements) supported by the intrinsic. Each element depending on the intrinsic, may be a scalar value, another intrinsic or another list of items e.g. for !Join or !Select

Declaration
protected override void SetValue(IEnumerable<object> values)
Parameters
Type Name Description
IEnumerable<Object> values

Values to assign to the intrinsic
Overrides

Implements

See Also