<a id="cli-aws-cloudfront-create-function"></a>

# create-function

## Description

Creates a CloudFront function.

To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.

When you create a function, it’s in the `DEVELOPMENT` stage. In this stage, you can test the function with `TestFunction` , and update it with `UpdateFunction` .

When you’re ready to use your function with a CloudFront distribution, use `PublishFunction` to copy the function from the `DEVELOPMENT` stage to `LIVE` . When it’s live, you can attach the function to a distribution’s cache behavior, using the function’s ARN.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/cloudfront-2020-05-31/CreateFunction)

## Synopsis

```
  create-function
--name <value>
--function-config <value>
--function-code <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--name` (string) [required]

> A name to identify the function.

> Constraints:

> * min: `1`
> * max: `64`
> * pattern: `[a-zA-Z0-9-_]{1,64}`

`--function-config` (structure) [required]

> Configuration information about the function, including an optional comment and the function’s runtime.

> Comment -> (string) [required]

> > A comment to describe the function.

> Runtime -> (string) [required]

> > The function’s runtime environment version.

> > Possible values:

> > * `cloudfront-js-1.0`
> > * `cloudfront-js-2.0`

> KeyValueStoreAssociations -> (structure)

> > The configuration for the key value store associations.

> > Quantity -> (integer) [required]

> > > The quantity of key value store associations.

> > Items -> (list)

> > > The items of the key value store association.

> > > (structure)

> > > > The key value store association.

> > > > KeyValueStoreARN -> (string) [required]

> > > > > The Amazon Resource Name (ARN) of the key value store association.

> > > > > Constraints:

> > > > > * min: `0`
> > > > > * max: `85`
> > > > > * pattern: `arn:aws:cloudfront::[0-9]{12}:key-value-store\/[0-9a-fA-F-]{36}`

JSON Syntax:

```json
{
  "Comment": "string",
  "Runtime": "cloudfront-js-1.0"|"cloudfront-js-2.0",
  "KeyValueStoreAssociations": {
    "Quantity": integer,
    "Items": [
      {
        "KeyValueStoreARN": "string"
      }
      ...
    ]
  }
}
```

`--function-code` (blob) [required]

> The function code. For more information about writing a CloudFront function, see [Writing function code for CloudFront Functions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) in the *Amazon CloudFront Developer Guide* .

> Constraints:

> * min: `1`
> * max: `40960`

`--tags` (structure)

> A complex type that contains zero or more `Tag` elements.

> Items -> (list)

> > A complex type that contains `Tag` elements.

> > (structure)

> > > A complex type that contains `Tag` key and `Tag` value.

> > > Key -> (string) [required]

> > > > A string that contains `Tag` key.

> > > > The string length should be between 1 and 128 characters. Valid characters include `a-z` , `A-Z` , `0-9` , space, and the special characters `_ - . : / = + @` .

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `128`
> > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`

> > > Value -> (string)

> > > > A string that contains an optional `Tag` value.

> > > > The string length should be between 0 and 256 characters. Valid characters include `a-z` , `A-Z` , `0-9` , space, and the special characters `_ - . : / = + @` .

> > > > Constraints:

> > > > * min: `0`
> > > > * max: `256`
> > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`

Shorthand Syntax:

```
Items=[{Key=string,Value=string},{Key=string,Value=string}]
```

JSON Syntax:

```json
{
  "Items": [
    {
      "Key": "string",
      "Value": "string"
    }
    ...
  ]
}
```

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

FunctionSummary -> (structure)

> Contains configuration information and metadata about a CloudFront function.

> Name -> (string) [required]

> > The name of the CloudFront function.

> > Constraints:

> > * min: `1`
> > * max: `64`
> > * pattern: `[a-zA-Z0-9-_]{1,64}`

> Status -> (string)

> > The status of the CloudFront function.

> FunctionConfig -> (structure) [required]

> > Contains configuration information about a CloudFront function.

> > Comment -> (string) [required]

> > > A comment to describe the function.

> > Runtime -> (string) [required]

> > > The function’s runtime environment version.

> > > Possible values:

> > > * `cloudfront-js-1.0`
> > > * `cloudfront-js-2.0`

> > KeyValueStoreAssociations -> (structure)

> > > The configuration for the key value store associations.

> > > Quantity -> (integer) [required]

> > > > The quantity of key value store associations.

> > > Items -> (list)

> > > > The items of the key value store association.

> > > > (structure)

> > > > > The key value store association.

> > > > > KeyValueStoreARN -> (string) [required]

> > > > > > The Amazon Resource Name (ARN) of the key value store association.

> > > > > > Constraints:

> > > > > > * min: `0`
> > > > > > * max: `85`
> > > > > > * pattern: `arn:aws:cloudfront::[0-9]{12}:key-value-store\/[0-9a-fA-F-]{36}`

> FunctionMetadata -> (structure) [required]

> > Contains metadata about a CloudFront function.

> > FunctionARN -> (string) [required]

> > > The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.

> > Stage -> (string)

> > > The stage that the function is in, either `DEVELOPMENT` or `LIVE` .

> > > When a function is in the `DEVELOPMENT` stage, you can test the function with `TestFunction` , and update it with `UpdateFunction` .

> > > When a function is in the `LIVE` stage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.

> > > Possible values:

> > > * `DEVELOPMENT`
> > > * `LIVE`

> > CreatedTime -> (timestamp)

> > > The date and time when the function was created.

> > LastModifiedTime -> (timestamp) [required]

> > > The date and time when the function was most recently updated.

Location -> (string)

> The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.

ETag -> (string)

> The version identifier for the current version of the CloudFront function.