AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudfront ]

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

Synopsis

  create-function
--name <value>
--function-config <value>
--function-code <value>
[--cli-input-json <value>]
[--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>]

Options

--name (string)

A name to identify the function.

--function-config (structure)

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

Comment -> (string)

A comment to describe the function.

Runtime -> (string)

The function's runtime environment version.

KeyValueStoreAssociations -> (structure)

The configuration for the key value store associations.

Quantity -> (integer)

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)

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

JSON Syntax:

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

--function-code (blob)

The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--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.

Output

FunctionSummary -> (structure)

Contains configuration information and metadata about a CloudFront function.

Name -> (string)

The name of the CloudFront function.

Status -> (string)

The status of the CloudFront function.

FunctionConfig -> (structure)

Contains configuration information about a CloudFront function.

Comment -> (string)

A comment to describe the function.

Runtime -> (string)

The function's runtime environment version.

KeyValueStoreAssociations -> (structure)

The configuration for the key value store associations.

Quantity -> (integer)

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)

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

FunctionMetadata -> (structure)

Contains metadata about a CloudFront function.

FunctionARN -> (string)

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.

CreatedTime -> (timestamp)

The date and time when the function was created.

LastModifiedTime -> (timestamp)

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.