Package com.pulumi.aws.apigateway

Class Response

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.apigateway.Response

public class Response
extends com.pulumi.resources.CustomResource

Provides an API Gateway Gateway Response for a REST API Gateway. ## Example Usage <!--Start PulumiCodeChooser -->

 
 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.Response;
 import com.pulumi.aws.apigateway.ResponseArgs;
 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 main = new RestApi("main", RestApiArgs.builder()        
             .name("MyDemoAPI")
             .build());
 
         var test = new Response("test", ResponseArgs.builder()        
             .restApiId(main.id())
             .statusCode("401")
             .responseType("UNAUTHORIZED")
             .responseTemplates(Map.of("application/json", "{\"message\":$context.error.messageString}"))
             .responseParameters(Map.of("gatewayresponse.header.Authorization", "'Basic'"))
             .build());
 
     }
 }
 
 

<!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import `aws_api_gateway_gateway_response` using `REST-API-ID/RESPONSE-TYPE`. For example: ```sh $ pulumi import aws:apigateway/response:Response example 12345abcde/UNAUTHORIZED ```

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

Constructor Summary

Constructors

Constructor	Description
Response(java.lang.String name)
Response(java.lang.String name, ResponseArgs args)
Response(java.lang.String name, ResponseArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
static Response	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ResponseState 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.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>	responseParameters()
com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>	responseTemplates()
com.pulumi.core.Output<java.lang.String>	responseType()
com.pulumi.core.Output<java.lang.String>	restApiId()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	statusCode()

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

Response

public Response(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

Response

public Response(java.lang.String name,
                ResponseArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

Response

public Response(java.lang.String name,
                ResponseArgs 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

responseParameters

public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> responseParameters()

Returns:

Map of parameters (paths, query strings and headers) of the Gateway Response.

responseTemplates

public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> responseTemplates()

Returns:

Map of templates used to transform the response body.

responseType

public com.pulumi.core.Output<java.lang.String> responseType()

Returns:

Response type of the associated GatewayResponse.

restApiId

public com.pulumi.core.Output<java.lang.String> restApiId()

Returns:

String identifier of the associated REST API.

statusCode

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> statusCode()

Returns:

HTTP status code of the Gateway Response.

get

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