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.103.1 (build bef2dea)",
date="2024-10-05T03:43:38.070Z")
@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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
TheAccessLogSettings
property overrides the access log settings for an API Gateway-managed stage.static final class
A fluent builder forCfnApiGatewayManagedOverrides
.static interface
TheIntegrationOverrides
property overrides the integration settings for an API Gateway-managed integration.static interface
TheRouteOverrides
property overrides the route configuration for an API Gateway-managed route.static interface
TheRouteSettings
property overrides the route settings for an API Gateway-managed route.static interface
TheStageOverrides
property overrides the stage configuration for an API Gateway-managed stage.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnApiGatewayManagedOverrides
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnApiGatewayManagedOverrides
(software.amazon.jsii.JsiiObjectRef objRef) CfnApiGatewayManagedOverrides
(software.constructs.Construct scope, String id, CfnApiGatewayManagedOverridesProps props) -
Method Summary
Modifier and TypeMethodDescriptiongetApiId()
The ID of the API for which to override the configuration of API Gateway-managed resources.The identifier.Overrides the integration configuration for an API Gateway-managed integration.getRoute()
Overrides the route configuration for an API Gateway-managed route.getStage()
Overrides the stage configuration for an API Gateway-managed stage.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
The ID of the API for which to override the configuration of API Gateway-managed resources.void
setIntegration
(IResolvable value) Overrides the integration configuration for an API Gateway-managed integration.void
Overrides the integration configuration for an API Gateway-managed integration.void
setRoute
(IResolvable value) Overrides the route configuration for an API Gateway-managed route.void
Overrides the route configuration for an API Gateway-managed route.void
setStage
(IResolvable value) Overrides the stage configuration for an API Gateway-managed stage.void
Overrides the stage configuration for an API Gateway-managed stage.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The identifier. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getApiId
The ID of the API for which to override the configuration of API Gateway-managed resources. -
setApiId
The ID of the API for which to override the configuration of API Gateway-managed resources. -
getIntegration
Overrides the integration configuration for an API Gateway-managed integration. -
setIntegration
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
Overrides the route configuration for an API Gateway-managed route. -
setRoute
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
Overrides the stage configuration for an API Gateway-managed stage. -
setStage
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.
-