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

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleRestApi = new aws.apigateway.RestApi("example", {name: "example_api"});
const example = new aws.apigateway.DocumentationPart("example", {
location: {
type: "METHOD",
method: "GET",
path: "/example",
},
properties: "{\"description\":\"Example description\"}",
restApiId: exampleRestApi.id,
});
import pulumi
import pulumi_aws as aws
example_rest_api = aws.apigateway.RestApi("example", name="example_api")
example = aws.apigateway.DocumentationPart("example",
location={
"type": "METHOD",
"method": "GET",
"path": "/example",
},
properties="{\"description\":\"Example description\"}",
rest_api_id=example_rest_api.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleRestApi = new Aws.ApiGateway.RestApi("example", new()
{
Name = "example_api",
});
var example = new Aws.ApiGateway.DocumentationPart("example", new()
{
Location = new Aws.ApiGateway.Inputs.DocumentationPartLocationArgs
{
Type = "METHOD",
Method = "GET",
Path = "/example",
},
Properties = "{\"description\":\"Example description\"}",
RestApiId = exampleRestApi.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleRestApi, err := apigateway.NewRestApi(ctx, "example", &apigateway.RestApiArgs{
Name: pulumi.String("example_api"),
})
if err != nil {
return err
}
_, err = apigateway.NewDocumentationPart(ctx, "example", &apigateway.DocumentationPartArgs{
Location: &apigateway.DocumentationPartLocationArgs{
Type: pulumi.String("METHOD"),
Method: pulumi.String("GET"),
Path: pulumi.String("/example"),
},
Properties: pulumi.String("{\"description\":\"Example description\"}"),
RestApiId: exampleRestApi.ID(),
})
if err != nil {
return err
}
return nil
})
}
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.RestApiArgs;
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", RestApiArgs.builder()
.name("example_api")
.build());
var example = new DocumentationPart("example", DocumentationPartArgs.builder()
.location(DocumentationPartLocationArgs.builder()
.type("METHOD")
.method("GET")
.path("/example")
.build())
.properties("{\"description\":\"Example description\"}")
.restApiId(exampleRestApi.id())
.build());
}
}
resources:
example:
type: aws:apigateway:DocumentationPart
properties:
location:
type: METHOD
method: GET
path: /example
properties: '{"description":"Example description"}'
restApiId: ${exampleRestApi.id}
exampleRestApi:
type: aws:apigateway:RestApi
name: example
properties:
name: example_api

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

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

Properties

Link copied to clipboard

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

Link copied to clipboard
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.

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

ID of the associated Rest API

Functions

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