software.amazon.awscdk.core

Class CfnParameter

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnParameter

All Implemented Interfaces:

IConstruct, IDependable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.14.3 (build 1b1062d)",
           date="2019-08-14T08:10:20.270Z")
 @Stability(value=Stable)
public class CfnParameter
extends CfnElement

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/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Boolean	getNoEcho() Indicates if this parameter is configured with "NoEcho" enabled.
IResolvable	getValue() The parameter value as a Token.
List<String>	getValueAsList() The parameter value, if it represents a string list.
Number	getValueAsNumber() The parameter value, if it represents a string list.
String	getValueAsString() The parameter value, if it represents a string.
Object	resolve(IResolveContext _context)

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, prepare

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, synthesize, toString, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, 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.JsiiObject.InitializationMode mode)

CfnParameter

@Stability(value=Stable)
public CfnParameter(Construct scope,
                                             String id,
                                             @Nullable
                                             CfnParameterProps props)

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.

props - The parameter properties.

CfnParameter

@Stability(value=Stable)
public CfnParameter(Construct scope,
                                             String id)

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.

Method Detail

resolve

@Stability(value=Stable)
 @Nullable
public Object resolve(IResolveContext _context)

getNoEcho

@Stability(value=Stable)
public Boolean getNoEcho()

Indicates if this parameter is configured with "NoEcho" enabled.

getValue

@Stability(value=Stable)
public IResolvable getValue()

The parameter value as a Token.

getValueAsList

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

The parameter value, if it represents a string list.

getValueAsNumber

@Stability(value=Stable)
public Number getValueAsNumber()

The parameter value, if it represents a string list.

getValueAsString

@Stability(value=Stable)
public String getValueAsString()

The parameter value, if it represents a string.