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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.774Z")
 @Stability(value=Stable)
public class CfnApiGatewayManagedOverrides
extends CfnResource
implements IInspectable

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

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 Example:
static class	CfnApiGatewayManagedOverrides.Builder A fluent builder for CfnApiGatewayManagedOverrides.
static interface	CfnApiGatewayManagedOverrides.IntegrationOverridesProperty Example:
static interface	CfnApiGatewayManagedOverrides.RouteOverridesProperty Example:
static interface	CfnApiGatewayManagedOverrides.RouteSettingsProperty Example:
static interface	CfnApiGatewayManagedOverrides.StageOverridesProperty Example:

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() `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.ApiId`.
protected Map<String,Object>	getCfnProperties()
Object	getIntegration() `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Integration`.
Object	getRoute() `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Route`.
Object	getStage() `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.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) `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.ApiId`.
void	setIntegration(CfnApiGatewayManagedOverrides.IntegrationOverridesProperty value) `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Integration`.
void	setIntegration(IResolvable value) `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Integration`.
void	setRoute(CfnApiGatewayManagedOverrides.RouteOverridesProperty value) `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Route`.
void	setRoute(IResolvable value) `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Route`.
void	setStage(CfnApiGatewayManagedOverrides.StageOverridesProperty value) `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Stage`.
void	setStage(IResolvable value) `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Stage`.

Methods inherited from class software.amazon.awscdk.CfnResource

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

getApiId

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

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.ApiId`.

setApiId

@Stability(value=Stable)
public void setApiId(@NotNull
                                              String value)

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.ApiId`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getIntegration

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

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Integration`.

setIntegration

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

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Integration`.

setIntegration

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

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Integration`.

getRoute

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

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Route`.

setRoute

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

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Route`.

setRoute

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

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Route`.

getStage

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

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Stage`.

setStage

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

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Stage`.

setStage

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

`AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Stage`.