DocumentationVersion class

Provides a resource to manage an API Gateway Documentation Version.

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 exampleDocumentationPart = new aws.apigateway.DocumentationPart("example", {
    location: {
        type: "API",
    },
    properties: "{\"description\":\"Example\"}",
    restApiId: exampleRestApi.id,
});
const example = new aws.apigateway.DocumentationVersion("example", {
    version: "example_version",
    restApiId: exampleRestApi.id,
    description: "Example description",
}, {
    dependsOn: [exampleDocumentationPart],
});
import pulumi
import pulumi_aws as aws

example_rest_api = aws.apigateway.RestApi("example", name="example_api")
example_documentation_part = aws.apigateway.DocumentationPart("example",
    location={
        "type": "API",
    },
    properties="{\"description\":\"Example\"}",
    rest_api_id=example_rest_api.id)
example = aws.apigateway.DocumentationVersion("example",
    version="example_version",
    rest_api_id=example_rest_api.id,
    description="Example description",
    opts = pulumi.ResourceOptions(depends_on=[example_documentation_part]))
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 exampleDocumentationPart = new Aws.ApiGateway.DocumentationPart("example", new()
    {
        Location = new Aws.ApiGateway.Inputs.DocumentationPartLocationArgs
        {
            Type = "API",
        },
        Properties = "{\"description\":\"Example\"}",
        RestApiId = exampleRestApi.Id,
    });

    var example = new Aws.ApiGateway.DocumentationVersion("example", new()
    {
        Version = "example_version",
        RestApiId = exampleRestApi.Id,
        Description = "Example description",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleDocumentationPart,
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
		}
		exampleDocumentationPart, err := apigateway.NewDocumentationPart(ctx, "example", &apigateway.DocumentationPartArgs{
			Location: &apigateway.DocumentationPartLocationArgs{
				Type: pulumi.String("API"),
			},
			Properties: pulumi.String("{\"description\":\"Example\"}"),
			RestApiId:  exampleRestApi.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewDocumentationVersion(ctx, "example", &apigateway.DocumentationVersionArgs{
			Version:     pulumi.String("example_version"),
			RestApiId:   exampleRestApi.ID().ToIDOutput().ToStringOutput(),
			Description: pulumi.String("Example description"),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleDocumentationPart,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_apigateway_documentationversion" "example" {
  depends_on  = [aws_apigateway_documentationpart.example]
  version     = "example_version"
  rest_api_id = aws_apigateway_restapi.example.id
  description = "Example description"
}
resource "aws_apigateway_restapi" "example" {
  name = "example_api"
}
resource "aws_apigateway_documentationpart" "example" {
  location = {
    type = "API"
  }
  properties  = "{\"description\":\"Example\"}"
  rest_api_id = aws_apigateway_restapi.example.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 com.pulumi.aws.apigateway.DocumentationVersion;
import com.pulumi.aws.apigateway.DocumentationVersionArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
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 exampleDocumentationPart = new DocumentationPart("exampleDocumentationPart", DocumentationPartArgs.builder()
            .location(DocumentationPartLocationArgs.builder()
                .type("API")
                .build())
            .properties("{\"description\":\"Example\"}")
            .restApiId(exampleRestApi.id())
            .build());

        var example = new DocumentationVersion("example", DocumentationVersionArgs.builder()
            .version("example_version")
            .restApiId(exampleRestApi.id())
            .description("Example description")
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleDocumentationPart)
                .build());

    }
}
resources:
  example:
    type: aws:apigateway:DocumentationVersion
    properties:
      version: example_version
      restApiId: ${exampleRestApi.id}
      description: Example description
    options:
      dependsOn:
        - ${exampleDocumentationPart}
  exampleRestApi:
    type: aws:apigateway:RestApi
    name: example
    properties:
      name: example_api
  exampleDocumentationPart:
    type: aws:apigateway:DocumentationPart
    name: example
    properties:
      location:
        type: API
      properties: '{"description":"Example"}'
      restApiId: ${exampleRestApi.id}

Import

Using pulumi import, import API Gateway documentation versions using REST-API-ID/VERSION. For example:

$ pulumi import aws:apigateway/documentationVersion:DocumentationVersion example 5i4e1ko720/example-version

Constructors

DocumentationVersion(String name, {DocumentationVersionArgs? args, CustomResourceOptions? options})
Creates a new DocumentationVersion. name The Pulumi resource name. args Arguments used to configure this DocumentationVersion. The set of arguments for DocumentationVersion. options Resource options controlling this resource's behavior.
DocumentationVersion.reference(String urn)
Creates a typed reference to an existing DocumentationVersion resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
Description of the API documentation version.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
restApiId ↔ Output<String>
ID of the associated Rest API
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
version ↔ Output<String>
Version identifier of the API documentation snapshot.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DocumentationVersionState? state, CustomResourceOptions? options}) → DocumentationVersion
Gets an existing DocumentationVersion resource's state with the given name and id.