Skip to content
v2.273.0

CfnApiGatewayManagedOverridesProps Struct ​

Properties for defining a CfnApiGatewayManagedOverrides.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';

declare const routeSettings: any;
declare const stageVariables: any;
const cfnApiGatewayManagedOverridesProps: apigatewayv2.CfnApiGatewayManagedOverridesProps = {
  apiId: 'apiId',

  // the properties below are optional
  integration: {
    description: 'description',
    integrationMethod: 'integrationMethod',
    payloadFormatVersion: 'payloadFormatVersion',
    timeoutInMillis: 123,
  },
  route: {
    authorizationScopes: ['authorizationScopes'],
    authorizationType: 'authorizationType',
    authorizerId: 'authorizerId',
    operationName: 'operationName',
    target: 'target',
  },
  stage: {
    accessLogSettings: {
      destinationArn: 'destinationArn',
      format: 'format',
    },
    autoDeploy: false,
    defaultRouteSettings: {
      dataTraceEnabled: false,
      detailedMetricsEnabled: false,
      loggingLevel: 'loggingLevel',
      throttlingBurstLimit: 123,
      throttlingRateLimit: 123,
    },
    description: 'description',
    routeSettings: routeSettings,
    stageVariables: stageVariables,
  },
};

Properties ​

apiIdstringapi_idstrapiIdStringApiIdstringApiId*stringrequired#
The ID of the API for which to override the configuration of API Gateway-managed resources.
Overrides the integration configuration for an API Gateway-managed integration.
Overrides the route configuration for an API Gateway-managed route.
Overrides the stage configuration for an API Gateway-managed stage.

Used as props by ​