Assert

• Implements: IAssert

This class encapsulates and extends the ROS resource type ALIYUN::ROS::Assert.

Initializers

import ros_cdk_ros
ros_cdk_ros.Assert(
  scope: Construct,
  id: str,
  values: typing.Union[typing.List[typing.Any], IResolvable],
  abort_creation: typing.Union[bool, IResolvable] = None,
  error_message: typing.Union[str, IResolvable] = None,
  operation: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

values^Required

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property values: A list of values to assert.

The items in the list are compared in order. The range of length is one to three.

• Three values are supported only if the operation is Equal or NotEqual.
• One value is supported only if the operation is Not.

abort_creation^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property abortCreation: Whether to abort creation when the assert fails.

Default is True.

error_message^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property errorMessage: The error message to be returned when the assert fails.

operation^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property operation: The type of assertion to make.

The supported operations are: Equal, NotEqual, Greater, GreaterOrEqual, Less, LessOrEqual, Contain, NotContain, And, Or, Not. Default is Equal.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_ros
ros_cdk_ros.Assert.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_failure_cause^Required

attr_failure_cause: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute FailureCause: The reason the assertion failed.

attr_result^Required

attr_result: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Result: The result of the assert.

props^Required

props: AssertProps

• Type: AssertProps