Fn (software.amazon.awscdk:core 1.16.2.DEVPREVIEW API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.core.Fn

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable
```
@Generated(value="jsii-pacmak/0.20.4 (build 96d89e1)",
           date="2019-11-12T11:54:39.749Z")
 @Stability(value=Stable)
public class Fn
extends software.amazon.jsii.JsiiObject
```
CloudFormation intrinsic functions. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html.

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Fn(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`Fn(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`base64(String data)` The intrinsic function ``Fn::Base64`` returns the Base64 representation of the input string.
`static List<String>`	`cidr(String ipBlock, Number count)` The intrinsic function ``Fn::Cidr`` returns the specified Cidr address block.
`static List<String>`	`cidr(String ipBlock, Number count, String sizeMask)` The intrinsic function ``Fn::Cidr`` returns the specified Cidr address block.
`static ICfnConditionExpression`	`conditionAnd(ICfnConditionExpression... conditions)` Returns true if all the specified conditions evaluate to true, or returns false if any one of the conditions evaluates to false.
`static ICfnConditionExpression`	`conditionContains(List<String> listOfStrings, String value)` Returns true if a specified string matches at least one value in a list of strings.
`static ICfnConditionExpression`	`conditionEachMemberEquals(List<String> listOfStrings, String value)` Returns true if a specified string matches all values in a list.
`static ICfnConditionExpression`	`conditionEachMemberIn(List<String> stringsToCheck, List<String> stringsToMatch)` Returns true if each member in a list of strings matches at least one value in a second list of strings.
`static ICfnConditionExpression`	`conditionEquals(Object lhs, Object rhs)` Compares if two values are equal.
`static ICfnConditionExpression`	`conditionIf(String conditionId, Object valueIfTrue, Object valueIfFalse)` Returns one value if the specified condition evaluates to true and another value if the specified condition evaluates to false.
`static ICfnConditionExpression`	`conditionNot(ICfnConditionExpression condition)` Returns true for a condition that evaluates to false or returns false for a condition that evaluates to true.
`static ICfnConditionExpression`	`conditionOr(ICfnConditionExpression... conditions)` Returns true if any one of the specified conditions evaluate to true, or returns false if all of the conditions evaluates to false.
`static String`	`findInMap(String mapName, String topLevelKey, String secondLevelKey)` The intrinsic function ``Fn::FindInMap`` returns the value corresponding to keys in a two-level map that is declared in the Mappings section.
`static IResolvable`	`getAtt(String logicalNameOfResource, String attributeName)` The ``Fn::GetAtt`` intrinsic function returns the value of an attribute from a resource in the template.
`static List<String>`	`getAzs()` The intrinsic function ``Fn::GetAZs`` returns an array that lists Availability Zones for a specified region.
`static List<String>`	`getAzs(String region)` The intrinsic function ``Fn::GetAZs`` returns an array that lists Availability Zones for a specified region.
`static String`	`importValue(String sharedValueToImport)` The intrinsic function ``Fn::ImportValue`` returns the value of an output exported by another stack.
`static String`	`join(String delimiter, List<String> listOfValues)` The intrinsic function ``Fn::Join`` appends a set of values into a single value, separated by the specified delimiter.
`static List<String>`	`refAll(String parameterType)` Returns all values for a specified parameter type.
`static String`	`select(Number index, List<String> array)` The intrinsic function ``Fn::Select`` returns a single object from a list of objects by index.
`static List<String>`	`split(String delimiter, String source)` To split a string into a list of string values so that you can select an element from the resulting string list, use the ``Fn::Split`` intrinsic function.
`static String`	`sub(String body)` The intrinsic function ``Fn::Sub`` substitutes variables in an input string with values that you specify.
`static String`	`sub(String body, Map<String,String> variables)` The intrinsic function ``Fn::Sub`` substitutes variables in an input string with values that you specify.
`static String`	`valueOf(String parameterOrLogicalId, String attribute)` Returns an attribute value or list of values for a specific parameter and attribute.
`static List<String>`	`valueOfAll(String parameterType, String attribute)` Returns a list of all attribute values for a given parameter type and attribute.

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Constructor Detail
  - Fn
```
protected Fn(software.amazon.jsii.JsiiObjectRef objRef)
```
  - Fn
```
protected Fn(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
- Method Detail
  - base64
```
@Stability(value=Stable)
public static String base64(String data)
```
    The intrinsic function ``Fn::Base64`` returns the Base64 representation of the input string. This function is typically used to pass encoded data to Amazon EC2 instances by way of the UserData property.
    
    Parameters:
    
    data - The string value you want to convert to Base64. This parameter is required.
    
    Returns:
    
    a token represented as a string
  - cidr
```
@Stability(value=Stable)
public static List<String> cidr(String ipBlock,
                                                         Number count,
                                                         String sizeMask)
```
    The intrinsic function ``Fn::Cidr`` returns the specified Cidr address block.
    
    Parameters:
    
    ipBlock - The user-specified default Cidr address block. This parameter is required.
    
    count - The number of subnets' Cidr block wanted. This parameter is required.
    
    sizeMask - The digit covered in the subnet.
    
    Returns:
    
    a token represented as a string
  - cidr
```
@Stability(value=Stable)
public static List<String> cidr(String ipBlock,
                                                         Number count)
```
    The intrinsic function ``Fn::Cidr`` returns the specified Cidr address block.
    
    Parameters:
    
    ipBlock - The user-specified default Cidr address block. This parameter is required.
    
    count - The number of subnets' Cidr block wanted. This parameter is required.
    
    Returns:
    
    a token represented as a string
  - conditionAnd
```
@Stability(value=Stable)
public static ICfnConditionExpression conditionAnd(ICfnConditionExpression... conditions)
```
    Returns true if all the specified conditions evaluate to true, or returns false if any one of the conditions evaluates to false. ``Fn::And`` acts as an AND operator. The minimum number of conditions that you can include is 2, and the maximum is 10.
    
    Parameters:
    
    conditions - conditions to AND. This parameter is required.
    
    Returns:
    
    an FnCondition token
  - conditionContains
```
@Stability(value=Stable)
public static ICfnConditionExpression conditionContains(List<String> listOfStrings,
                                                                                 String value)
```
    Returns true if a specified string matches at least one value in a list of strings.
    
    Parameters:
    
    listOfStrings - A list of strings, such as "A", "B", "C". This parameter is required.
    
    value - A string, such as "A", that you want to compare against a list of strings. This parameter is required.
    
    Returns:
    
    an FnCondition token
  - conditionEachMemberEquals
```
@Stability(value=Stable)
public static ICfnConditionExpression conditionEachMemberEquals(List<String> listOfStrings,
                                                                                         String value)
```
    Returns true if a specified string matches all values in a list.
    
    Parameters:
    
    listOfStrings - A list of strings, such as "A", "B", "C". This parameter is required.
    
    value - A string, such as "A", that you want to compare against a list of strings. This parameter is required.
    
    Returns:
    
    an FnCondition token
  - conditionEachMemberIn
```
@Stability(value=Stable)
public static ICfnConditionExpression conditionEachMemberIn(List<String> stringsToCheck,
                                                                                     List<String> stringsToMatch)
```
    Returns true if each member in a list of strings matches at least one value in a second list of strings.
    
    Parameters:
    
    stringsToCheck - A list of strings, such as "A", "B", "C". This parameter is required.
    
    stringsToMatch - A list of strings, such as "A", "B", "C". This parameter is required.
    
    Returns:
    
    an FnCondition token
  - conditionEquals
```
@Stability(value=Stable)
public static ICfnConditionExpression conditionEquals(Object lhs,
                                                                               Object rhs)
```
    Compares if two values are equal. Returns true if the two values are equal or false if they aren't.
    
    Parameters:
    
    lhs - A value of any type that you want to compare. This parameter is required.
    
    rhs - A value of any type that you want to compare. This parameter is required.
    
    Returns:
    
    an FnCondition token
  - conditionIf
```
@Stability(value=Stable)
public static ICfnConditionExpression conditionIf(String conditionId,
                                                                           Object valueIfTrue,
                                                                           Object valueIfFalse)
```
    Returns one value if the specified condition evaluates to true and another value if the specified condition evaluates to false. Currently, AWS CloudFormation supports the ``Fn::If`` intrinsic function in the metadata attribute, update policy attribute, and property values in the Resources section and Outputs sections of a template. You can use the AWS::NoValue pseudo parameter as a return value to remove the corresponding property.
    
    Parameters:
    
    conditionId - A reference to a condition in the Conditions section. This parameter is required.
    
    valueIfTrue - A value to be returned if the specified condition evaluates to true. This parameter is required.
    
    valueIfFalse - A value to be returned if the specified condition evaluates to false. This parameter is required.
    
    Returns:
    
    an FnCondition token
  - conditionNot
```
@Stability(value=Stable)
public static ICfnConditionExpression conditionNot(ICfnConditionExpression condition)
```
    Returns true for a condition that evaluates to false or returns false for a condition that evaluates to true. ``Fn::Not`` acts as a NOT operator.
    
    Parameters:
    
    condition - A condition such as ``Fn::Equals`` that evaluates to true or false. This parameter is required.
    
    Returns:
    
    an FnCondition token
  - conditionOr
```
@Stability(value=Stable)
public static ICfnConditionExpression conditionOr(ICfnConditionExpression... conditions)
```
    Returns true if any one of the specified conditions evaluate to true, or returns false if all of the conditions evaluates to false. ``Fn::Or`` acts as an OR operator. The minimum number of conditions that you can include is 2, and the maximum is 10.
    
    Parameters:
    
    conditions - conditions that evaluates to true or false. This parameter is required.
    
    Returns:
    
    an FnCondition token
  - findInMap
```
@Stability(value=Stable)
public static String findInMap(String mapName,
                                                        String topLevelKey,
                                                        String secondLevelKey)
```
    The intrinsic function ``Fn::FindInMap`` returns the value corresponding to keys in a two-level map that is declared in the Mappings section.
    
    Parameters:
    
    mapName - This parameter is required.
    
    topLevelKey - This parameter is required.
    
    secondLevelKey - This parameter is required.
    
    Returns:
    
    a token represented as a string
  - getAtt
```
@Stability(value=Stable)
public static IResolvable getAtt(String logicalNameOfResource,
                                                          String attributeName)
```
    The ``Fn::GetAtt`` intrinsic function returns the value of an attribute from a resource in the template.
    
    Parameters:
    
    logicalNameOfResource - The logical name (also called logical ID) of the resource that contains the attribute that you want. This parameter is required.
    
    attributeName - The name of the resource-specific attribute whose value you want. This parameter is required.
    
    Returns:
    
    an IResolvable object
  - getAzs
```
@Stability(value=Stable)
public static List<String> getAzs(String region)
```
    The intrinsic function ``Fn::GetAZs`` returns an array that lists Availability Zones for a specified region. Because customers have access to different Availability Zones, the intrinsic function ``Fn::GetAZs`` enables template authors to write templates that adapt to the calling user's access. That way you don't have to hard-code a full list of Availability Zones for a specified region.
    
    Parameters:
    
    region - The name of the region for which you want to get the Availability Zones.
    
    Returns:
    
    a token represented as a string array
  - getAzs
```
@Stability(value=Stable)
public static List<String> getAzs()
```
    The intrinsic function ``Fn::GetAZs`` returns an array that lists Availability Zones for a specified region. Because customers have access to different Availability Zones, the intrinsic function ``Fn::GetAZs`` enables template authors to write templates that adapt to the calling user's access. That way you don't have to hard-code a full list of Availability Zones for a specified region.
    
    Returns:
    
    a token represented as a string array
  - importValue
```
@Stability(value=Stable)
public static String importValue(String sharedValueToImport)
```
    The intrinsic function ``Fn::ImportValue`` returns the value of an output exported by another stack. You typically use this function to create cross-stack references. In the following example template snippets, Stack A exports VPC security group values and Stack B imports them.
    
    Parameters:
    
    sharedValueToImport - The stack output value that you want to import. This parameter is required.
    
    Returns:
    
    a token represented as a string
  - join
```
@Stability(value=Stable)
public static String join(String delimiter,
                                                   List<String> listOfValues)
```
    The intrinsic function ``Fn::Join`` appends a set of values into a single value, separated by the specified delimiter. If a delimiter is the empty string, the set of values are concatenated with no delimiter.
    
    Parameters:
    
    delimiter - The value you want to occur between fragments. This parameter is required.
    
    listOfValues - The list of values you want combined. This parameter is required.
    
    Returns:
    
    a token represented as a string
  - refAll
```
@Stability(value=Stable)
public static List<String> refAll(String parameterType)
```
    Returns all values for a specified parameter type.
    
    Parameters:
    
    parameterType - An AWS-specific parameter type, such as AWS::EC2::SecurityGroup::Id or AWS::EC2::VPC::Id. This parameter is required.
    
    Returns:
    
    a token represented as a string array
  - select
```
@Stability(value=Stable)
public static String select(Number index,
                                                     List<String> array)
```
    The intrinsic function ``Fn::Select`` returns a single object from a list of objects by index.
    
    Parameters:
    
    index - The index of the object to retrieve. This parameter is required.
    
    array - The list of objects to select from. This parameter is required.
    
    Returns:
    
    a token represented as a string
  - split
```
@Stability(value=Stable)
public static List<String> split(String delimiter,
                                                          String source)
```
    To split a string into a list of string values so that you can select an element from the resulting string list, use the ``Fn::Split`` intrinsic function. Specify the location of splits with a delimiter, such as , (a comma). After you split a string, use the ``Fn::Select`` function to pick a specific element.
    
    Parameters:
    
    delimiter - A string value that determines where the source string is divided. This parameter is required.
    
    source - The string value that you want to split. This parameter is required.
    
    Returns:
    
    a token represented as a string array
  - sub
```
@Stability(value=Stable)
public static String sub(String body,
                                                  Map<String,String> variables)
```
    The intrinsic function ``Fn::Sub`` substitutes variables in an input string with values that you specify. In your templates, you can use this function to construct commands or outputs that include values that aren't available until you create or update a stack.
    
    Parameters:
    
    body - A string with variables that AWS CloudFormation substitutes with their associated values at runtime. This parameter is required.
    
    variables - The name of a variable that you included in the String parameter.
    
    Returns:
    
    a token represented as a string
  - sub
```
@Stability(value=Stable)
public static String sub(String body)
```
    The intrinsic function ``Fn::Sub`` substitutes variables in an input string with values that you specify. In your templates, you can use this function to construct commands or outputs that include values that aren't available until you create or update a stack.
    
    Parameters:
    
    body - A string with variables that AWS CloudFormation substitutes with their associated values at runtime. This parameter is required.
    
    Returns:
    
    a token represented as a string
  - valueOf
```
@Stability(value=Stable)
public static String valueOf(String parameterOrLogicalId,
                                                      String attribute)
```
    Returns an attribute value or list of values for a specific parameter and attribute.
    
    Parameters:
    
    parameterOrLogicalId - The name of a parameter for which you want to retrieve attribute values. This parameter is required.
    
    attribute - The name of an attribute from which you want to retrieve a value. This parameter is required.
    
    Returns:
    
    a token represented as a string
  - valueOfAll
```
@Stability(value=Stable)
public static List<String> valueOfAll(String parameterType,
                                                               String attribute)
```
    Returns a list of all attribute values for a given parameter type and attribute.
    
    Parameters:
    
    parameterType - An AWS-specific parameter type, such as AWS::EC2::SecurityGroup::Id or AWS::EC2::VPC::Id. This parameter is required.
    
    attribute - The name of an attribute from which you want to retrieve a value. This parameter is required.
    
    Returns:
    
    a token represented as a string array

Class Fn

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Constructor Detail

Fn

Fn

Method Detail

base64

cidr

cidr

conditionAnd

conditionContains

conditionEachMemberEquals

conditionEachMemberIn

conditionEquals

conditionIf

conditionNot

conditionOr

findInMap

getAtt

getAzs

getAzs

importValue

join

refAll

select

split

sub

sub

valueOf

valueOfAll