Interface CfnDocumentationPart.LocationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDocumentationPart.LocationProperty.Jsii$Proxy
- Enclosing class:
CfnDocumentationPart
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 software.amazon.awscdk.services.apigateway.*; LocationProperty locationProperty = LocationProperty.builder() .method("method") .name("name") .path("path") .statusCode("statusCode") .type("type") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDocumentationPart.LocationProperty
static final class
An implementation forCfnDocumentationPart.LocationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The HTTP verb of a method.default String
getName()
The name of the targeted API entity.default String
getPath()
The URL path of the target.default String
The HTTP status code of a response.default String
getType()
The type of API entity to which the documentation content applies.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getMethod
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
, andRESPONSE_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 otherlocation
attributes, the child entity'smethod
attribute must match that of the parent entity exactly.- See Also:
-
getName
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
andRESPONSE_HEADER
. It is an invalid field for any other entity type.- See Also:
-
getPath
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
, andRESPONSE_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 otherlocation
attributes, the child entity'spath
attribute must match that of the parent entity as a prefix.- See Also:
-
getStatusCode
The HTTP status code of a response.It is a valid field for the API entity types of
RESPONSE
,RESPONSE_HEADER
, andRESPONSE_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 otherlocation
attributes, the child entity'sstatusCode
attribute must match that of the parent entity exactly.- See Also:
-
getType
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
, andRESPONSE_BODY
. Content inheritance does not apply to any entity of theAPI
,AUTHORIZER
,METHOD
,MODEL
,REQUEST_BODY
, orRESOURCE
type.- See Also:
-
builder
-