CfnCondition

class aws_cdk.core.CfnCondition(scope, id, *, expression=None)

Bases: aws_cdk.core.CfnElement

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

__init__(scope, id, *, expression=None)

Build a new condition.

The condition must be constructed with a condition token, that the condition is based on.

Parameters

• scope (Construct) –

• id (str) –

• props –

• expression (Optional[ICfnConditionExpression]) – The expression that the condition will evaluate. Default: - None.

Return type

None

Methods

override_logical_id(new_logical_id)

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

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

resolve(_context)

Synthesizes the condition.

Parameters

_context (IResolveContext) –

Return type

Any

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

creation_stack

return :rtype: List[str] :return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

expression

The condition statement.

Return type

Optional[ICfnConditionExpression]

logical_id

The logical ID for this CloudFormation 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).

return :rtype: str :return:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

stack

The stack in which this element is defined.

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

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

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

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

Parameters

x (Any) –

return :rtype: bool :return: The construct as a stack element or undefined if it is not a stack element.

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool