Package com.pulumi.aws.apigatewayv2

Class IntegrationResponse

  • public class IntegrationResponse
extends com.pulumi.resources.CustomResource
    Manages an Amazon API Gateway Version 2 integration response. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html). ## Example Usage ### Basic 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.apigatewayv2.IntegrationResponse;
 import com.pulumi.aws.apigatewayv2.IntegrationResponseArgs;
 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 example = new IntegrationResponse("example", IntegrationResponseArgs.builder()
             .apiId(exampleAwsApigatewayv2Api.id())
             .integrationId(exampleAwsApigatewayv2Integration.id())
             .integrationResponseKey("/200/")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.apigatewayv2.IntegrationResponse` using the API identifier, integration identifier and integration response identifier. For example: ```sh $ pulumi import aws:apigatewayv2/integrationResponse:IntegrationResponse example aabbccddee/1122334/998877 ```

    • 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> apiId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> contentHandlingStrategy()  
      static IntegrationResponse get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IntegrationResponseState 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> integrationId()  
      com.pulumi.core.Output<java.lang.String> integrationResponseKey()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> responseTemplates()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> templateSelectionExpression()  

      • 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

      • IntegrationResponse

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

      • IntegrationResponse

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

      • IntegrationResponse

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

      • apiId

        public com.pulumi.core.Output<java.lang.String> apiId()
        Returns:
        API identifier.

      • contentHandlingStrategy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> contentHandlingStrategy()
        Returns:
        How to handle response payload content type conversions. Valid values: `CONVERT_TO_BINARY`, `CONVERT_TO_TEXT`.

      • integrationId

        public com.pulumi.core.Output<java.lang.String> integrationId()
        Returns:
        Identifier of the `aws.apigatewayv2.Integration`.

      • integrationResponseKey

        public com.pulumi.core.Output<java.lang.String> integrationResponseKey()
        Returns:
        Integration response key.

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

      • responseTemplates

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> responseTemplates()
        Returns:
        Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.

      • templateSelectionExpression

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> templateSelectionExpression()
        Returns:
        [Template selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-template-selection-expressions) for the integration response.

      • get

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