Package com.pulumi.aws.apigateway

Class DocumentationVersion

  • public class DocumentationVersion
extends com.pulumi.resources.CustomResource
    Provides a resource to manage an API Gateway Documentation Version. ## Example Usage <!--Start PulumiCodeChooser --> ```java 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.DocumentationVersion; import com.pulumi.aws.apigateway.DocumentationVersionArgs; 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 DocumentationVersion("example", DocumentationVersionArgs.builder() .version("example_version") .restApiId(exampleRestApi.id()) .description("Example description") .build()); var exampleDocumentationPart = new DocumentationPart("exampleDocumentationPart", DocumentationPartArgs.builder() .location(DocumentationPartLocationArgs.builder() .type("API") .build()) .properties("{\"description\":\"Example\"}") .restApiId(exampleRestApi.id()) .build()); } } ``` <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import API Gateway documentation versions using `REST-API-ID/VERSION`. For example: ```sh $ pulumi import aws:apigateway/documentationVersion:DocumentationVersion example 5i4e1ko720/example-version ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static DocumentationVersion get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DocumentationVersionState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> restApiId()  
      com.pulumi.core.Output<java.lang.String> version()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DocumentationVersion

        public DocumentationVersion​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • DocumentationVersion

        public DocumentationVersion​(java.lang.String name,
                            DocumentationVersionArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • DocumentationVersion

        public DocumentationVersion​(java.lang.String name,
                            DocumentationVersionArgs args,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the API documentation version.

      • restApiId

        public com.pulumi.core.Output<java.lang.String> restApiId()
        Returns:
        ID of the associated Rest API

      • version

        public com.pulumi.core.Output<java.lang.String> version()
        Returns:
        Version identifier of the API documentation snapshot.

      • get

        public static DocumentationVersion get​(java.lang.String name,
                                       com.pulumi.core.Output<java.lang.String> id,
                                       @Nullable
                                       DocumentationVersionState state,
                                       @Nullable
                                       com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.