@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:46.144Z") 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();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnApiGatewayManagedOverrides.AccessLogSettingsProperty
The `AccessLogSettings` property overrides the access log settings for an API Gateway-managed stage.
|
static class |
CfnApiGatewayManagedOverrides.Builder
A fluent builder for
CfnApiGatewayManagedOverrides . |
static interface |
CfnApiGatewayManagedOverrides.IntegrationOverridesProperty
The `IntegrationOverrides` property overrides the integration settings for an API Gateway-managed integration.
|
static interface |
CfnApiGatewayManagedOverrides.RouteOverridesProperty
The `RouteOverrides` property overrides the route configuration for an API Gateway-managed route.
|
static interface |
CfnApiGatewayManagedOverrides.RouteSettingsProperty
The `RouteSettings` property overrides the route settings for an API Gateway-managed route.
|
static interface |
CfnApiGatewayManagedOverrides.StageOverridesProperty
The `StageOverrides` property overrides the stage configuration for an API Gateway-managed stage.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnApiGatewayManagedOverrides(Construct scope,
java.lang.String id,
CfnApiGatewayManagedOverridesProps props)
Create a new `AWS::ApiGatewayV2::ApiGatewayManagedOverrides`.
|
protected |
CfnApiGatewayManagedOverrides(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnApiGatewayManagedOverrides(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApiId()
The ID of the API for which to override the configuration of API Gateway-managed resources.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getIntegration()
Overrides the integration configuration for an API Gateway-managed integration.
|
java.lang.Object |
getRoute()
Overrides the route configuration for an API Gateway-managed route.
|
java.lang.Object |
getStage()
Overrides the stage configuration for an API Gateway-managed stage.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setApiId(java.lang.String value)
The ID of the API for which to override the configuration of API Gateway-managed resources.
|
void |
setIntegration(CfnApiGatewayManagedOverrides.IntegrationOverridesProperty value)
Overrides the integration configuration for an API Gateway-managed integration.
|
void |
setIntegration(IResolvable value)
Overrides the integration configuration for an API Gateway-managed integration.
|
void |
setRoute(CfnApiGatewayManagedOverrides.RouteOverridesProperty value)
Overrides the route configuration for an API Gateway-managed route.
|
void |
setRoute(IResolvable value)
Overrides the route configuration for an API Gateway-managed route.
|
void |
setStage(CfnApiGatewayManagedOverrides.StageOverridesProperty value)
Overrides the stage configuration for an API Gateway-managed stage.
|
void |
setStage(IResolvable value)
Overrides the stage configuration for an API Gateway-managed stage.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnApiGatewayManagedOverrides(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnApiGatewayManagedOverrides(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnApiGatewayManagedOverrides(Construct scope, java.lang.String id, CfnApiGatewayManagedOverridesProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getApiId()
public void setApiId(java.lang.String value)
public java.lang.Object getIntegration()
public void setIntegration(IResolvable value)
public void setIntegration(CfnApiGatewayManagedOverrides.IntegrationOverridesProperty value)
public java.lang.Object getRoute()
public void setRoute(IResolvable value)
public void setRoute(CfnApiGatewayManagedOverrides.RouteOverridesProperty value)
public java.lang.Object getStage()
public void setStage(IResolvable value)
public void setStage(CfnApiGatewayManagedOverrides.StageOverridesProperty value)