pulumi-aws-native-kotlin/com.pulumi.awsnative.apigateway.kotlin.inputs/DocumentationPartLocationArgs

DocumentationPartLocationArgs

data class DocumentationPartLocationArgs(val method: Output<String>? = null, val name: Output<String>? = null, val path: Output<String>? = null, val statusCode: Output<String>? = null, val type: Output<DocumentationPartLocationType>? = null) : ConvertibleToJava<DocumentationPartLocationArgs>

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.

Constructors

constructor(method: Output<String>? = null, name: Output<String>? = null, path: Output<String>? = null, statusCode: Output<String>? = null, type: Output<DocumentationPartLocationType>? = null)

Properties

method

val method: Output<String>? = null

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

val name: Output<String>? = null

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

val path: Output<String>? = null

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

val statusCode: Output<String>? = null

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

val type: Output<DocumentationPartLocationType>? = null

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.

Functions

toJava

open override fun toJava(): DocumentationPartLocationArgs