Skip to content

RosParameter

A ROS parameter.

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

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore"
alicloudroscdkcore.NewRosParameter(scope Construct, id *string, props RosParameterProps) RosParameter
Name Type Description
scope Construct No description.
id *string No description.
props RosParameterProps No description.

scopeRequired


idRequired

  • Type: *string

propsOptional


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

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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.

sessionRequired

The synthesis session.


OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired

  • Type: *string

The new logical ID to use for this stack element.


Resolve

func Resolve(_context IResolveContext) interface{}

_contextRequired


ValidateProperties

func ValidateProperties(props RosParameterProps)

propsOptional


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 "github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore"
alicloudroscdkcore.RosParameter_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

IsRosElement

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore"
alicloudroscdkcore.RosParameter_IsRosElement(x interface{}) *bool

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.

xRequired

  • Type: interface{}

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 interface{} The parameter value, if it represents a string.
ValueAsBoolean interface{} The parameter value, if it represents a string.
ValueAsList []string The parameter value, if it represents a string list.
ValueAsNumber *f64 The parameter value, if it represents a number.
ValueAsString *string The parameter value, if it represents a string.

NodeRequired

func Node() ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

func CreationStack() *[]*string
  • Type: []string

LogicalIdRequired

func 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).


StackRequired

func Stack() Stack

The stack in which this element is defined.

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


NoEchoRequired

func NoEcho() *bool
  • Type: *bool

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


ValueRequired

func Value() IResolvable

The parameter value as a Token.


ValueAsAnyRequired

func ValueAsAny() interface{}
  • Type: interface{}

The parameter value, if it represents a string.


ValueAsBooleanRequired

func ValueAsBoolean() interface{}
  • Type: interface{}

The parameter value, if it represents a string.


ValueAsListRequired

func ValueAsList() *[]*string
  • Type: []string

The parameter value, if it represents a string list.


ValueAsNumberRequired

func ValueAsNumber() *f64
  • Type: *f64

The parameter value, if it represents a number.


ValueAsStringRequired

func ValueAsString() *string
  • Type: *string

The parameter value, if it represents a string.


Constants

Name Type Description
TypeAllowedValues []string No description.

TypeAllowedValuesRequired

func TypeAllowedValues() *[]*string
  • Type: []string