Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnGatewayResponsePropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnGatewayResponsePropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:55.461Z") @Stability(Stable) public class CfnGatewayResponsePropsMixin extends Mixin implements software.constructs.IMixin
The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API.

When you delete a stack containing this resource, your custom gateway responses are reset. For more information, see API Gateway Responses in the API Gateway Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigateway.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnGatewayResponsePropsMixin cfnGatewayResponsePropsMixin = CfnGatewayResponsePropsMixin.Builder.create(CfnGatewayResponseMixinProps.builder()
         .responseParameters(Map.of(
                 "responseParametersKey", "responseParameters"))
         .responseTemplates(Map.of(
                 "responseTemplatesKey", "responseTemplates"))
         .responseType("responseType")
         .restApiId("restApiId")
         .statusCode("statusCode")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnGatewayResponsePropsMixin

      protected CfnGatewayResponsePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnGatewayResponsePropsMixin

      protected CfnGatewayResponsePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnGatewayResponsePropsMixin

      @Stability(Stable) public CfnGatewayResponsePropsMixin(@NotNull CfnGatewayResponseMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::ApiGateway::GatewayResponse.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnGatewayResponsePropsMixin

      @Stability(Stable) public CfnGatewayResponsePropsMixin(@NotNull CfnGatewayResponseMixinProps props)
      Create a mixin to apply properties to AWS::ApiGateway::GatewayResponse.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnGatewayResponseMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()