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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.248Z")
 @Stability(value=Stable)
public class CfnApiGatewayManagedOverrides
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGatewayV2::ApiGatewayManagedOverrides`.

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();
 

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApiGatewayManagedOverrides(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getApiId() The ID of the API for which to override the configuration of API Gateway-managed resources.
protected Map<String,Object>	getCfnProperties()
Object	getIntegration() Overrides the integration configuration for an API Gateway-managed integration.
Object	getRoute() Overrides the route configuration for an API Gateway-managed route.
Object	getStage() Overrides the stage configuration for an API Gateway-managed stage.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiId(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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApiGatewayManagedOverrides

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

CfnApiGatewayManagedOverrides

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

CfnApiGatewayManagedOverrides

@Stability(value=Stable)
public CfnApiGatewayManagedOverrides(@NotNull
                                                              software.constructs.Construct scope,
                                                              @NotNull
                                                              String id,
                                                              @NotNull
                                                              CfnApiGatewayManagedOverridesProps props)

Create a new `AWS::ApiGatewayV2::ApiGatewayManagedOverrides`.

Parameters:

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.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiId

@Stability(value=Stable)
 @NotNull
public String getApiId()

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

setApiId

@Stability(value=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(value=Stable)
 @Nullable
public Object getIntegration()

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

setIntegration

@Stability(value=Stable)
public void setIntegration(@Nullable
                                                    CfnApiGatewayManagedOverrides.IntegrationOverridesProperty value)

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

setIntegration

@Stability(value=Stable)
public void setIntegration(@Nullable
                                                    IResolvable value)

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

getRoute

@Stability(value=Stable)
 @Nullable
public Object getRoute()

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

setRoute

@Stability(value=Stable)
public void setRoute(@Nullable
                                              CfnApiGatewayManagedOverrides.RouteOverridesProperty value)

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

setRoute

@Stability(value=Stable)
public void setRoute(@Nullable
                                              IResolvable value)

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

getStage

@Stability(value=Stable)
 @Nullable
public Object getStage()

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

setStage

@Stability(value=Stable)
public void setStage(@Nullable
                                              CfnApiGatewayManagedOverrides.StageOverridesProperty value)

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

setStage

@Stability(value=Stable)
public void setStage(@Nullable
                                              IResolvable value)

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