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.Builder	allowedPattern(String allowedPattern) Sets the value of CfnParameterProps.getAllowedPattern()
CfnParameterProps.Builder	allowedValues(List<String> allowedValues) Sets the value of CfnParameterProps.getAllowedValues()
CfnParameterProps	build() Builds the configured instance.
CfnParameterProps.Builder	constraintDescription(String constraintDescription) Sets the value of CfnParameterProps.getConstraintDescription()
CfnParameterProps.Builder	defaultValue(Object defaultValue) Sets the value of CfnParameterProps.getDefaultValue()
CfnParameterProps.Builder	description(String description) Sets the value of CfnParameterProps.getDescription()
CfnParameterProps.Builder	maxLength(Number maxLength) Sets the value of CfnParameterProps.getMaxLength()
CfnParameterProps.Builder	maxValue(Number maxValue) Sets the value of CfnParameterProps.getMaxValue()
CfnParameterProps.Builder	minLength(Number minLength) Sets the value of CfnParameterProps.getMinLength()
CfnParameterProps.Builder	minValue(Number minValue) Sets the value of CfnParameterProps.getMinValue()
CfnParameterProps.Builder	noEcho(Boolean noEcho) Sets the value of CfnParameterProps.getNoEcho()
CfnParameterProps.Builder	type(String type) Sets the value of CfnParameterProps.getType()

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

allowedPattern

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

Sets the value of CfnParameterProps.getAllowedPattern()

Parameters:

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

Returns:

this

allowedValues

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

Sets the value of CfnParameterProps.getAllowedValues()

Parameters:

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

Returns:

this

constraintDescription

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

Sets the value of CfnParameterProps.getConstraintDescription()

Parameters:

constraintDescription - 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

defaultValue

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

Sets the value of CfnParameterProps.getDefaultValue()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnParameterProps.getDescription()

Parameters:

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

Returns:

this

maxLength

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

Sets the value of CfnParameterProps.getMaxLength()

Parameters:

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

Returns:

this

maxValue

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

Sets the value of CfnParameterProps.getMaxValue()

Parameters:

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

Returns:

this

minLength

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

Sets the value of CfnParameterProps.getMinLength()

Parameters:

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

Returns:

this

minValue

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

Sets the value of CfnParameterProps.getMinValue()

Parameters:

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

Returns:

this

noEcho

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

Sets the value of CfnParameterProps.getNoEcho()

Parameters:

noEcho - 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

type

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

Sets the value of CfnParameterProps.getType()

Parameters:

type - 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