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

DocumentationPartArgs

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

Provides a settings of an API Gateway Documentation Part.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.RestApi;
import com.pulumi.aws.apigateway.DocumentationPart;
import com.pulumi.aws.apigateway.DocumentationPartArgs;
import com.pulumi.aws.apigateway.inputs.DocumentationPartLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var exampleRestApi = new RestApi("exampleRestApi");
        var exampleDocumentationPart = new DocumentationPart("exampleDocumentationPart", DocumentationPartArgs.builder()
            .location(DocumentationPartLocationArgs.builder()
                .type("METHOD")
                .method("GET")
                .path("/example")
                .build())
            .properties("{\"description\":\"Example description\"}")
            .restApiId(exampleRestApi.id())
            .build());
    }
}

Import

Using pulumi import, import API Gateway documentation_parts using REST-API-ID/DOC-PART-ID. For example:

$ pulumi import aws:apigateway/documentationPart:DocumentationPart example 5i4e1ko720/3oyy3t

Constructors

DocumentationPartArgs

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

Functions

toJava

open override fun toJava(): DocumentationPartArgs

Properties

location

val location: Output<DocumentationPartLocationArgs>? = null

Location of the targeted API entity of the to-be-created documentation part. See below.

properties

val properties: Output<String>? = null

Content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant key-value pairs can be exported and, hence, published.

restApiId

val restApiId: Output<String>? = null

ID of the associated Rest API