Show / Hide Table of Contents

Class FindInMapIntrinsic

Represents the Fn::FindInMap intrinsic.

Inheritance
Object
AbstractIntrinsic
AbstractArrayIntrinsic
FindInMapIntrinsic
Implements
IIntrinsic
IEnumerable<Object>
IEnumerable
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 FindInMapIntrinsic : AbstractArrayIntrinsic, IIntrinsic, IEnumerable<object>, IEnumerable

Constructors

| Improve this Doc View Source

FindInMapIntrinsic()

Initializes a new instance of the FindInMapIntrinsic class.

Declaration
public FindInMapIntrinsic()
| Improve this Doc View Source

FindInMapIntrinsic(Object)

Initializes a new instance of the FindInMapIntrinsic class.

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

The value.

| Improve this Doc View Source

FindInMapIntrinsic(Object, Boolean)

Initializes a new instance of the FindInMapIntrinsic class.

Declaration
public FindInMapIntrinsic(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

FindInMapIntrinsic(Object, Object, Object)

Initializes a new instance of the FindInMapIntrinsic class.

Declaration
public FindInMapIntrinsic(object mapName, object topLevelKey, object secondLevelKey)
Parameters
Type Name Description
Object mapName

Name of the map. String or reference to intrinsic.

Object topLevelKey

The top level key. String or reference to intrinsic.

Object secondLevelKey

The second level key. String or reference to intrinsic.

Fields

| Improve this Doc View Source

Tag

The tag

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

Properties

| 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

MapName

Gets or sets the name of the map.

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

The name of the map.

| Improve this Doc View Source

SecondLevelKey

Gets or sets the second level key.

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

The second level key.

| 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

TopLevelKey

Gets or sets the top level key.

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

The top level key. May be a !Ref

| 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

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

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

See Also

IIntrinsic
  • Improve this Doc
  • View Source
In This Article
  • Constructors
    • FindInMapIntrinsic()
    • FindInMapIntrinsic(Object)
    • FindInMapIntrinsic(Object, Boolean)
    • FindInMapIntrinsic(Object, Object, Object)
  • Fields
    • Tag
  • Properties
    • LongName
    • MapName
    • SecondLevelKey
    • TagName
    • TopLevelKey
    • Type
  • Methods
    • Evaluate(ITemplate)
    • GetReferencedObjects(ITemplate)
    • SetValue(IEnumerable<Object>)
    • ToString()
  • Implements
  • See Also
Back to top Generated by DocFX