com.hashicorp.cdktf.Fn Maven / Gradle / Ivy
Show all versions of cdktf Show documentation
package com.hashicorp.cdktf;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.102.0 (build e354887)", date = "2024-09-23T09:16:37.014Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = com.hashicorp.cdktf.$Module.class, fqn = "cdktf.Fn")
public class Fn extends com.hashicorp.cdktf.FnGenerated {
protected Fn(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected Fn(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Fn() {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this);
}
/**
* (experimental) {@link /terraform/docs/language/functions/bcrypt.html bcrypt} computes a hash of the given string using the Blowfish cipher, returning a string in [the _Modular Crypt Format_](https://passlib.readthedocs.io/en/stable/modular_crypt_format.html) usually expected in the shadow password file on many Unix systems.
*
* @param str This parameter is required.
* @param cost
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.lang.String bcrypt(final @org.jetbrains.annotations.NotNull java.lang.String str, final @org.jetbrains.annotations.Nullable java.lang.Number cost) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.Fn.class, "bcrypt", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(str, "str is required"), cost });
}
/**
* (experimental) {@link /terraform/docs/language/functions/bcrypt.html bcrypt} computes a hash of the given string using the Blowfish cipher, returning a string in [the _Modular Crypt Format_](https://passlib.readthedocs.io/en/stable/modular_crypt_format.html) usually expected in the shadow password file on many Unix systems.
*
* @param str This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.lang.String bcrypt(final @org.jetbrains.annotations.NotNull java.lang.String str) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.Fn.class, "bcrypt", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(str, "str is required") });
}
/**
* (experimental) {@link https://developer.hashicorp.com/terraform/language/expressions/conditionals} A conditional expression uses the value of a boolean expression to select one of two values.
*
* @param condition This parameter is required.
* @param trueValue This parameter is required.
* @param falseValue This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.lang.Object conditional(final @org.jetbrains.annotations.NotNull java.lang.Object condition, final @org.jetbrains.annotations.NotNull java.lang.Object trueValue, final @org.jetbrains.annotations.NotNull java.lang.Object falseValue) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.Fn.class, "conditional", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { condition, trueValue, falseValue });
}
/**
* (experimental) {@link /terraform/docs/language/functions/join.html join} produces a string by concatenating together all elements of a given list of strings with the given delimiter.
*
* @param separator This parameter is required.
* @param list This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.lang.String join(final @org.jetbrains.annotations.NotNull java.lang.String separator, final @org.jetbrains.annotations.NotNull java.util.List list) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.Fn.class, "join", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(separator, "separator is required"), java.util.Objects.requireNonNull(list, "list is required") });
}
/**
* (experimental) {@link /terraform/docs/language/functions/lookup.html lookup} retrieves the value of a single element from a map, given its key. If the given key does not exist, the given default value is returned instead.
*
* @param inputMap This parameter is required.
* @param key This parameter is required.
* @param defaultValue
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.lang.Object lookup(final @org.jetbrains.annotations.NotNull java.lang.Object inputMap, final @org.jetbrains.annotations.NotNull java.lang.String key, final @org.jetbrains.annotations.Nullable java.lang.Object defaultValue) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.Fn.class, "lookup", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { inputMap, java.util.Objects.requireNonNull(key, "key is required"), defaultValue });
}
/**
* (experimental) {@link /terraform/docs/language/functions/lookup.html lookup} retrieves the value of a single element from a map, given its key. If the given key does not exist, the given default value is returned instead.
*
* @param inputMap This parameter is required.
* @param key This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.lang.Object lookup(final @org.jetbrains.annotations.NotNull java.lang.Object inputMap, final @org.jetbrains.annotations.NotNull java.lang.String key) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.Fn.class, "lookup", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { inputMap, java.util.Objects.requireNonNull(key, "key is required") });
}
/**
* (experimental) returns a property access expression that accesses the property at the given path in the given inputMap.
*
* For example lookupNested(x, ["a", "b", "c"]) will return a Terraform expression like x["a"]["b"]["c"]
*
* @param inputMap This parameter is required.
* @param path This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.lang.Object lookupNested(final @org.jetbrains.annotations.NotNull java.lang.Object inputMap, final @org.jetbrains.annotations.NotNull java.util.List path) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.Fn.class, "lookupNested", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { inputMap, java.util.Objects.requireNonNull(path, "path is required") });
}
/**
* (experimental) {@link /terraform/docs/language/functions/range.html range} generates a list of numbers using a start value, a limit value, and a step value.
*
* @param start This parameter is required.
* @param limit This parameter is required.
* @param step
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.util.List range(final @org.jetbrains.annotations.NotNull java.lang.Number start, final @org.jetbrains.annotations.NotNull java.lang.Number limit, final @org.jetbrains.annotations.Nullable java.lang.Number step) {
return java.util.Collections.unmodifiableList(software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.Fn.class, "range", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)), new Object[] { java.util.Objects.requireNonNull(start, "start is required"), java.util.Objects.requireNonNull(limit, "limit is required"), step }));
}
/**
* (experimental) {@link /terraform/docs/language/functions/range.html range} generates a list of numbers using a start value, a limit value, and a step value.
*
* @param start This parameter is required.
* @param limit This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.util.List range(final @org.jetbrains.annotations.NotNull java.lang.Number start, final @org.jetbrains.annotations.NotNull java.lang.Number limit) {
return java.util.Collections.unmodifiableList(software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.Fn.class, "range", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)), new Object[] { java.util.Objects.requireNonNull(start, "start is required"), java.util.Objects.requireNonNull(limit, "limit is required") }));
}
/**
* (experimental) Use this function to wrap a string and escape it properly for the use in Terraform This is only needed in certain scenarios (e.g., if you have unescaped double quotes in the string).
*
* @param str This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.lang.String rawString(final @org.jetbrains.annotations.NotNull java.lang.String str) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.Fn.class, "rawString", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(str, "str is required") });
}
}