software.amazon.awscdk.core

Class CfnParameterProps.Builder

java.lang.Object

software.amazon.awscdk.core.CfnParameterProps.Builder

Enclosing interface:

CfnParameterProps

@Stability(value=Stable)
public static final class CfnParameterProps.Builder
extends Object

A builder for CfnParameterProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnParameterProps	build() Builds the configured instance.
CfnParameterProps.Builder	withAllowedPattern(String value) Sets the value of AllowedPattern
CfnParameterProps.Builder	withAllowedValues(List<String> value) Sets the value of AllowedValues
CfnParameterProps.Builder	withConstraintDescription(String value) Sets the value of ConstraintDescription
CfnParameterProps.Builder	withDefault(Object value) Sets the value of Default
CfnParameterProps.Builder	withDescription(String value) Sets the value of Description
CfnParameterProps.Builder	withMaxLength(Number value) Sets the value of MaxLength
CfnParameterProps.Builder	withMaxValue(Number value) Sets the value of MaxValue
CfnParameterProps.Builder	withMinLength(Number value) Sets the value of MinLength
CfnParameterProps.Builder	withMinValue(Number value) Sets the value of MinValue
CfnParameterProps.Builder	withNoEcho(Boolean value) Sets the value of NoEcho
CfnParameterProps.Builder	withType(String value) Sets the value of Type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withAllowedPattern

@Stability(value=Stable)
public CfnParameterProps.Builder withAllowedPattern(@Nullable
                                                                             String value)

Sets the value of AllowedPattern

Parameters:

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

Returns:

this

withAllowedValues

@Stability(value=Stable)
public CfnParameterProps.Builder withAllowedValues(@Nullable
                                                                            List<String> value)

Sets the value of AllowedValues

Parameters:

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

Returns:

this

withConstraintDescription

@Stability(value=Stable)
public CfnParameterProps.Builder withConstraintDescription(@Nullable
                                                                                    String value)

Sets the value of ConstraintDescription

Parameters:

value - 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:.

Returns:

this

withDefault

@Stability(value=Stable)
public CfnParameterProps.Builder withDefault(@Nullable
                                                                      Object value)

Sets the value of Default

Parameters:

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

Returns:

this

withDescription

@Stability(value=Stable)
public CfnParameterProps.Builder withDescription(@Nullable
                                                                          String value)

Sets the value of Description

Parameters:

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

Returns:

this

withMaxLength

@Stability(value=Stable)
public CfnParameterProps.Builder withMaxLength(@Nullable
                                                                        Number value)

Sets the value of MaxLength

Parameters:

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

Returns:

this

withMaxValue

@Stability(value=Stable)
public CfnParameterProps.Builder withMaxValue(@Nullable
                                                                       Number value)

Sets the value of MaxValue

Parameters:

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

Returns:

this

withMinLength

@Stability(value=Stable)
public CfnParameterProps.Builder withMinLength(@Nullable
                                                                        Number value)

Sets the value of MinLength

Parameters:

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

Returns:

this

withMinValue

@Stability(value=Stable)
public CfnParameterProps.Builder withMinValue(@Nullable
                                                                       Number value)

Sets the value of MinValue

Parameters:

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

Returns:

this

withNoEcho

@Stability(value=Stable)
public CfnParameterProps.Builder withNoEcho(@Nullable
                                                                     Boolean value)

Sets the value of NoEcho

Parameters:

value - 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 (``*****``).

Returns:

this

withType

@Stability(value=Stable)
public CfnParameterProps.Builder withType(@Nullable
                                                                   String value)

Sets the value of Type

Parameters:

value - The data type for the parameter (DataType).

Returns:

this

build

@Stability(value=Stable)
public CfnParameterProps build()

Builds the configured instance.

Returns:

a new instance of CfnParameterProps

Throws:

NullPointerException - if any required attribute was not provided