Package software.amazon.awscdk

Class Intrinsic

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Intrinsic
All Implemented Interfaces:
IResolvable, software.amazon.jsii.JsiiSerializable
Direct Known Subclasses:
CfnDynamicReference, Reference, SecretValue
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:01.624Z") @Stability(Stable) public class Intrinsic extends software.amazon.jsii.JsiiObject implements IResolvable
Token subclass that represents values intrinsic to the target document language.

WARNING: this class should not be externally exposed, but is currently visible because of a limitation of jsii (https://github.com/aws/jsii/issues/524).

This class will disappear in a future release and should not be used.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 Object value;
 Intrinsic intrinsic = Intrinsic.Builder.create(value)
         .stackTrace(false)
         .typeHint(ResolutionTypeHint.STRING)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Intrinsic.Builder
    A fluent builder for Intrinsic.

    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

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    Intrinsic(Object value)
     
     
    Intrinsic(Object value, IntrinsicProps options)
     
    protected
    Intrinsic(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Intrinsic(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getCreationStack()
    The captured stack trace which represents the location in which this token was created.
    ResolutionTypeHint
    getTypeHint()
    Type that the Intrinsic is expected to evaluate to.
    protected Object
    newError(String message)
    Creates a throwable Error object that contains the token creation stack trace.
    Object
    resolve(IResolveContext _context)
    Produce the Token's value at resolution time.
    Object
    toJSON()
    Turn this Token into JSON.
    String
    toString()
    Convert an instance of this Token to a string.
    List<String>
    toStringList()
    Convert an instance of this Token to a string list.

    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.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Intrinsic

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

    • Intrinsic

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

    • Intrinsic

      @Stability(Stable) public Intrinsic(@NotNull Object value, @Nullable IntrinsicProps options)
      Parameters:
      value - This parameter is required.
      options -

    • Intrinsic

      @Stability(Stable) public Intrinsic(@NotNull Object value)
      Parameters:
      value - This parameter is required.

  • Method Details

    • newError

      @Stability(Stable) @NotNull protected Object newError(@NotNull String message)
      Creates a throwable Error object that contains the token creation stack trace.

      Parameters:
      message - Error message. This parameter is required.

    • resolve

      @Stability(Stable) @NotNull public Object resolve(@NotNull IResolveContext _context)
      Produce the Token's value at resolution time.

      Specified by:
      resolve in interface IResolvable
      Parameters:
      _context - This parameter is required.

    • toJSON

      @Stability(Stable) @NotNull public Object toJSON()
      Turn this Token into JSON.

      Called automatically when JSON.stringify() is called on a Token.

    • toString

      @Stability(Stable) @NotNull public String toString()
      Convert an instance of this Token to a string.

      This method will be called implicitly by language runtimes if the object is embedded into a string. We treat it the same as an explicit stringification.

      Specified by:
      toString in interface IResolvable
      Overrides:
      toString in class Object

    • toStringList

      @Stability(Stable) @NotNull public List<String> toStringList()
      Convert an instance of this Token to a string list.

      This method will be called implicitly by language runtimes if the object is embedded into a list. We treat it the same as an explicit stringification.

    • getCreationStack

      @Stability(Stable) @NotNull public List<String> getCreationStack()
      The captured stack trace which represents the location in which this token was created.
      Specified by:
      getCreationStack in interface IResolvable

    • getTypeHint

      @Stability(Stable) @Nullable public ResolutionTypeHint getTypeHint()
      Type that the Intrinsic is expected to evaluate to.
      Specified by:
      getTypeHint in interface IResolvable