software.amazon.awscdk

Class CfnJson

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnJson

All Implemented Interfaces:

IResolvable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.812Z")
 @Stability(value=Stable)
public class CfnJson
extends software.constructs.Construct
implements IResolvable

Captures a synthesis-time JSON object a CloudFormation reference which resolves during deployment to the resolved values of the JSON object.

The main use case for this is to overcome a limitation in CloudFormation that does not allow using intrinsic functions as dictionary keys (because dictionary keys in JSON must be strings). Specifically this is common in IAM conditions such as StringEquals: { lhs: "rhs" } where you want "lhs" to be a reference.

This object is resolvable, so it can be used as a value.

This construct is backed by a custom resource.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 CfnParameter tagParam = new CfnParameter(this, "TagName");
 CfnJson stringEquals = CfnJson.Builder.create(this, "ConditionJson")
         .value(Map.of(
                 String.format("aws:PrincipalTag/%s", tagParam.getValueAsString()), true))
         .build();
 PrincipalBase principal = new AccountRootPrincipal().withConditions(Map.of(
         "StringEquals", stringEquals));
 Role.Builder.create(this, "MyRole").assumedBy(principal).build();
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResolvable

IResolvable.Jsii$Default, IResolvable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnJson(software.constructs.Construct scope, String id, CfnJsonProps props)
protected	CfnJson(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnJson(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
List<String>	getCreationStack() The creation stack of this resolvable which will be appended to errors thrown during resolution.
Reference	getValue() An Fn::GetAtt to the JSON object passed through `value` and resolved during synthesis.
Object	resolve(IResolveContext _) Produce the Token's value at resolution time.
String	toJSON() This is required in case someone JSON.stringifys an object which refrences this object.

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.IResolvable

toString

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CfnJson

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

CfnJson

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

CfnJson

@Stability(value=Stable)
public CfnJson(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id,
                                        @NotNull
                                        CfnJsonProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

resolve

@Stability(value=Stable)
 @NotNull
public Object resolve(@NotNull
                                                         IResolveContext _)

Produce the Token's value at resolution time.

Specified by:

resolve in interface IResolvable

Parameters:

_ - This parameter is required.

toJSON

@Stability(value=Stable)
 @NotNull
public String toJSON()

This is required in case someone JSON.stringifys an object which refrences this object. Otherwise, we'll get a cyclic JSON reference.

getCreationStack

@Stability(value=Stable)
 @NotNull
public List<String> getCreationStack()

The creation stack of this resolvable which will be appended to errors thrown during resolution.

This may return an array with a single informational element indicating how to get this property populated, if it was skipped for performance reasons.

Specified by:

getCreationStack in interface IResolvable

getValue

@Stability(value=Stable)
 @NotNull
public Reference getValue()

An Fn::GetAtt to the JSON object passed through `value` and resolved during synthesis.

Normally there is no need to use this property since CfnJson is an IResolvable, so it can be simply used as a value.