software.amazon.awscdk

Interface CfnParameterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnParameterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.835Z")
 @Stability(value=Stable)
public interface CfnParameterProps
extends software.amazon.jsii.JsiiSerializable

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 CfnParameter.Builder.create(this, "MyParameter")
         .type("Number")
         .default(1337)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnParameterProps.Builder A builder for CfnParameterProps
static class	CfnParameterProps.Jsii$Proxy An implementation for CfnParameterProps

Method Summary

Modifier and Type	Method and Description
static CfnParameterProps.Builder	builder()
default String	getAllowedPattern() A regular expression that represents the patterns to allow for String types.
default List<String>	getAllowedValues() An array containing the list of values allowed for the parameter.
default String	getConstraintDescription() A string that explains a constraint when the constraint is violated.
default Object	getDefaultValue() A value of the appropriate type for the template to use if no value is specified when a stack is created.
default String	getDescription() A string of up to 4000 characters that describes the parameter.
default Number	getMaxLength() An integer value that determines the largest number of characters you want to allow for String types.
default Number	getMaxValue() A numeric value that determines the largest numeric value you want to allow for Number types.
default Number	getMinLength() An integer value that determines the smallest number of characters you want to allow for String types.
default Number	getMinValue() A numeric value that determines the smallest numeric value you want to allow for Number types.
default Boolean	getNoEcho() Whether to mask the parameter value when anyone makes a call that describes the stack.
default String	getType() The data type for the parameter (DataType).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllowedPattern

@Stability(value=Stable)
 @Nullable
default String getAllowedPattern()

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

Default: - No constraints on patterns allowed for parameter.

getAllowedValues

@Stability(value=Stable)
 @Nullable
default List<String> getAllowedValues()

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

Default: - No constraints on values allowed for parameter.

getConstraintDescription

@Stability(value=Stable)
 @Nullable
default String getConstraintDescription()

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

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.

getDefaultValue

@Stability(value=Stable)
 @Nullable
default Object getDefaultValue()

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.

Default: - No default value for parameter.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

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

Default: - No description for the parameter.

getMaxLength

@Stability(value=Stable)
 @Nullable
default Number getMaxLength()

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

Default: - None.

getMaxValue

@Stability(value=Stable)
 @Nullable
default Number getMaxValue()

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

Default: - None.

getMinLength

@Stability(value=Stable)
 @Nullable
default Number getMinLength()

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

Default: - None.

getMinValue

@Stability(value=Stable)
 @Nullable
default Number getMinValue()

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

Default: - None.

getNoEcho

@Stability(value=Stable)
 @Nullable
default Boolean getNoEcho()

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

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

Default: - Parameter values are not masked.

getType

@Stability(value=Stable)
 @Nullable
default String getType()

The data type for the parameter (DataType).

Default: String

builder

@Stability(value=Stable)
static CfnParameterProps.Builder builder()

Returns:

a CfnParameterProps.Builder of CfnParameterProps