com.pulumi.aws.apigateway.Response Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
There is a newer version: 6.60.0-alpha.1731982519
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.aws.apigateway;

import com.pulumi.aws.Utilities;
import com.pulumi.aws.apigateway.ResponseArgs;
import com.pulumi.aws.apigateway.inputs.ResponseState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * Provides an API Gateway Gateway Response for a REST API Gateway.
 * 
 * ## Example Usage
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * 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
 * ```
 * 
 */
@ResourceType(type="aws:apigateway/response:Response")
public class Response extends com.pulumi.resources.CustomResource {
    /**
     * Map of parameters (paths, query strings and headers) of the Gateway Response.
     * 
     */
    @Export(name="responseParameters", refs={Map.class,String.class}, tree="[0,1,1]")
    private Output> responseParameters;

    /**
     * @return Map of parameters (paths, query strings and headers) of the Gateway Response.
     * 
     */
    public Output>> responseParameters() {
        return Codegen.optional(this.responseParameters);
    }
    /**
     * Map of templates used to transform the response body.
     * 
     */
    @Export(name="responseTemplates", refs={Map.class,String.class}, tree="[0,1,1]")
    private Output> responseTemplates;

    /**
     * @return Map of templates used to transform the response body.
     * 
     */
    public Output>> responseTemplates() {
        return Codegen.optional(this.responseTemplates);
    }
    /**
     * Response type of the associated GatewayResponse.
     * 
     */
    @Export(name="responseType", refs={String.class}, tree="[0]")
    private Output responseType;

    /**
     * @return Response type of the associated GatewayResponse.
     * 
     */
    public Output responseType() {
        return this.responseType;
    }
    /**
     * String identifier of the associated REST API.
     * 
     */
    @Export(name="restApiId", refs={String.class}, tree="[0]")
    private Output restApiId;

    /**
     * @return String identifier of the associated REST API.
     * 
     */
    public Output restApiId() {
        return this.restApiId;
    }
    /**
     * HTTP status code of the Gateway Response.
     * 
     */
    @Export(name="statusCode", refs={String.class}, tree="[0]")
    private Output statusCode;

    /**
     * @return HTTP status code of the Gateway Response.
     * 
     */
    public Output> statusCode() {
        return Codegen.optional(this.statusCode);
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public Response(java.lang.String name) {
        this(name, ResponseArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public Response(java.lang.String name, ResponseArgs args) {
        this(name, args, null);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param options A bag of options that control this resource's behavior.
     */
    public Response(java.lang.String name, ResponseArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:apigateway/response:Response", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private Response(java.lang.String name, Output id, @Nullable ResponseState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:apigateway/response:Response", name, state, makeResourceOptions(options, id), false);
    }

    private static ResponseArgs makeArgs(ResponseArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? ResponseArgs.Empty : args;
    }

    private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
        var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
            .version(Utilities.getVersion())
            .build();
        return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
    }

    /**
     * Get an existing Host resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state
     * @param options Optional settings to control the behavior of the CustomResource.
     */
    public static Response get(java.lang.String name, Output id, @Nullable ResponseState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new Response(name, id, state, options);
    }
}