Class CfnDocumentationPart.LocationProperty
The Location property specifies the location of the Amazon API Gateway API entity that the documentation applies to.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class LocationProperty : Object, CfnDocumentationPart.ILocationPropertySyntax (vb)
Public Class LocationProperty
Inherits Object
Implements CfnDocumentationPart.ILocationPropertyRemarks
Location is a property of the AWS::ApiGateway::DocumentationPart resource.
For more information about each property, including constraints and valid values, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html">DocumentationPart</a> in the <em>Amazon API Gateway REST API Reference</em> .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;
var locationProperty = new LocationProperty {
Method = "method",
Name = "name",
Path = "path",
StatusCode = "statusCode",
Type = "type"
};Synopsis
Constructors
| LocationProperty() |
Properties
| Method | The HTTP verb of a method. |
| Name | The name of the targeted API entity. |
| Path | The URL path of the target. |
| StatusCode | The HTTP status code of a response. |
| Type | The type of API entity to which the documentation content applies. |
Constructors
LocationProperty()
public LocationProperty()Properties
Method
The HTTP verb of a method.
public string Method { get; set; }Property Value
System.String
Remarks
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
The name of the targeted API entity.
public string Name { get; set; }Property Value
System.String
Remarks
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
The URL path of the target.
public string Path { get; set; }Property Value
System.String
Remarks
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
The HTTP status code of a response.
public string StatusCode { get; set; }Property Value
System.String
Remarks
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
The type of API entity to which the documentation content applies.
public string Type { get; set; }Property Value
System.String
Remarks
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.