interface CfnApiGatewayManagedOverridesProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGatewayv2.CfnApiGatewayManagedOverridesProps
Java	software.amazon.awscdk.services.apigatewayv2.CfnApiGatewayManagedOverridesProps
Python	aws_cdk.aws_apigatewayv2.CfnApiGatewayManagedOverridesProps
TypeScript	@aws-cdk/aws-apigatewayv2 » CfnApiGatewayManagedOverridesProps

Properties for defining a CfnApiGatewayManagedOverrides.

Example

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

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

Name	Type	Description
apiId	string	The ID of the API for which to override the configuration of API Gateway-managed resources.
integration?	IResolvable | IntegrationOverridesProperty	Overrides the integration configuration for an API Gateway-managed integration.
route?	IResolvable | RouteOverridesProperty	Overrides the route configuration for an API Gateway-managed route.
stage?	IResolvable | StageOverridesProperty	Overrides the stage configuration for an API Gateway-managed stage.

---

apiId

Type: string

The ID of the API for which to override the configuration of API Gateway-managed resources.

---

integration?

Type: IResolvable | IntegrationOverridesProperty (optional)

Overrides the integration configuration for an API Gateway-managed integration.

---

route?

Type: IResolvable | RouteOverridesProperty (optional)

Overrides the route configuration for an API Gateway-managed route.

---

stage?

Type: IResolvable | StageOverridesProperty (optional)

Overrides the stage configuration for an API Gateway-managed stage.