CfnCondition¶
-
class
aws_cdk.core.CfnCondition(scope, id, *, expression=None)¶ Bases:
aws_cdk.core.CfnElementRepresents a CloudFormation condition, for resources which must be conditionally created and the determination must be made at deploy time.
Build a new condition.
The condition must be constructed with a condition token, that the condition is based on.
- Parameters
scope (
Construct) –id (
str) –expression (
Optional[ICfnConditionExpression]) – The expression that the condition will evaluate. Default: - 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:
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.
- Return type
List[str]
-
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 type
str- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
node¶ The construct tree node associated with this construct.
- Return type
-
stack¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
Static Methods
-
classmethod
is_cfn_element(x)¶ Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any) –- Return type
bool- Returns
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