Skip to content
AWS for Query.Farm

aws.cloudfront.describe_function

Example SQL Queries

SELECT * FROM
aws.cloudfront.describe_function
WHERE
"name" = 'VALUE';

Description

Gets configuration information and metadata about a CloudFront function, but not the function's code. To get a function's code, use GetFunction.

To get configuration information and metadata about a function, you must provide the function's name and stage. To get these values, you can use ListFunctions.

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the function that you are getting information about.

VARCHAR
stage Input Column

The function's stage, either DEVELOPMENT or LIVE.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

e_tag

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

VARCHAR
function_summary

Contains configuration information and metadata about a CloudFront function.

STRUCT(
    "name" VARCHAR,
    "status" VARCHAR,
    "function_config" STRUCT(
        "comment" VARCHAR,
        "runtime" VARCHAR,
        "key_value_store_associations" STRUCT(
            "quantity" BIGINT,
            "items" STRUCT(
                "key_value_store_arn" VARCHAR
            )[]
        )
    ),
    "function_metadata" STRUCT(
        "function_arn" VARCHAR,
        "stage" VARCHAR,
        "created_time" TIMESTAMP_S,
        "last_modified_time" TIMESTAMP_S
    )
)
Show child fields
function_summary.function_config

Contains configuration information about a CloudFront function.

Show child fields
function_summary.function_config.comment

A comment to describe the function.

function_summary.function_config.key_value_store_associations

The configuration for the key value store associations.

Show child fields
function_summary.function_config.key_value_store_associations.items[]
Show child fields
function_summary.function_config.key_value_store_associations.items[].key_value_store_arn

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

function_summary.function_config.key_value_store_associations.quantity

The quantity of key value store associations.

function_summary.function_config.runtime

The function's runtime environment version.

function_summary.function_metadata

Contains metadata about a CloudFront function.

Show child fields
function_summary.function_metadata.created_time

The date and time when the function was created.

function_summary.function_metadata.function_arn

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

function_summary.function_metadata.last_modified_time

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

function_summary.function_metadata.stage

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.

function_summary.name

The name of the CloudFront function.

function_summary.status

The status of the CloudFront function.