AWS::ApiGateway::DocumentationPart Location - AWS CloudFormation

AWS::ApiGateway::DocumentationPart Location

The Location property specifies the location of the Amazon API Gateway API entity that the documentation applies to. Location is a property of the AWS::ApiGateway::DocumentationPart resource.

Note

For more information about each property, including constraints and valid values, see DocumentationPart in the Amazon API Gateway REST API Reference.

Syntax

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

JSON

{ "Method" : String, "Name" : String, "Path" : String, "StatusCode" : String, "Type" : String }

YAML

Method: String Name: String Path: String StatusCode: String Type: String

Properties

Method

The HTTP verb of a method.

Required: No

Type: String

Update requires: Replacement

Name

The name of the targeted API entity.

Required: No

Type: String

Update requires: Replacement

Path

The URL path of the target.

Required: No

Type: String

Update requires: Replacement

StatusCode

The HTTP status code of a response.

Required: No

Type: String

Update requires: Replacement

Type

The type of API entity that the documentation content applies to.

Required: No

Type: String

Update requires: Replacement

See also