Documentation
data class DocumentationVersionArgs(val description: Output<String>? = null, val restApiId: Output<String>? = null, val version: Output<String>? = null) : ConvertibleToJava<DocumentationVersionArgs>
Provides a resource to manage an API Gateway Documentation Version.
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 com.pulumi.aws.apigateway.DocumentationVersion;
import com.pulumi.aws.apigateway.DocumentationVersionArgs;
import com.pulumi.resources.CustomResourceOptions;
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("API")
.build())
.properties("{\"description\":\"Example\"}")
.restApiId(exampleRestApi.id())
.build());
var exampleDocumentationVersion = new DocumentationVersion("exampleDocumentationVersion", DocumentationVersionArgs.builder()
.version("example_version")
.restApiId(exampleRestApi.id())
.description("Example description")
.build(), CustomResourceOptions.builder()
.dependsOn(exampleDocumentationPart)
.build());
}
}Content copied to clipboard
Import
API Gateway documentation versions can be imported using REST-API-ID/VERSION, e.g.,
$ pulumi import aws:apigateway/documentationVersion:DocumentationVersion example 5i4e1ko720/example-versionContent copied to clipboard