software.amazon.awscdk.services.apigateway

Interface CfnDocumentationPart.LocationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentationPart.LocationProperty.Jsii$Proxy

Enclosing class:

CfnDocumentationPart

@Stability(value=Stable)
public static interface CfnDocumentationPart.LocationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.apigateway.*;
 LocationProperty locationProperty = LocationProperty.builder()
         .method("method")
         .name("name")
         .path("path")
         .statusCode("statusCode")
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDocumentationPart.LocationProperty.Builder A builder for CfnDocumentationPart.LocationProperty
static class	CfnDocumentationPart.LocationProperty.Jsii$Proxy An implementation for CfnDocumentationPart.LocationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDocumentationPart.LocationProperty.Builder	builder()
default String	getMethod() 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	getStatusCode() The HTTP status code of a response.
default String	getType() The type of API entity that the documentation content applies to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMethod

@Stability(value=Stable)
 @Nullable
default String getMethod()

The HTTP verb of a method.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

The name of the targeted API entity.

getPath

@Stability(value=Stable)
 @Nullable
default String getPath()

The URL path of the target.

getStatusCode

@Stability(value=Stable)
 @Nullable
default String getStatusCode()

The HTTP status code of a response.

getType

@Stability(value=Stable)
 @Nullable
default String getType()

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

builder

@Stability(value=Stable)
static CfnDocumentationPart.LocationProperty.Builder builder()

Returns:

a CfnDocumentationPart.LocationProperty.Builder of CfnDocumentationPart.LocationProperty