software.amazon.awscdk.core

Class CfnParameter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnParameter

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.3.2 (build 237c474)",
           date="2020-04-22T03:19:29.799Z")
 @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

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

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 initializationMode)
protected	CfnParameter(software.amazon.jsii.JsiiObjectRef objRef)

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

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

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, 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.JsiiObjectRef objRef)

CfnParameter

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

CfnParameter

@Stability(value=Stable)
public CfnParameter(@NotNull
                                             Construct scope,
                                             @NotNull
                                             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. This parameter is required.

id - This parameter is required.

props - The parameter properties.

CfnParameter

@Stability(value=Stable)
public CfnParameter(@NotNull
                                             Construct scope,
                                             @NotNull
                                             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. This parameter is required.

id - This parameter is required.

Method Detail

resolve

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

Parameters:

_context - This parameter is required.

getNoEcho

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

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

getValue

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

The parameter value as a Token.

getValueAsList

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

The parameter value, if it represents a string list.

getValueAsNumber

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

The parameter value, if it represents a number.

getValueAsString

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

The parameter value, if it represents a string.