CfnCondition
- class aws_cdk.CfnCondition(scope, id, *, expression=None)
Bases:
CfnElement
Represents a CloudFormation condition, for resources which must be conditionally created and the determination must be made at deploy time.
- ExampleMetadata:
infused
Example:
raw_bucket = s3.CfnBucket(self, "Bucket") # -or- raw_bucket_alt = my_bucket.node.default_child # then raw_bucket.cfn_options.condition = CfnCondition(self, "EnableBucket") raw_bucket.cfn_options.metadata = { "metadata_key": "MetadataValue" }
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.
- expression
The condition statement.
- 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)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
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 type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.