Package 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(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 to which the documentation content applies.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMethod

@Stability(Stable)
@Nullable
default String 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 , 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-method

getName

@Stability(Stable)
@Nullable
default String 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 and RESPONSE_HEADER . It is an invalid field for any other entity type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-name

getPath

@Stability(Stable)
@Nullable
default String 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 , 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-path

getStatusCode

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-statuscode

getType

@Stability(Stable)
@Nullable
default String 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 , and RESPONSE_BODY . Content inheritance does not apply to any entity of the API , AUTHORIZER , METHOD , MODEL , REQUEST_BODY , or RESOURCE type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-type

builder

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

Returns:

a CfnDocumentationPart.LocationProperty.Builder of CfnDocumentationPart.LocationProperty