RosParameter

A ROS parameter.

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

Initializers

using AlibabaCloud.SDK.ROS.CDK.Core;
new RosParameter(Construct Scope, string Id, RosParameterProps Props = null);

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

private string ToString()

Returns a string representation of this construct.

Synthesize

private void Synthesize(ISynthesisSession Session)

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

private void OverrideLogicalId(string NewLogicalId)

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

private object Resolve(IResolveContext Context)

Context^Required

• Type: IResolveContext

---

ValidateProperties

private void ValidateProperties(RosParameterProps Props = null)

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

using AlibabaCloud.SDK.ROS.CDK.Core;
RosParameter.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

---

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Core;
RosParameter.IsRosElement(object X);

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: object

---

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	bool	Indicates if this parameter is configured with "NoEcho" enabled.
Value	IResolvable	The parameter value as a Token.
ValueAsAny	object	The parameter value, if it represents a string.
ValueAsBoolean	object	The parameter value, if it represents a string.
ValueAsList	string[]	The parameter value, if it represents a string list.
ValueAsNumber	double	The parameter value, if it represents a number.
ValueAsString	string	The parameter value, if it represents a string.

---

Node^Required

public ConstructNode Node { get; }

• Type: ConstructNode

The construct tree node associated with this construct.

---

CreationStack^Required

public string[] CreationStack { get; }

• Type: string[]

---

LogicalId^Required

public string LogicalId { get; }

• 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 Stack Stack { get; }

• Type: Stack

The stack in which this element is defined.

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

---

NoEcho^Required

public bool NoEcho { get; }

• Type: bool

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

---

Value^Required

public IResolvable Value { get; }

• Type: IResolvable

The parameter value as a Token.

---

ValueAsAny^Required

public object ValueAsAny { get; }

• Type: object

The parameter value, if it represents a string.

---

ValueAsBoolean^Required

public object ValueAsBoolean { get; }

• Type: object

The parameter value, if it represents a string.

---

ValueAsList^Required

public string[] ValueAsList { get; }

• Type: string[]

The parameter value, if it represents a string list.

---

ValueAsNumber^Required

public double ValueAsNumber { get; }

• Type: double

The parameter value, if it represents a number.

---

ValueAsString^Required

public string ValueAsString { get; }

• Type: string

The parameter value, if it represents a string.

---

Constants

Name	Type	Description
TypeAllowedValues	string[]	No description.

---

TypeAllowedValues^Required

public string[] TypeAllowedValues { get; }

• Type: string[]

---