software.amazon.awscdk

Class CfnParameter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnParameter

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:42.430Z")
 @Stability(value=Experimental)
public class CfnParameter
extends CfnElement

(experimental) A CloudFormation parameter.

Use the optional Parameters section to customize your templates. Parameters enable you to input custom values to your template each time you create or update a stack.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnParameter.Builder (experimental) A fluent builder for CfnParameter.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnParameter(software.constructs.Construct scope, String id) (experimental) Creates a parameter construct.
	CfnParameter(software.constructs.Construct scope, String id, CfnParameterProps props) (experimental) Creates a parameter construct.
protected	CfnParameter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnParameter(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAllowedPattern() (experimental) A regular expression that represents the patterns to allow for String types.
List<String>	getAllowedValues() (experimental) An array containing the list of values allowed for the parameter.
String	getConstraintDescription() (experimental) A string that explains a constraint when the constraint is violated.
Object	getDefaultValue() (experimental) A value of the appropriate type for the template to use if no value is specified when a stack is created.
String	getDescription() (experimental) A string of up to 4000 characters that describes the parameter.
Number	getMaxLength() (experimental) An integer value that determines the largest number of characters you want to allow for String types.
Number	getMaxValue() (experimental) A numeric value that determines the largest numeric value you want to allow for Number types.
Number	getMinLength() (experimental) An integer value that determines the smallest number of characters you want to allow for String types.
Number	getMinValue() (experimental) A numeric value that determines the smallest numeric value you want to allow for Number types.
Boolean	getNoEcho() (experimental) Indicates if this parameter is configured with "NoEcho" enabled.
String	getType() (experimental) The data type for the parameter (DataType).
IResolvable	getValue() (experimental) The parameter value as a Token.
List<String>	getValueAsList() (experimental) The parameter value, if it represents a string list.
Number	getValueAsNumber() (experimental) The parameter value, if it represents a number.
String	getValueAsString() (experimental) The parameter value, if it represents a string.
Object	resolve(IResolveContext _context)
void	setAllowedPattern(String value) (experimental) A regular expression that represents the patterns to allow for String types.
void	setAllowedValues(List<String> value) (experimental) An array containing the list of values allowed for the parameter.
void	setConstraintDescription(String value) (experimental) A string that explains a constraint when the constraint is violated.
void	setDefaultValue(Object value) (experimental) A value of the appropriate type for the template to use if no value is specified when a stack is created.
void	setDescription(String value) (experimental) A string of up to 4000 characters that describes the parameter.
void	setMaxLength(Number value) (experimental) An integer value that determines the largest number of characters you want to allow for String types.
void	setMaxValue(Number value) (experimental) A numeric value that determines the largest numeric value you want to allow for Number types.
void	setMinLength(Number value) (experimental) An integer value that determines the smallest number of characters you want to allow for String types.
void	setMinValue(Number value) (experimental) A numeric value that determines the smallest numeric value you want to allow for Number types.
void	setNoEcho(Boolean value) (experimental) Indicates if this parameter is configured with "NoEcho" enabled.
void	setType(String value) (experimental) The data type for the parameter (DataType).

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CfnParameter

protected CfnParameter(software.amazon.jsii.JsiiObjectRef objRef)

CfnParameter

protected CfnParameter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnParameter

@Stability(value=Experimental)
public CfnParameter(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @Nullable
                                                   CfnParameterProps props)

(experimental) Creates a parameter construct.

Note that the name (logical ID) of the parameter will derive from it's coname and location within the stack. Therefore, it is recommended that parameters are defined at the stack level.

Parameters:

scope - The parent construct. This parameter is required.

id - This parameter is required.

props - The parameter properties.

CfnParameter

@Stability(value=Experimental)
public CfnParameter(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id)

(experimental) Creates a parameter construct.

Note that the name (logical ID) of the parameter will derive from it's coname and location within the stack. Therefore, it is recommended that parameters are defined at the stack level.

Parameters:

scope - The parent construct. This parameter is required.

id - This parameter is required.

Method Detail

resolve

@Stability(value=Experimental)
 @NotNull
public Object resolve(@NotNull
                                                               IResolveContext _context)

Parameters:

_context - This parameter is required.

getValue

@Stability(value=Experimental)
 @NotNull
public IResolvable getValue()

(experimental) The parameter value as a Token.

getValueAsList

@Stability(value=Experimental)
 @NotNull
public List<String> getValueAsList()

(experimental) The parameter value, if it represents a string list.

getValueAsNumber

@Stability(value=Experimental)
 @NotNull
public Number getValueAsNumber()

(experimental) The parameter value, if it represents a number.

getValueAsString

@Stability(value=Experimental)
 @NotNull
public String getValueAsString()

(experimental) The parameter value, if it represents a string.

getDefaultValue

@Stability(value=Experimental)
 @NotNull
public Object getDefaultValue()

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

setDefaultValue

@Stability(value=Experimental)
public void setDefaultValue(@NotNull
                                                           Object value)

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

getNoEcho

@Stability(value=Experimental)
 @NotNull
public Boolean getNoEcho()

(experimental) Indicates if this parameter is configured with "NoEcho" enabled.

setNoEcho

@Stability(value=Experimental)
public void setNoEcho(@NotNull
                                                     Boolean value)

(experimental) Indicates if this parameter is configured with "NoEcho" enabled.

getType

@Stability(value=Experimental)
 @NotNull
public String getType()

(experimental) The data type for the parameter (DataType).

Default: String

setType

@Stability(value=Experimental)
public void setType(@NotNull
                                                   String value)

(experimental) The data type for the parameter (DataType).

Default: String

getAllowedPattern

@Stability(value=Experimental)
 @Nullable
public String getAllowedPattern()

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

Default: - No constraints on patterns allowed for parameter.

setAllowedPattern

@Stability(value=Experimental)
public void setAllowedPattern(@Nullable
                                                             String value)

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

Default: - No constraints on patterns allowed for parameter.

getAllowedValues

@Stability(value=Experimental)
 @Nullable
public List<String> getAllowedValues()

(experimental) An array containing the list of values allowed for the parameter.

Default: - No constraints on values allowed for parameter.

setAllowedValues

@Stability(value=Experimental)
public void setAllowedValues(@Nullable
                                                            List<String> value)

(experimental) An array containing the list of values allowed for the parameter.

Default: - No constraints on values allowed for parameter.

getConstraintDescription

@Stability(value=Experimental)
 @Nullable
public String getConstraintDescription()

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

setConstraintDescription

@Stability(value=Experimental)
public void setConstraintDescription(@Nullable
                                                                    String value)

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

getDescription

@Stability(value=Experimental)
 @Nullable
public String getDescription()

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

Default: - No description for the parameter.

setDescription

@Stability(value=Experimental)
public void setDescription(@Nullable
                                                          String value)

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

Default: - No description for the parameter.

getMaxLength

@Stability(value=Experimental)
 @Nullable
public Number getMaxLength()

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

Default: - None.

setMaxLength

@Stability(value=Experimental)
public void setMaxLength(@Nullable
                                                        Number value)

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

Default: - None.

getMaxValue

@Stability(value=Experimental)
 @Nullable
public Number getMaxValue()

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

Default: - None.

setMaxValue

@Stability(value=Experimental)
public void setMaxValue(@Nullable
                                                       Number value)

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

Default: - None.

getMinLength

@Stability(value=Experimental)
 @Nullable
public Number getMinLength()

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

Default: - None.

setMinLength

@Stability(value=Experimental)
public void setMinLength(@Nullable
                                                        Number value)

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

Default: - None.

getMinValue

@Stability(value=Experimental)
 @Nullable
public Number getMinValue()

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

Default: - None.

setMinValue

@Stability(value=Experimental)
public void setMinValue(@Nullable
                                                       Number value)

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

Default: - None.