Interface CustomResponseHeader

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CustomResponseHeader.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-07-04T12:43:17.781Z") @Stability(Experimental) public interface CustomResponseHeader extends software.amazon.jsii.JsiiSerializable
(experimental) Custom response header of an Amplify App.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplify.alpha.*;
 CustomResponseHeader customResponseHeader = CustomResponseHeader.builder()
         .headers(Map.of(
                 "headersKey", "headers"))
         .pattern("pattern")
         // the properties below are optional
         .appRoot("appRoot")
         .build();
 
  • Method Details

    • getHeaders

      @Stability(Experimental) @NotNull Map<String,String> getHeaders()
      (experimental) The map of custom headers to be applied.
    • getPattern

      @Stability(Experimental) @NotNull String getPattern()
      (experimental) These custom headers will be applied to all URL file paths that match this pattern.
    • getAppRoot

      @Stability(Experimental) @Nullable default String getAppRoot()
      (experimental) If the app uses a monorepo structure, the appRoot from the build spec to apply the custom headers to.

      Default: - The appRoot is omitted in the custom headers output.

    • builder

      @Stability(Experimental) static CustomResponseHeader.Builder builder()
      Returns:
      a CustomResponseHeader.Builder of CustomResponseHeader