Interface ICfnParameterProps

Namespace

Amazon.CDK

Assembly

Amazon.CDK.dll

public interface ICfnParameterProps

Examples

new CfnParameter(this, "MyParameter", new CfnParameterProps {
                Type = "Number",
                Default = 1337
            });

Remarks

ExampleMetadata: infused

Properties

AllowedPattern

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

string? AllowedPattern { get; }

Property Value

string

Remarks

Default: - No constraints on patterns allowed for parameter.

AllowedValues

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

string[]? AllowedValues { get; }

Property Value

string[]

Remarks

Default: - No constraints on values allowed for parameter.

ConstraintDescription

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

string? ConstraintDescription { get; }

Property Value

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.

object? Default { get; }

Property Value

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.

string? Description { get; }

Property Value

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.

double? MaxLength { get; }

Property Value

double?

Remarks

Default: - None.

MaxValue

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

double? MaxValue { get; }

Property Value

double?

Remarks

Default: - None.

MinLength

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

double? MinLength { get; }

Property Value

double?

Remarks

Default: - None.

MinValue

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

double? MinValue { get; }

Property Value

double?

Remarks

Default: - None.

NoEcho

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

bool? NoEcho { get; }

Property Value

bool?

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).

string? Type { get; }

Property Value

string

Remarks

Default: String