aws-cdk-lib.aws_apigateway.CfnDocumentationPart.LocationProperty

interface LocationProperty

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnDocumentationPart.LocationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDocumentationPart_LocationProperty
Javasoftware.amazon.awscdk.services.apigateway.CfnDocumentationPart.LocationProperty
Pythonaws_cdk.aws_apigateway.CfnDocumentationPart.LocationProperty
TypeScript aws-cdk-lib » aws_apigateway » CfnDocumentationPart » LocationProperty

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const locationProperty: apigateway.CfnDocumentationPart.LocationProperty = {
  method: 'method',
  name: 'name',
  path: 'path',
  statusCode: 'statusCode',
  type: 'type',
};

Properties

NameTypeDescription
method?stringThe HTTP verb of a method.
name?stringThe name of the targeted API entity.
path?stringThe URL path of the target.
statusCode?stringThe HTTP status code of a response.
type?stringThe type of API entity to which the documentation content applies.

method?

Type: string (optional)

The HTTP verb of a method.

It is a valid field for the API entity types of METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.


name?

Type: string (optional)

The name of the targeted API entity.

It is a valid and required field for the API entity types of AUTHORIZER , MODEL , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY and RESPONSE_HEADER . It is an invalid field for any other entity type.


path?

Type: string (optional)

The URL path of the target.

It is a valid field for the API entity types of RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.


statusCode?

Type: string (optional)

The HTTP status code of a response.

It is a valid field for the API entity types of RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.


type?

Type: string (optional)

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

Valid values are API , AUTHORIZER , MODEL , RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . Content inheritance does not apply to any entity of the API , AUTHORIZER , METHOD , MODEL , REQUEST_BODY , or RESOURCE type.