github.com/muratcelep/terraform@v1.1.0-beta2-not-internal-4/website/docs/language/functions/filebase64.html.md (about)

     1  ---
     2  layout: "language"
     3  page_title: "filebase64 - Functions - Configuration Language"
     4  sidebar_current: "docs-funcs-file-filebase64"
     5  description: |-
     6    The filebase64 function reads the contents of the file at the given path and
     7    returns them as a base64-encoded string.
     8  ---
     9  
    10  # `filebase64` Function
    11  
    12  `filebase64` reads the contents of a file at the given path and returns them as
    13  a base64-encoded string.
    14  
    15  ```hcl
    16  filebase64(path)
    17  ```
    18  
    19  The result is a Base64 representation of the raw bytes in the given file.
    20  Strings in the Terraform language are sequences of Unicode characters, so
    21  Base64 is the standard way to represent raw binary data that cannot be
    22  interpreted as Unicode characters. Resource types that operate on binary
    23  data will accept this data encoded in Base64, thus avoiding the need to
    24  decode the result of this function.
    25  
    26  Terraform uses the "standard" Base64 alphabet as defined in
    27  [RFC 4648 section 4](https://tools.ietf.org/html/rfc4648#section-4).
    28  
    29  This function can be used only with functions that already exist as static
    30  files on disk at the beginning of a Terraform run. Language functions do not
    31  participate in the dependency graph, so this function cannot be used with
    32  files that are generated dynamically during a Terraform operation.
    33  
    34  ## Examples
    35  
    36  ```
    37  > filebase64("${path.module}/hello.txt")
    38  SGVsbG8gV29ybGQ=
    39  ```
    40  
    41  ## Related Functions
    42  
    43  * [`file`](./file.html) also reads the contents of a given file,
    44    but interprets the data as UTF-8 text and returns the result directly
    45    as a string, without any further encoding.
    46  * [`base64decode`](./base64decode.html) can decode a Base64 string representing
    47    bytes in UTF-8, but in practice `base64decode(filebase64(...))` is equivalent
    48    to the shorter expression `file(...)`.