RosParameter

A ROS parameter.

Parameters enable you to input custom values to your template each time you create or update a stack.

Initializers

import { RosParameter } from '@alicloud/ros-cdk-core'
new RosParameter(scope: Construct, id: string, props?: RosParameterProps)

Name	Type	Description
scope	Construct	No description.
id	string	No description.
props	RosParameterProps	No description.

---

scope^Required

• Type: Construct

---

id^Required

• Type: string

---

props^Optional

• Type: RosParameterProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resolve	No description.
validateProperties	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ISynthesisSession

The synthesis session.

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resolve

public resolve(_context: IResolveContext): any

_context^Required

• Type: IResolveContext

---

validateProperties

public validateProperties(props?: RosParameterProps): void

props^Optional

• Type: RosParameterProps

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.
isRosElement	Returns true if a construct is a stack element (i.e. part of the synthesized template).

---

isConstruct

import { RosParameter } from '@alicloud/ros-cdk-core'
RosParameter.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

isRosElement

import { RosParameter } from '@alicloud/ros-cdk-core'
RosParameter.isRosElement(x: any)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	ConstructNode	The construct tree node associated with this construct.
creationStack	string[]	No description.
logicalId	string	The logical ID for this stack element.
stack	Stack	The stack in which this element is defined.
noEcho	boolean	Indicates if this parameter is configured with "NoEcho" enabled.
value	IResolvable	The parameter value as a Token.
valueAsAny	any	The parameter value, if it represents a string.
valueAsBoolean	any	The parameter value, if it represents a string.
valueAsList	string[]	The parameter value, if it represents a string list.
valueAsNumber	number	The parameter value, if it represents a number.
valueAsString	string	The parameter value, if it represents a string.

---

node^Required

public readonly node: ConstructNode;

• Type: ConstructNode

The construct tree node associated with this construct.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

---

logicalId^Required

public readonly logicalId: string;

• Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

stack^Required

public readonly stack: Stack;

• Type: Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---

noEcho^Required

public readonly noEcho: boolean;

• Type: boolean

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

---

value^Required

public readonly value: IResolvable;

• Type: IResolvable

The parameter value as a Token.

---

valueAsAny^Required

public readonly valueAsAny: any;

• Type: any

The parameter value, if it represents a string.

---

valueAsBoolean^Required

public readonly valueAsBoolean: any;

• Type: any

The parameter value, if it represents a string.

---

valueAsList^Required

public readonly valueAsList: string[];

• Type: string[]

The parameter value, if it represents a string list.

---

valueAsNumber^Required

public readonly valueAsNumber: number;

• Type: number

The parameter value, if it represents a number.

---

valueAsString^Required

public readonly valueAsString: string;

• Type: string

The parameter value, if it represents a string.

---

Constants

Name	Type	Description
TYPE_ALLOWED_VALUES	string[]	No description.

---

TYPE_ALLOWED_VALUES^Required

public readonly TYPE_ALLOWED_VALUES: string[];

• Type: string[]

---