Class CfnParameterProps

Inheritance

System.Object

CfnParameterProps

Implements

ICfnParameterProps

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnParameterProps : Object, ICfnParameterProps

Syntax (vb)

Public Class CfnParameterProps
    Inherits Object
    Implements ICfnParameterProps

Remarks

ExampleMetadata: infused

Examples

var param = new CfnParameter(this, "ParameterName", new CfnParameterProps { });

// If the parameter is a String
param.ValueAsString;

// If the parameter is a Number
param.ValueAsNumber;

// If the parameter is a List
param.ValueAsList;

Synopsis

Constructors

CfnParameterProps()

Properties

AllowedPattern	A regular expression that represents the patterns to allow for String types.
AllowedValues	An array containing the list of values allowed for the parameter.
ConstraintDescription	A string that explains a constraint when the constraint is violated.
Default	A value of the appropriate type for the template to use if no value is specified when a stack is created.
Description	A string of up to 4000 characters that describes the parameter.
MaxLength	An integer value that determines the largest number of characters you want to allow for String types.
MaxValue	A numeric value that determines the largest numeric value you want to allow for Number types.
MinLength	An integer value that determines the smallest number of characters you want to allow for String types.
MinValue	A numeric value that determines the smallest numeric value you want to allow for Number types.
NoEcho	Whether to mask the parameter value when anyone makes a call that describes the stack.
Type	The data type for the parameter (DataType).

Constructors

CfnParameterProps()

public CfnParameterProps()

Properties

AllowedPattern

A regular expression that represents the patterns to allow for String types.

public string AllowedPattern { get; set; }

Property Value

System.String

Remarks

Default: - No constraints on patterns allowed for parameter.

AllowedValues

An array containing the list of values allowed for the parameter.

public string[] AllowedValues { get; set; }

Property Value

System.String[]

Remarks

Default: - No constraints on values allowed for parameter.

ConstraintDescription

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

public string ConstraintDescription { get; set; }

Property Value

System.String

Remarks

For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

Default: - No description with customized error message when user specifies invalid values.

Default

A value of the appropriate type for the template to use if no value is specified when a stack is created.

public object Default { get; set; }

Property Value

System.Object

Remarks

If you define constraints for the parameter, you must specify a value that adheres to those constraints.

Default: - No default value for parameter.

Description

A string of up to 4000 characters that describes the parameter.

public string Description { get; set; }

Property Value

System.String

Remarks

Default: - No description for the parameter.

MaxLength

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

public Nullable<double> MaxLength { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Default: - None.

MaxValue

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

public Nullable<double> MaxValue { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Default: - None.

MinLength

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

public Nullable<double> MinLength { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Default: - None.

MinValue

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

public Nullable<double> MinValue { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Default: - None.

NoEcho

Whether to mask the parameter value when anyone makes a call that describes the stack.

public Nullable<bool> NoEcho { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

If you set the value to true, the parameter value is masked with asterisks (*****).

Default: - Parameter values are not masked.

Type

The data type for the parameter (DataType).

public string Type { get; set; }

Property Value

System.String

Remarks

Default: String

Implements

ICfnParameterProps