Package software.amazon.awscdk.services.apigatewayv2

Class CfnApiGatewayManagedOverrides

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnApiGatewayManagedOverrides
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:02.107Z") @Stability(Stable) public class CfnApiGatewayManagedOverrides extends CfnResource implements IInspectable
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.services.apigatewayv2.*;
 Object routeSettings;
 Object stageVariables;
 CfnApiGatewayManagedOverrides cfnApiGatewayManagedOverrides = CfnApiGatewayManagedOverrides.Builder.create(this, "MyCfnApiGatewayManagedOverrides")
         .apiId("apiId")
         // the properties below are optional
         .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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApiGatewayManagedOverrides

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

    • CfnApiGatewayManagedOverrides

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

    • CfnApiGatewayManagedOverrides

      @Stability(Stable) public CfnApiGatewayManagedOverrides(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApiGatewayManagedOverridesProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The identifier.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The ID of the API for which to override the configuration of API Gateway-managed resources.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The ID of the API for which to override the configuration of API Gateway-managed resources.

    • getIntegration

      @Stability(Stable) @Nullable public Object getIntegration()
      Overrides the integration configuration for an API Gateway-managed integration.

    • setIntegration

      @Stability(Stable) public void setIntegration(@Nullable IResolvable value)
      Overrides the integration configuration for an API Gateway-managed integration.

    • setIntegration

      @Stability(Stable) public void setIntegration(@Nullable CfnApiGatewayManagedOverrides.IntegrationOverridesProperty value)
      Overrides the integration configuration for an API Gateway-managed integration.

    • getRoute

      @Stability(Stable) @Nullable public Object getRoute()
      Overrides the route configuration for an API Gateway-managed route.

    • setRoute

      @Stability(Stable) public void setRoute(@Nullable IResolvable value)
      Overrides the route configuration for an API Gateway-managed route.

    • setRoute

      @Stability(Stable) public void setRoute(@Nullable CfnApiGatewayManagedOverrides.RouteOverridesProperty value)
      Overrides the route configuration for an API Gateway-managed route.

    • getStage

      @Stability(Stable) @Nullable public Object getStage()
      Overrides the stage configuration for an API Gateway-managed stage.

    • setStage

      @Stability(Stable) public void setStage(@Nullable IResolvable value)
      Overrides the stage configuration for an API Gateway-managed stage.

    • setStage

      @Stability(Stable) public void setStage(@Nullable CfnApiGatewayManagedOverrides.StageOverridesProperty value)
      Overrides the stage configuration for an API Gateway-managed stage.