Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. apigateway
  5. DocumentationPart
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

aws.apigateway.DocumentationPart

Explore with Pulumi AI

aws logo
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

    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)

    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
	})
}

    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 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

    Create DocumentationPart Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DocumentationPart(name: string, args: DocumentationPartArgs, opts?: CustomResourceOptions);
    @overload
def DocumentationPart(resource_name: str,
                      args: DocumentationPartArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def DocumentationPart(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      location: Optional[DocumentationPartLocationArgs] = None,
                      properties: Optional[str] = None,
                      rest_api_id: Optional[str] = None)
    func NewDocumentationPart(ctx *Context, name string, args DocumentationPartArgs, opts ...ResourceOption) (*DocumentationPart, error)
    public DocumentationPart(string name, DocumentationPartArgs args, CustomResourceOptions? opts = null)
    public DocumentationPart(String name, DocumentationPartArgs args)
public DocumentationPart(String name, DocumentationPartArgs args, CustomResourceOptions options)

    type: aws:apigateway:DocumentationPart
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DocumentationPartArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DocumentationPartArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DocumentationPartArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DocumentationPartArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DocumentationPartArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var documentationPartResource = new Aws.ApiGateway.DocumentationPart("documentationPartResource", new()
{
    Location = new Aws.ApiGateway.Inputs.DocumentationPartLocationArgs
    {
        Type = "string",
        Method = "string",
        Name = "string",
        Path = "string",
        StatusCode = "string",
    },
    Properties = "string",
    RestApiId = "string",
});

    example, err := apigateway.NewDocumentationPart(ctx, "documentationPartResource", &apigateway.DocumentationPartArgs{
	Location: &apigateway.DocumentationPartLocationArgs{
		Type:       pulumi.String("string"),
		Method:     pulumi.String("string"),
		Name:       pulumi.String("string"),
		Path:       pulumi.String("string"),
		StatusCode: pulumi.String("string"),
	},
	Properties: pulumi.String("string"),
	RestApiId:  pulumi.String("string"),
})

    var documentationPartResource = new DocumentationPart("documentationPartResource", DocumentationPartArgs.builder()
    .location(DocumentationPartLocationArgs.builder()
        .type("string")
        .method("string")
        .name("string")
        .path("string")
        .statusCode("string")
        .build())
    .properties("string")
    .restApiId("string")
    .build());

    documentation_part_resource = aws.apigateway.DocumentationPart("documentationPartResource",
    location={
        "type": "string",
        "method": "string",
        "name": "string",
        "path": "string",
        "status_code": "string",
    },
    properties="string",
    rest_api_id="string")

    const documentationPartResource = new aws.apigateway.DocumentationPart("documentationPartResource", {
    location: {
        type: "string",
        method: "string",
        name: "string",
        path: "string",
        statusCode: "string",
    },
    properties: "string",
    restApiId: "string",
});

    type: aws:apigateway:DocumentationPart
properties:
    location:
        method: string
        name: string
        path: string
        statusCode: string
        type: string
    properties: string
    restApiId: string

    DocumentationPart Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DocumentationPart resource accepts the following input properties:

    Location DocumentationPartLocation
    Location of the targeted API entity of the to-be-created documentation part. See below.
    Properties string
    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 string
    ID of the associated Rest API
    Location DocumentationPartLocationArgs
    Location of the targeted API entity of the to-be-created documentation part. See below.
    Properties string
    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 string
    ID of the associated Rest API
    location DocumentationPartLocation
    Location of the targeted API entity of the to-be-created documentation part. See below.
    properties String
    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 String
    ID of the associated Rest API
    location DocumentationPartLocation
    Location of the targeted API entity of the to-be-created documentation part. See below.
    properties string
    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 string
    ID of the associated Rest API
    location DocumentationPartLocationArgs
    Location of the targeted API entity of the to-be-created documentation part. See below.
    properties str
    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.
    rest_api_id str
    ID of the associated Rest API
    location Property Map
    Location of the targeted API entity of the to-be-created documentation part. See below.
    properties String
    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 String
    ID of the associated Rest API

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DocumentationPart resource produces the following output properties:

    DocumentationPartId string
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    DocumentationPartId string
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    documentationPartId String
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    id String
    The provider-assigned unique ID for this managed resource.
    documentationPartId string
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    id string
    The provider-assigned unique ID for this managed resource.
    documentation_part_id str
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    id str
    The provider-assigned unique ID for this managed resource.
    documentationPartId String
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DocumentationPart Resource

    Get an existing DocumentationPart resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DocumentationPartState, opts?: CustomResourceOptions): DocumentationPart
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        documentation_part_id: Optional[str] = None,
        location: Optional[DocumentationPartLocationArgs] = None,
        properties: Optional[str] = None,
        rest_api_id: Optional[str] = None) -> DocumentationPart
    func GetDocumentationPart(ctx *Context, name string, id IDInput, state *DocumentationPartState, opts ...ResourceOption) (*DocumentationPart, error)
    public static DocumentationPart Get(string name, Input<string> id, DocumentationPartState? state, CustomResourceOptions? opts = null)
    public static DocumentationPart get(String name, Output<String> id, DocumentationPartState state, CustomResourceOptions options)
    resources:  _:    type: aws:apigateway:DocumentationPart    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DocumentationPartId string
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    Location DocumentationPartLocation
    Location of the targeted API entity of the to-be-created documentation part. See below.
    Properties string
    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 string
    ID of the associated Rest API
    DocumentationPartId string
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    Location DocumentationPartLocationArgs
    Location of the targeted API entity of the to-be-created documentation part. See below.
    Properties string
    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 string
    ID of the associated Rest API
    documentationPartId String
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    location DocumentationPartLocation
    Location of the targeted API entity of the to-be-created documentation part. See below.
    properties String
    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 String
    ID of the associated Rest API
    documentationPartId string
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    location DocumentationPartLocation
    Location of the targeted API entity of the to-be-created documentation part. See below.
    properties string
    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 string
    ID of the associated Rest API
    documentation_part_id str
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    location DocumentationPartLocationArgs
    Location of the targeted API entity of the to-be-created documentation part. See below.
    properties str
    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.
    rest_api_id str
    ID of the associated Rest API
    documentationPartId String
    The DocumentationPart identifier, generated by API Gateway when the documentation part is created.
    location Property Map
    Location of the targeted API entity of the to-be-created documentation part. See below.
    properties String
    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 String
    ID of the associated Rest API

    Supporting Types

    DocumentationPartLocation, DocumentationPartLocationArgs

    Type string
    Type of API entity to which the documentation content appliesE.g., API, METHOD or REQUEST_BODY
    Method string
    HTTP verb of a method. The default value is * for any method.
    Name string
    Name of the targeted API entity.
    Path string
    URL path of the target. The default value is / for the root resource.
    StatusCode string
    HTTP status code of a response. The default value is * for any status code.
    Type string
    Type of API entity to which the documentation content appliesE.g., API, METHOD or REQUEST_BODY
    Method string
    HTTP verb of a method. The default value is * for any method.
    Name string
    Name of the targeted API entity.
    Path string
    URL path of the target. The default value is / for the root resource.
    StatusCode string
    HTTP status code of a response. The default value is * for any status code.
    type String
    Type of API entity to which the documentation content appliesE.g., API, METHOD or REQUEST_BODY
    method String
    HTTP verb of a method. The default value is * for any method.
    name String
    Name of the targeted API entity.
    path String
    URL path of the target. The default value is / for the root resource.
    statusCode String
    HTTP status code of a response. The default value is * for any status code.
    type string
    Type of API entity to which the documentation content appliesE.g., API, METHOD or REQUEST_BODY
    method string
    HTTP verb of a method. The default value is * for any method.
    name string
    Name of the targeted API entity.
    path string
    URL path of the target. The default value is / for the root resource.
    statusCode string
    HTTP status code of a response. The default value is * for any status code.
    type str
    Type of API entity to which the documentation content appliesE.g., API, METHOD or REQUEST_BODY
    method str
    HTTP verb of a method. The default value is * for any method.
    name str
    Name of the targeted API entity.
    path str
    URL path of the target. The default value is / for the root resource.
    status_code str
    HTTP status code of a response. The default value is * for any status code.
    type String
    Type of API entity to which the documentation content appliesE.g., API, METHOD or REQUEST_BODY
    method String
    HTTP verb of a method. The default value is * for any method.
    name String
    Name of the targeted API entity.
    path String
    URL path of the target. The default value is / for the root resource.
    statusCode String
    HTTP status code of a response. The default value is * for any status code.

    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
    pulumi/pulumi-aws