software.amazon.awscdk.core

Class CfnCondition

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnCondition

All Implemented Interfaces:

ICfnConditionExpression, IConstruct, IDependable, IResolvable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:34.821Z")
public class CfnCondition
extends CfnElement
implements ICfnConditionExpression, IResolvable

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

Example:

 CfnBucket rawBucket = CfnBucket.Builder.create(this, "Bucket").build();
 // -or-
 CfnBucket rawBucketAlt = (CfnBucket)myBucket.getNode().getDefaultChild();
 // then
 rawBucket.getCfnOptions().getCondition() = CfnCondition.Builder.create(this, "EnableBucket").build();
 rawBucket.getCfnOptions().getMetadata() = Map.of(
         "metadataKey", "MetadataValue");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCondition.Builder A fluent builder for CfnCondition.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.ICfnConditionExpression

ICfnConditionExpression.Jsii$Default, ICfnConditionExpression.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CfnCondition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCondition(software.amazon.jsii.JsiiObjectRef objRef)
	CfnCondition(software.constructs.Construct scope, java.lang.String id) Build a new condition.
	CfnCondition(software.constructs.Construct scope, java.lang.String id, CfnConditionProps props) Build a new condition.

Method Summary

Modifier and Type	Method and Description
ICfnConditionExpression	getExpression() The condition statement.
java.lang.Object	resolve(IResolveContext _context) Synthesizes the condition.
void	setExpression(ICfnConditionExpression value) The condition statement.

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResolvable

getCreationStack, toString

Constructor Detail

CfnCondition

protected CfnCondition(software.amazon.jsii.JsiiObjectRef objRef)

CfnCondition

protected CfnCondition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCondition

public CfnCondition(software.constructs.Construct scope,
                    java.lang.String id,
                    CfnConditionProps props)

Build a new condition.

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

CfnCondition

public CfnCondition(software.constructs.Construct scope,
                    java.lang.String id)

Build a new condition.

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

resolve

public java.lang.Object resolve(IResolveContext _context)

Synthesizes the condition.

Specified by:

resolve in interface IResolvable

Parameters:

_context - This parameter is required.

getExpression

public ICfnConditionExpression getExpression()

The condition statement.

setExpression

public void setExpression(ICfnConditionExpression value)

The condition statement.