Show / Hide Table of Contents

Class IfIntrinsic

Represents the Fn::If intrinsic.

Inheritance
Object
AbstractIntrinsic
AbstractArrayIntrinsic
IfIntrinsic
Implements
IIntrinsic
IEnumerable<Object>
IEnumerable
IBranchableIntrinsic
Inherited Members
AbstractArrayIntrinsic.Items
AbstractIntrinsic.ExtraData
AbstractIntrinsic.UseLongForm
AbstractIntrinsic.GetEnumerator()
AbstractIntrinsic.WriteYaml(IEmitter, IValueSerializer)
AbstractIntrinsic.IEnumerable.GetEnumerator()
AbstractIntrinsic.SetValue(Object)
AbstractIntrinsic.UnpackIntrinsic(Object)
AbstractIntrinsic.ValidateValues(Int32, Int32, IList<Object>)
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Namespace: Firefly.CloudFormationParser.Intrinsics.Functions
Assembly: Firefly.CloudFormationParser.dll
Syntax
public class IfIntrinsic : AbstractArrayIntrinsic, IIntrinsic, IEnumerable<object>, IEnumerable, IBranchableIntrinsic

Constructors

| Improve this Doc View Source

IfIntrinsic()

Initializes a new instance of the IfIntrinsic class.

Declaration
public IfIntrinsic()
| Improve this Doc View Source

IfIntrinsic(Object)

Initializes a new instance of the IfIntrinsic class.

Declaration
public IfIntrinsic(object value)
Parameters
Type Name Description
Object value

The value.

| Improve this Doc View Source

IfIntrinsic(Object, Boolean)

Initializes a new instance of the IfIntrinsic class.

Declaration
public IfIntrinsic(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.

Fields

| Improve this Doc View Source

Tag

The tag

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

Properties

| Improve this Doc View Source

Condition

Gets or sets the condition.

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

The condition.

| 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
AbstractIntrinsic.LongName
| 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
AbstractIntrinsic.TagName
| 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
AbstractIntrinsic.Type
| Improve this Doc View Source

ValueIfFalse

Gets or sets the value if false.

Declaration
public object ValueIfFalse { get; }
Property Value
Type Description
Object

The value if false.

| Improve this Doc View Source

ValueIfTrue

Gets or sets the value if true.

Declaration
public object ValueIfTrue { get; }
Property Value
Type Description
Object

The value if true.

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
AbstractIntrinsic.Evaluate(ITemplate)
| Improve this Doc View Source

GetBranch(ITemplate)

Gets the branch based on condition evaluation.

Declaration
public object GetBranch(ITemplate template)
Parameters
Type Name Description
ITemplate template

The template.

Returns
Type Description
Object

Either ValueIfTrue or ValueIfFalse based on conditions.

Exceptions
Type Condition
Amazon.CloudFormation.Model.InvalidOperationException

Condition '{this.Condition} not found in Conditions section of template.

| 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
AbstractIntrinsic.GetReferencedObjects(ITemplate)
| 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
AbstractIntrinsic.SetValue(IEnumerable<Object>)
| Improve this Doc View Source

ToString()

Converts to string.

Declaration
public override string ToString()
Returns
Type Description
String

A String that represents this instance.

Overrides
Object.ToString()

Implements

IIntrinsic
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
IBranchableIntrinsic

See Also

IIntrinsic
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX