@aws-cdk/aws-amplify-alpha.CustomResponseHeader

Experimental

@aws-cdk/aws-amplify-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

CustomResponseHeader Struct

Custom response header of an Amplify App.

Stability

Experimental

Source

lib/app.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as amplify_alpha from '@aws-cdk/aws-amplify-alpha';
const customResponseHeader: amplify_alpha.CustomResponseHeader = {
  headers: {
    headersKey: 'headers',
  },
  pattern: 'pattern',

  // the properties below are optional
  appRoot: 'appRoot',
};

Properties

appRootstringapp_rootstrappRootStringAppRootstringAppRoot*string= The appRoot is omitted in the cu…#

If the app uses a monorepo structure, the appRoot from the build spec to apply the custom headers to.

default

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

headers{ [key: string]: string }headerstyping.Mapping[str, str]headersMap<String, String>HeadersIDictionary<string, string>Headers*map[string]*stringrequired#

The map of custom headers to be applied.

patternstringpatternstrpatternStringPatternstringPattern*stringrequired#

These custom headers will be applied to all URL file paths that match this pattern.