Skip to content

RosCondition

Represents a RosTemplate condition, for resources which must be conditionally created and the determination must be made at deploy time.

Initializers 

import ros_cdk_core
ros_cdk_core.RosCondition(
  scope: Construct,
  id: str,
  expression: IRosConditionExpression = None
)
Name Type Description
scope Construct No description.
id str No description.
expression IRosConditionExpression The expression that the condition will evaluate.

scopeRequired

idRequired

  • Type: str

expressionOptional

The expression that the condition will evaluate.

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
resolve Synthesizes the condition.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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.

override_logical_id 

def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired

  • Type: str

The new logical ID to use for this stack element.

resolve 

def resolve(
  _context: IResolveContext
) -> typing.Any

Synthesizes the condition.

_contextRequired

Static Functions

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

is_construct 

import ros_cdk_core
ros_cdk_core.RosCondition.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

is_ros_element 

import ros_cdk_core
ros_cdk_core.RosCondition.is_ros_element(
  x: typing.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.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ConstructNode The construct tree node associated with this construct.
creation_stack typing.List[str] No description.
logical_id str The logical ID for this stack element.
stack Stack The stack in which this element is defined.
expression IRosConditionExpression The condition statement.

nodeRequired 

node: ConstructNode

The construct tree node associated with this construct.

creation_stackRequired 

creation_stack: typing.List[str]
  • Type: typing.List[str]

logical_idRequired 

logical_id: str
  • Type: str

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 

stack: Stack

The stack in which this element is defined.

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

expressionOptional 

expression: IRosConditionExpression

The condition statement.