---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# aws_apigateway_stage{% #aws_apigateway_stage %}

## `access_log_settings`{% #access_log_settings %}

**Type**: `STRUCT`**Provider name**: `accessLogSettings`**Description**: Settings for logging access in this stage.

- `destination_arn`**Type**: `STRING`**Provider name**: `destinationArn`**Description**: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-`.
- `format`**Type**: `STRING`**Provider name**: `format`**Description**: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least `$context.requestId`.

## `account_id`{% #account_id %}

**Type**: `STRING`

## `cache_cluster_enabled`{% #cache_cluster_enabled %}

**Type**: `BOOLEAN`**Provider name**: `cacheClusterEnabled`**Description**: Specifies whether a cache cluster is enabled for the stage.

## `cache_cluster_size`{% #cache_cluster_size %}

**Type**: `STRING`**Provider name**: `cacheClusterSize`**Description**: The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).

## `cache_cluster_status`{% #cache_cluster_status %}

**Type**: `STRING`**Provider name**: `cacheClusterStatus`**Description**: The status of the cache cluster for the stage, if enabled.

## `canary_settings`{% #canary_settings %}

**Type**: `STRUCT`**Provider name**: `canarySettings`**Description**: Settings for the canary deployment in this stage.

- `deployment_id`**Type**: `STRING`**Provider name**: `deploymentId`**Description**: The ID of the canary deployment.
- `percent_traffic`**Type**: `DOUBLE`**Provider name**: `percentTraffic`**Description**: The percent (0-100) of traffic diverted to a canary deployment.
- `stage_variable_overrides`**Type**: `MAP_STRING_STRING`**Provider name**: `stageVariableOverrides`**Description**: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
- `use_stage_cache`**Type**: `BOOLEAN`**Provider name**: `useStageCache`**Description**: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

## `client_certificate_id`{% #client_certificate_id %}

**Type**: `STRING`**Provider name**: `clientCertificateId`**Description**: The identifier of a client certificate for an API stage.

## `created_date`{% #created_date %}

**Type**: `TIMESTAMP`**Provider name**: `createdDate`**Description**: The timestamp when the stage was created.

## `deployment_id`{% #deployment_id %}

**Type**: `STRING`**Provider name**: `deploymentId`**Description**: The identifier of the Deployment that the stage points to.

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: The stage's description.

## `documentation_version`{% #documentation_version %}

**Type**: `STRING`**Provider name**: `documentationVersion`**Description**: The version of the associated API documentation.

## `last_updated_date`{% #last_updated_date %}

**Type**: `TIMESTAMP`**Provider name**: `lastUpdatedDate`**Description**: The timestamp when the stage last updated.

## `method_settings`{% #method_settings %}

**Type**: `STRING`**Provider name**: `methodSettings`**Description**: A map that defines the method settings for a Stage resource. Keys (designated as `/{method_setting_key` below) are method paths defined as `{resource_path}/{http_method}` for an individual method override, or `/*/*` for overriding all methods in the stage.

## `stage_arn`{% #stage_arn %}

**Type**: `STRING`

## `stage_name`{% #stage_name %}

**Type**: `STRING`**Provider name**: `stageName`**Description**: The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `tracing_enabled`{% #tracing_enabled %}

**Type**: `BOOLEAN`**Provider name**: `tracingEnabled`**Description**: Specifies whether active tracing with X-ray is enabled for the Stage.

## `variables`{% #variables %}

**Type**: `MAP_STRING_STRING`**Provider name**: `variables`**Description**: A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match `[A-Za-z0-9-._~:/?#&=,]+`.

## `web_acl_arn`{% #web_acl_arn %}

**Type**: `STRING`**Provider name**: `webAclArn`**Description**: The ARN of the WebAcl associated with the Stage.
