software.amazon.awscdk.core

Class CfnParameter.Builder

java.lang.Object

software.amazon.awscdk.core.CfnParameter.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnParameter>

Enclosing class:

CfnParameter

@Stability(value=Stable)
public static final class CfnParameter.Builder
extends Object
implements software.amazon.jsii.Builder<CfnParameter>

A fluent builder for CfnParameter.

Method Summary

Modifier and Type	Method and Description
CfnParameter.Builder	allowedPattern(String allowedPattern) A regular expression that represents the patterns to allow for String types.
CfnParameter.Builder	allowedValues(List<String> allowedValues) An array containing the list of values allowed for the parameter.
CfnParameter	build()
CfnParameter.Builder	constraintDescription(String constraintDescription) A string that explains a constraint when the constraint is violated.
static CfnParameter.Builder	create(software.constructs.Construct scope, String id)
CfnParameter.Builder	defaultValue(Object defaultValue) A value of the appropriate type for the template to use if no value is specified when a stack is created.
CfnParameter.Builder	description(String description) A string of up to 4000 characters that describes the parameter.
CfnParameter.Builder	maxLength(Number maxLength) An integer value that determines the largest number of characters you want to allow for String types.
CfnParameter.Builder	maxValue(Number maxValue) A numeric value that determines the largest numeric value you want to allow for Number types.
CfnParameter.Builder	minLength(Number minLength) An integer value that determines the smallest number of characters you want to allow for String types.
CfnParameter.Builder	minValue(Number minValue) A numeric value that determines the smallest numeric value you want to allow for Number types.
CfnParameter.Builder	noEcho(Boolean noEcho) Whether to mask the parameter value when anyone makes a call that describes the stack.
CfnParameter.Builder	type(String type) The data type for the parameter (DataType).

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnParameter.Builder create(software.constructs.Construct scope,
                                                                   String id)

Parameters:

scope - The parent construct. This parameter is required.

id - This parameter is required.

Returns:

a new instance of CfnParameter.Builder.

allowedPattern

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

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

Default: - No constraints on patterns allowed for parameter.

Parameters:

allowedPattern - A regular expression that represents the patterns to allow for String types. This parameter is required.

Returns:

this

allowedValues

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

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

Default: - No constraints on values allowed for parameter.

Parameters:

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

Returns:

this

constraintDescription

@Stability(value=Stable)
public CfnParameter.Builder constraintDescription(String 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:

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

Parameters:

constraintDescription - A string that explains a constraint when the constraint is violated. This parameter is required.

Returns:

this

defaultValue

@Stability(value=Stable)
public CfnParameter.Builder defaultValue(Object 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.

Default: - No default value for parameter.

Parameters:

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

Returns:

this

description

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

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

Default: - No description for the parameter.

Parameters:

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

Returns:

this

maxLength

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

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

Default: - None.

Parameters:

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

Returns:

this

maxValue

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

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

Default: - None.

Parameters:

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

Returns:

this

minLength

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

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

Default: - None.

Parameters:

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

Returns:

this

minValue

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

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

Default: - None.

Parameters:

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

Returns:

this

noEcho

@Stability(value=Stable)
public CfnParameter.Builder noEcho(Boolean 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 (*****).

Default: - Parameter values are not masked.

Parameters:

noEcho - Whether to mask the parameter value when anyone makes a call that describes the stack. This parameter is required.

Returns:

this

type

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

The data type for the parameter (DataType).

Default: String

Parameters:

type - The data type for the parameter (DataType). This parameter is required.

Returns:

this

build

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

Specified by:

build in interface software.amazon.jsii.Builder<CfnParameter>