Skip to content

docs: document support for HTTP API Access Log Settings #1448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 20, 2020
Merged

docs: document support for HTTP API Access Log Settings #1448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion tests/translator/input/http_api_explicit_stage.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,7 @@ Resources:
MyApi:
Type: AWS::Serverless::HttpApi
Properties:
StageName: Prod
StageName: Prod
AccessLogSettings:
DestinationArn: arn:aws:logs:us-east-1:123456789012:log-group:LogGroupName
Format: $context.requestId
6 changes: 5 additions & 1 deletion tests/translator/output/aws-cn/http_api_explicit_stage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,11 @@
"Ref": "MyApi"
},
"AutoDeploy": true,
"StageName": "Prod"
"StageName": "Prod",
"AccessLogSettings": {
"DestinationArn": "arn:aws:logs:us-east-1:123456789012:log-group:LogGroupName",
"Format": "$context.requestId"
}
}
},
"HttpApiFunctionRole": {
Expand Down
6 changes: 5 additions & 1 deletion tests/translator/output/aws-us-gov/http_api_explicit_stage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,11 @@
"Ref": "MyApi"
},
"AutoDeploy": true,
"StageName": "Prod"
"StageName": "Prod",
"AccessLogSettings": {
"DestinationArn": "arn:aws:logs:us-east-1:123456789012:log-group:LogGroupName",
"Format": "$context.requestId"
}
}
},
"HttpApiFunctionRole": {
Expand Down
6 changes: 5 additions & 1 deletion tests/translator/output/http_api_explicit_stage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,11 @@
"Ref": "MyApi"
},
"AutoDeploy": true,
"StageName": "Prod"
"StageName": "Prod",
"AccessLogSettings": {
"DestinationArn": "arn:aws:logs:us-east-1:123456789012:log-group:LogGroupName",
"Format": "$context.requestId"
}
}
},
"HttpApiFunctionRole": {
Expand Down
1 change: 1 addition & 0 deletions versions/2016-10-31.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,7 @@ StageName | `string` | The name of the API stage. If a name is not given, SAM wi
DefinitionUri | `string` <span>&#124;</span> [S3 Location Object](#s3-location-object) | S3 URI or location to the Swagger document describing the API. If neither `DefinitionUri` nor `DefinitionBody` are specified, SAM will generate a `DefinitionBody` for you based on your template configuration. **Note** Intrinsic functions are not supported in external OpenApi files, instead use DefinitionBody to define OpenApi definition.
DefinitionBody | `JSON or YAML Object` | OpenApi specification that describes your API. If neither `DefinitionUri` nor `DefinitionBody` are specified, SAM will generate a `DefinitionBody` for you based on your template configuration.
Auth | [HTTP API Auth Object](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-httpapi-httpapiauth.html) | Configure authorization to control access to your API Gateway API.
AccessLogSettings | [AccessLogSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html) | Settings for logging access in a stage.

##### Return values

Expand Down