This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::ApiGateway::Stage AccessLogSetting
<a name="aws-properties-apigateway-stage-accesslogsetting"></a>

The `AccessLogSetting` property type specifies settings for logging access in this stage.

`AccessLogSetting` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.

## Syntax
<a name="aws-properties-apigateway-stage-accesslogsetting-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-apigateway-stage-accesslogsetting-syntax.json"></a>

```
{
  "[DestinationArn](#cfn-apigateway-stage-accesslogsetting-destinationarn)" : String,
  "[Format](#cfn-apigateway-stage-accesslogsetting-format)" : String
}
```

### YAML
<a name="aws-properties-apigateway-stage-accesslogsetting-syntax.yaml"></a>

```
  [DestinationArn](#cfn-apigateway-stage-accesslogsetting-destinationarn): String
  [Format](#cfn-apigateway-stage-accesslogsetting-format): String
```

## Properties
<a name="aws-properties-apigateway-stage-accesslogsetting-properties"></a>

`DestinationArn`  <a name="cfn-apigateway-stage-accesslogsetting-destinationarn"></a>
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-`. This parameter is required to enable access logging.  
*Required*: Conditional  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Format`  <a name="cfn-apigateway-stage-accesslogsetting-format"></a>
A single line format of the access logs of data, as specified by selected [\$1context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least `$context.requestId`. This parameter is required to enable access logging.  
*Required*: Conditional  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-apigateway-stage-accesslogsetting--seealso"></a>
+ [Stage](https://docs.aws.amazon.com/apigateway/latest/api/API_Stage.html) in the *Amazon API Gateway REST API Reference*