Interface IParameter

Interface describing a CloudFormation Parameter.

Inherited Members

ITemplateObject.Name

ITemplateObject.Template

Namespace: Firefly.CloudFormationParser

Assembly: Firefly.CloudFormationParser.dll

Syntax

public interface IParameter : ITemplateObject

Properties

AllowedPattern

Gets the allowed pattern as a regular expression.

Declaration

Regex AllowedPattern { get; }

Property Value

Type	Description
Regex	The allowed pattern, or null if the parameter has no allowed pattern.

AllowedValues

Gets an array containing the list of values allowed for the parameter.

Declaration

List<string> AllowedValues { get; }

Property Value

Type	Description
List<String>	The allowed values, which will be null if not defined in the template.

ConstraintDescription

Gets a string that explains a constraint when the constraint is violated..

Declaration

string ConstraintDescription { get; }

Property Value

Type	Description
String	The constraint description, which will be null if not defined in the template.

CurrentValue

Gets the current value of this parameter

This value may be set by passing a Dictionary<TKey,TValue> of string,object to ParameterValues method.

Declaration

object CurrentValue { get; }

Property Value

Type	Description
Object	The current value, which will be null if not set by passing a values dictionary to the deserializer.

Default

Gets a value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.

Declaration

string Default { get; }

Property Value

Type	Description
String	The default value, which will be null if not defined in the template.

Description

Gets a string of up to 4000 characters that describes the parameter.

Declaration

string Description { get; }

Property Value

Type	Description
String	Description of the parameter, which will be null if not defined in the template.

HasMaxLength

Gets a value indicating whether this parameter has a maximum length.

Declaration

bool HasMaxLength { get; }

Property Value

Type	Description
Boolean	true if this parameter has a maximum length; otherwise, false.

HasMaxValue

Gets a value indicating whether this parameter has a maximum value.

Declaration

bool HasMaxValue { get; }

Property Value

Type	Description
Boolean	true if this parameter has a maximum value; otherwise, false.

HasMinLength

Gets a value indicating whether this parameter has a minimum length.

Declaration

bool HasMinLength { get; }

Property Value

Type	Description
Boolean	true if this parameter has a minimum length; otherwise, false.

HasMinValue

Gets a value indicating whether this parameter has a minimum value.

Declaration

bool HasMinValue { get; }

Property Value

Type	Description
Boolean	true if this parameter has a minimum value; otherwise, false.

IsSsmParameter

Gets a value indicating whether this parameter is populated from SSM Parameter Store

Declaration

bool IsSsmParameter { get; }

Property Value

Type	Description
Boolean	true if this is an SSM-populated parameter; else false.

MaxLength

Gets an integer value that determines the largest number of characters you want to allow for String types.

Declaration

int? MaxLength { get; }

Property Value

Type	Description
Nullable<Int32>	The maximum length, which will be null if not defined in the template.

MaxValue

Gets a numeric value that determines the largest numeric value you want to allow for Number types.

Declaration

double? MaxValue { get; }

Property Value

Type	Description
Nullable<Double>	The maximum value, which will be null if not defined in the template.

MinLength

Gets an integer value that determines the smallest number of characters you want to allow for String types.

Declaration

int? MinLength { get; }

Property Value

Type	Description
Nullable<Int32>	The minimum length.

MinValue

Gets a numeric value that determines the smallest numeric value you want to allow for Number types.

Declaration

double? MinValue { get; }

Property Value

Type	Description
Nullable<Double>	The minimum value, which will be null if not defined in the template.

NoEcho

Gets a value indicating whether to mask the parameter value to prevent it from being displayed in the console, command line tools, or API.

Declaration

bool NoEcho { get; }

Property Value

Type	Description
Boolean	If true, user interfaces should redact the parameter value when displaying.

Type

Gets the data type for the parameter.

Declaration

string Type { get; }

Property Value

Type	Description
String	The AWS Parameter type.

Methods

GetClrType()

Gets the CLR type for the parameter given the AWS type specified for it in the template.

Declaration

Type GetClrType()

Returns

Type	Description
Type	CLR type

GetCurrentValue()

Gets the current value of the parameter choosing whatever value has been set and if none, the default.

Declaration

object GetCurrentValue()

Returns

Type	Description
Object	Current value.

SetCurrentValue(IDictionary<String, Object>)

Sets the current value of this parameter to use in evaluations.

Declaration

void SetCurrentValue(IDictionary<string, object> parameterValues)

Parameters

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

Exceptions

Type	Condition
InvalidCastException	Parameter Name - cannot assign array value to Number type Parameter Name - cannot assign value of type type to Number type Parameter Name - cannot assign value of type type to Number type Parameter Name - cannot assign value of type type to Number type Parameter Name - cannot assign array value to String type
ArgumentException	Parameter Name - Value 'value' does not match allowed values: string.Join(", ", AllowedValues) Parameter Name - Value 'value' does not match value constraint: MinValue <= x <= MaxValue Parameter Name - Value 'stringVal' does not match pattern: AllowedPattern Parameter Name - Value 'stringVal' does not match allowed values: AllowedValues