RosCondition
- Implements: IRosConditionExpression, IResolvable
Represents a RosTemplate condition, for resources which must be conditionally created and the determination must be made at deploy time.
Initializers
import com.aliyun.ros.cdk.core.RosCondition;
RosCondition.Builder.create(Construct scope, java.lang.String id)
// .expression(IRosConditionExpression)
.build();
| Name | Type | Description |
|---|---|---|
scope |
Construct |
No description. |
id |
java.lang.String |
No description. |
expression |
IRosConditionExpression |
The expression that the condition will evaluate. |
scopeRequired
- Type: Construct
idRequired
- Type: java.lang.String
expressionOptional
- Type: IRosConditionExpression
- Default: None.
The expression that the condition will evaluate.
Methods
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
overrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
resolve |
Synthesizes the condition. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
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.
- Type: ISynthesisSession
The synthesis session.
overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: java.lang.String
The new logical ID to use for this stack element.
resolve
public java.lang.Object resolve(IResolveContext _context)
Synthesizes the condition.
- Type: IResolveContext
Static Functions
| Name | Description |
|---|---|
isConstruct |
Return whether the given object is a Construct. |
isRosElement |
Returns true if a construct is a stack element (i.e. part of the synthesized template). |
isConstruct
import com.aliyun.ros.cdk.core.RosCondition;
RosCondition.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
isRosElement
import com.aliyun.ros.cdk.core.RosCondition;
RosCondition.isRosElement(java.lang.Object x)
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.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node |
ConstructNode |
The construct tree node associated with this construct. |
creationStack |
java.util.List |
No description. |
logicalId |
java.lang.String |
The logical ID for this stack element. |
stack |
Stack |
The stack in which this element is defined. |
expression |
IRosConditionExpression |
The condition statement. |
nodeRequired
public ConstructNode getNode();
- Type: ConstructNode
The construct tree node associated with this construct.
creationStackRequired
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List
logicalIdRequired
public java.lang.String getLogicalId();
- Type: java.lang.String
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
public Stack getStack();
- Type: Stack
The stack in which this element is defined.
RosElements must be defined within a stack scope (directly or indirectly).
expressionOptional
public IRosConditionExpression getExpression();
- Type: IRosConditionExpression
The condition statement.