Class Output

Represents a template output

Inheritance

Object

Output

Implements

IConditionalTemplateObject

IOutput

ITemplateObject

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Firefly.CloudFormationParser.TemplateObjects

Assembly: Firefly.CloudFormationParser.dll

Syntax

public class Output : IConditionalTemplateObject, IOutput, ITemplateObject

Properties

| Improve this Doc View Source

Condition

Gets or sets the output's condition.

When present, associates this output with a condition defined in the Conditions section of the template.

Declaration

[YamlMember(Order = 0)]
public string Condition { get; set; }

Property Value

Type	Description
String	The CloudFormation condition which will be `null` if the template did not provide this property.

| Improve this Doc View Source

Description

Gets or sets the output's description.

A string type that describes the output value. The value for the description declaration must be a literal string that's between 0 and 1024 bytes in length.

Declaration

[YamlMember(Order = 1)]
public string Description { get; set; }

Property Value

Type	Description
String	The output's description which will be `null` if the template did not provide this property.

| Improve this Doc View Source

Export

Gets or sets the name of the resource output to be exported for a cross-stack reference.

Declaration

[YamlMember(Order = 3)]
public object Export { get; set; }

Property Value

Type	Description
Object	The export name which will be `null` if the template did not provide this property.

| Improve this Doc View Source

Name

Gets or sets the name of the object

Names are set on these objects for convenience by the post-processing stage, as they are not part of the object definition as per CloudFormation. They are set as follows:

Parameter - The parameter name
Resource - The logical ID
Output - The output name

Declaration

[YamlIgnore]
public string Name { get; set; }

Property Value

Type	Description
String	The name.

| Improve this Doc View Source

Template

Gets or sets the template which this object is contained in.

Declaration

[YamlIgnore]
public ITemplate Template { get; set; }

Property Value

Type	Description
ITemplate	The template.

| Improve this Doc View Source

Value

Gets or sets the output's value.

The value of the property returned by the aws cloudformation describe-stacks command. The value of an output can include literals, parameter references, pseudo-parameters, a mapping value, or intrinsic functions.

IIntrinsic

Declaration

[YamlMember(Order = 2)]
public object Value { get; set; }

Property Value

Type	Description
Object	The value.

Implements

IConditionalTemplateObject

IOutput

ITemplateObject