Package software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2

Class CfnApiGatewayManagedOverridesPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.CfnApiGatewayManagedOverridesPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-14T18:32:08.152Z") @Stability(Stable) public class CfnApiGatewayManagedOverridesPropsMixin extends Mixin implements software.constructs.IMixin
The AWS::ApiGatewayV2::ApiGatewayManagedOverrides resource overrides the default properties of API Gateway-managed resources that are implicitly configured for you when you use quick create.

When you create an API by using quick create, an AWS::ApiGatewayV2::Route , AWS::ApiGatewayV2::Integration , and AWS::ApiGatewayV2::Stage are created for you and associated with your AWS::ApiGatewayV2::Api . The AWS::ApiGatewayV2::ApiGatewayManagedOverrides resource enables you to set, or override the properties of these implicit resources. Supported only for HTTP APIs.

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.apigatewayv2.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object routeSettings;
 Object stageVariables;
 CfnApiGatewayManagedOverridesPropsMixin cfnApiGatewayManagedOverridesPropsMixin = CfnApiGatewayManagedOverridesPropsMixin.Builder.create(CfnApiGatewayManagedOverridesMixinProps.builder()
         .apiId("apiId")
         .integration(IntegrationOverridesProperty.builder()
                 .description("description")
                 .integrationMethod("integrationMethod")
                 .payloadFormatVersion("payloadFormatVersion")
                 .timeoutInMillis(123)
                 .build())
         .route(RouteOverridesProperty.builder()
                 .authorizationScopes(List.of("authorizationScopes"))
                 .authorizationType("authorizationType")
                 .authorizerId("authorizerId")
                 .operationName("operationName")
                 .target("target")
                 .build())
         .stage(StageOverridesProperty.builder()
                 .accessLogSettings(AccessLogSettingsProperty.builder()
                         .destinationArn("destinationArn")
                         .format("format")
                         .build())
                 .autoDeploy(false)
                 .defaultRouteSettings(RouteSettingsProperty.builder()
                         .dataTraceEnabled(false)
                         .detailedMetricsEnabled(false)
                         .loggingLevel("loggingLevel")
                         .throttlingBurstLimit(123)
                         .throttlingRateLimit(123)
                         .build())
                 .description("description")
                 .routeSettings(routeSettings)
                 .stageVariables(stageVariables)
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

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

  • Constructor Details

    • CfnApiGatewayManagedOverridesPropsMixin

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

    • CfnApiGatewayManagedOverridesPropsMixin

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

    • CfnApiGatewayManagedOverridesPropsMixin

      @Stability(Stable) public CfnApiGatewayManagedOverridesPropsMixin(@NotNull CfnApiGatewayManagedOverridesMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::ApiGatewayV2::ApiGatewayManagedOverrides.

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

    • CfnApiGatewayManagedOverridesPropsMixin

      @Stability(Stable) public CfnApiGatewayManagedOverridesPropsMixin(@NotNull CfnApiGatewayManagedOverridesMixinProps props)
      Create a mixin to apply properties to AWS::ApiGatewayV2::ApiGatewayManagedOverrides.

      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 CfnApiGatewayManagedOverridesMixinProps getProps()

    • getStrategy

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