1. Packages
  2. AWS Native
  3. API Docs
  4. apigateway
  5. GatewayResponse

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.apigateway.GatewayResponse

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see API Gateway Responses in the API Gateway Developer Guide.

    Create GatewayResponse Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GatewayResponse(name: string, args: GatewayResponseArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayResponse(resource_name: str,
                        args: GatewayResponseArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayResponse(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        response_type: Optional[str] = None,
                        rest_api_id: Optional[str] = None,
                        response_parameters: Optional[Mapping[str, str]] = None,
                        response_templates: Optional[Mapping[str, str]] = None,
                        status_code: Optional[str] = None)
    func NewGatewayResponse(ctx *Context, name string, args GatewayResponseArgs, opts ...ResourceOption) (*GatewayResponse, error)
    public GatewayResponse(string name, GatewayResponseArgs args, CustomResourceOptions? opts = null)
    public GatewayResponse(String name, GatewayResponseArgs args)
    public GatewayResponse(String name, GatewayResponseArgs args, CustomResourceOptions options)
    
    type: aws-native:apigateway:GatewayResponse
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args GatewayResponseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GatewayResponseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GatewayResponseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayResponseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayResponseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const gatewayResponseResource = new aws_native.apigateway.GatewayResponse("gatewayResponseResource", {
        responseType: "string",
        restApiId: "string",
        responseParameters: {
            string: "string",
        },
        responseTemplates: {
            string: "string",
        },
        statusCode: "string",
    });
    
    Coming soon!
    

    GatewayResponse Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The GatewayResponse resource accepts the following input properties:

    ResponseType string
    The response type of the associated GatewayResponse.
    RestApiId string
    The string identifier of the associated RestApi.
    ResponseParameters Dictionary<string, string>
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    ResponseTemplates Dictionary<string, string>
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    StatusCode string
    The HTTP status code for this GatewayResponse.
    ResponseType string
    The response type of the associated GatewayResponse.
    RestApiId string
    The string identifier of the associated RestApi.
    ResponseParameters map[string]string
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    ResponseTemplates map[string]string
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    StatusCode string
    The HTTP status code for this GatewayResponse.
    responseType String
    The response type of the associated GatewayResponse.
    restApiId String
    The string identifier of the associated RestApi.
    responseParameters Map<String,String>
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    responseTemplates Map<String,String>
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    statusCode String
    The HTTP status code for this GatewayResponse.
    responseType string
    The response type of the associated GatewayResponse.
    restApiId string
    The string identifier of the associated RestApi.
    responseParameters {[key: string]: string}
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    responseTemplates {[key: string]: string}
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    statusCode string
    The HTTP status code for this GatewayResponse.
    response_type str
    The response type of the associated GatewayResponse.
    rest_api_id str
    The string identifier of the associated RestApi.
    response_parameters Mapping[str, str]
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    response_templates Mapping[str, str]
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    status_code str
    The HTTP status code for this GatewayResponse.
    responseType String
    The response type of the associated GatewayResponse.
    restApiId String
    The string identifier of the associated RestApi.
    responseParameters Map<String>
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    responseTemplates Map<String>
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    statusCode String
    The HTTP status code for this GatewayResponse.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayResponse resource produces the following output properties:

    AwsId string
    The ID for the gateway response. For example: abc123 .
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    The ID for the gateway response. For example: abc123 .
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    The ID for the gateway response. For example: abc123 .
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    The ID for the gateway response. For example: abc123 .
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    The ID for the gateway response. For example: abc123 .
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    The ID for the gateway response. For example: abc123 .
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi