これは新しい CloudFormation テンプレートリファレンスガイドです。ブックマークとリンクを更新してください。CloudFormation の開始方法については、『[AWS CloudFormation ユーザーガイド](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)』を参照してください。

# `Fn::Length`
<a name="intrinsic-function-reference-length"></a>

組み込み関数 `Fn::Length` は、配列内の要素数を返すか、配列を返す組み込み関数を返します。

**重要**  
`Fn::Length` 組み込み関数を使用するには、[`AWS::LanguageExtensions` 変換](transform-aws-languageextensions.md) を使用する必要があります。

## 宣言
<a name="length-declaration"></a>

### JSON
<a name="intrinsic-function-reference-length-syntax.json"></a>

```
{ "Fn::Length" : IntrinsicFunction }
```

```
{ "Fn::Length" : Array }
```

### YAML
<a name="intrinsic-function-reference-length-syntax.yaml"></a>

```
Fn::Length : IntrinsicFunction
```

```
Fn::Length : Array
```

## パラメータ
<a name="length-parameters"></a>

`IntrinsicFunction`  
複数の要素を返す配列を返す組み込み関数。

`Array`  
要素数を返す配列。

## 戻り値
<a name="intrinsic-function-reference-length-return"></a>

配列を返す組み込み関数、または組み込み関数に渡された配列内の要素数。

## 例
<a name="intrinsic-function-reference-length-examples"></a>

### 配列を返す組み込み関数の要素数を返す
<a name="intrinsic-function-reference-length-example-subsection"></a>

このサンプルスニペットは、配列を返す組み込み関数の要素数を返します。この関数は 3 を返します。

#### JSON
<a name="intrinsic-function-reference-length-example.json"></a>

```
{
//...
    "Transform": "AWS::LanguageExtensions"
    //...
        "Fn::Length" : {
            "Fn::Split": ["|", "a|b|c"]
        }
//...
}
```

#### YAML
<a name="intrinsic-function-reference-legnth-example.yaml"></a>

```
Transform: 'AWS::LanguageExtensions'
#...
  Fn::Length: 
    !Split ["|", "a|b|c"]
#...
```

### リストパラメータ型を参照する Ref 組み込み関数の要素数を返す
<a name="intrinsic-function-reference-length-example2"></a>

このサンプルスニペットは、リストパラメータ型を参照する `Ref` 組み込み関数内の要素数を返します。`ListParameter` という名前の付いたパラメータが 3 つの要素からなるリストである場合は、関数は 3 を返します。

#### JSON
<a name="intrinsic-function-reference-length-example2.json"></a>

```
{
//...
    "Transform": "AWS::LanguageExtensions"
    //...
        "Fn::Length": {
            "Ref": "ListParameter"
        }
//...
}
```

#### YAML
<a name="intrinsic-function-reference-legnth-example2.yaml"></a>

```
Transform: 'AWS::LanguageExtensions'
#...
  Fn::Length: 
    !Ref ListParameter
#...
```

### 配列内の要素数を返す
<a name="intrinsic-function-reference-length-example3"></a>

このサンプルスニペットは、組み込み関数に渡された配列内の要素数を返します。この関数は 3 を返します。

#### JSON
<a name="intrinsic-function-reference-length-example3.json"></a>

```
 1. {
 2. //...
 3.     "Transform": "AWS::LanguageExtensions"
 4.     //...
 5.         "Fn::Length": [
 6.             1,
 7.             {"Ref": "ParameterName"}, 
 8.             3
 9.         ]
10. //...
11. }
```

#### YAML
<a name="intrinsic-function-reference-legnth-example3.yaml"></a>

```
Transform: 'AWS::LanguageExtensions'
#...
  Fn::Length: 
    - 1
    - !Ref ParameterName
    - 3
#...
```

## サポートされている関数
<a name="length-supported-functions"></a>

`Fn::Length` 組み込み関数または配列の中で、次の関数を使用できます。
+ `Condition Functions`
+ `Fn::Base64`
+ `Fn::FindInMap`
+ `Fn::Join`
+ `Fn::Length`
+ `Fn::Select`
+ `Fn::Split`
+ `Fn::Sub`
+ `Fn::ToJsonString`
+ `Ref`