Package com.pulumi.aws.apigateway

Class DocumentationPart

  • public class DocumentationPart
extends com.pulumi.resources.CustomResource
    Provides a settings of an API Gateway Documentation Part. ## 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.RestApiArgs;
 import com.pulumi.aws.apigateway.DocumentationPart;
 import com.pulumi.aws.apigateway.DocumentationPartArgs;
 import com.pulumi.aws.apigateway.inputs.DocumentationPartLocationArgs;
 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 example = new DocumentationPart("example", DocumentationPartArgs.builder()
             .location(DocumentationPartLocationArgs.builder()
                 .type("METHOD")
                 .method("GET")
                 .path("/example")
                 .build())
             .properties("{\"description\":\"Example description\"}")
             .restApiId(exampleRestApi.id())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import API Gateway documentationParts using `REST-API-ID/DOC-PART-ID`. For example: ```sh $ pulumi import aws:apigateway/documentationPart:DocumentationPart example 5i4e1ko720/3oyy3t ```

    • 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.lang.String> documentationPartId()  
      static DocumentationPart get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DocumentationPartState 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<DocumentationPartLocation> location()  
      com.pulumi.core.Output<java.lang.String> properties()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> restApiId()  

      • 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

      • DocumentationPart

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

      • DocumentationPart

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

      • DocumentationPart

        public DocumentationPart​(java.lang.String name,
                         DocumentationPartArgs 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

      • documentationPartId

        public com.pulumi.core.Output<java.lang.String> documentationPartId()
        Returns:
        DocumentationPart identifier, generated by API Gateway when the documentation part is created.

      • location

        public com.pulumi.core.Output<DocumentationPartLocation> location()
        Returns:
        Location of the targeted API entity of the to-be-created documentation part. See below.

      • properties

        public com.pulumi.core.Output<java.lang.String> properties()
        Returns:
        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.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • restApiId

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

      • get

        public static DocumentationPart get​(java.lang.String name,
                                    com.pulumi.core.Output<java.lang.String> id,
                                    @Nullable
                                    DocumentationPartState 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.