pulumi-aws-native-kotlin/com.pulumi.awsnative.apigateway.kotlin/DocumentationPartArgs

DocumentationPartArgs

data class DocumentationPartArgs(val location: Output<DocumentationPartLocationArgs>? = null, val properties: Output<String>? = null, val restApiId: Output<String>? = null) : ConvertibleToJava<DocumentationPartArgs>

The `AWS::ApiGateway::DocumentationPart` resource creates a documentation part for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide.

Constructors

Link copied to clipboard
fun DocumentationPartArgs(location: Output<DocumentationPartLocationArgs>? = null, properties: Output<String>? = null, restApiId: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): DocumentationPartArgs

Properties

Link copied to clipboard
val location: Output<DocumentationPartLocationArgs>? = null

The location of the targeted API entity of the to-be-created documentation part.

Link copied to clipboard
val properties: Output<String>? = null

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Link copied to clipboard
val restApiId: Output<String>? = null

The string identifier of the associated RestApi.