CfnApiV2Props (software.amazon.awscdk:monocdk 1.138.0.DEVPREVIEW API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnApiV2Props.Jsii$Proxy

Deprecated.

moved to package aws-apigatewayv2

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:01.564Z")
 @Stability(value=Deprecated)
 @Deprecated
public interface CfnApiV2Props
extends software.amazon.jsii.JsiiSerializable

(deprecated) Properties for defining a `AWS::ApiGatewayV2::Api`.

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.apigateway.*;
 Object body;
 Object tags;
 CfnApiV2Props cfnApiV2Props = CfnApiV2Props.builder()
         .apiKeySelectionExpression("apiKeySelectionExpression")
         .basePath("basePath")
         .body(body)
         .bodyS3Location(BodyS3LocationProperty.builder()
                 .bucket("bucket")
                 .etag("etag")
                 .key("key")
                 .version("version")
                 .build())
         .corsConfiguration(CorsProperty.builder()
                 .allowCredentials(false)
                 .allowHeaders(List.of("allowHeaders"))
                 .allowMethods(List.of("allowMethods"))
                 .allowOrigins(List.of("allowOrigins"))
                 .exposeHeaders(List.of("exposeHeaders"))
                 .maxAge(123)
                 .build())
         .credentialsArn("credentialsArn")
         .description("description")
         .disableSchemaValidation(false)
         .failOnWarnings(false)
         .name("name")
         .protocolType("protocolType")
         .routeKey("routeKey")
         .routeSelectionExpression("routeSelectionExpression")
         .tags(tags)
         .target("target")
         .version("version")
         .build();

See Also:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class CfnApiV2Props.Builder
Deprecated.

static class CfnApiV2Props.Jsii$Proxy
Deprecated.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnApiV2Props.Builder` Deprecated.
`static class`	`CfnApiV2Props.Jsii$Proxy` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static CfnApiV2Props.Builder`	`builder()` Deprecated.
`default String`	`getApiKeySelectionExpression()` Deprecated.
`default String`	`getBasePath()` Deprecated.
`default Object`	`getBody()` Deprecated.
`default Object`	`getBodyS3Location()` Deprecated.
`default Object`	`getCorsConfiguration()` Deprecated.
`default String`	`getCredentialsArn()` Deprecated.
`default String`	`getDescription()` Deprecated.
`default Object`	`getDisableSchemaValidation()` Deprecated.
`default Object`	`getFailOnWarnings()` Deprecated.
`default String`	`getName()` Deprecated.
`default String`	`getProtocolType()` Deprecated.
`default String`	`getRouteKey()` Deprecated.
`default String`	`getRouteSelectionExpression()` Deprecated.
`default Object`	`getTags()` Deprecated.
`default String`	`getTarget()` Deprecated.
`default String`	`getVersion()` Deprecated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getApiKeySelectionExpression
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getApiKeySelectionExpression()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression
  - getBasePath
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getBasePath()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.BasePath`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath
  - getBody
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Object getBody()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.Body`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body
  - getBodyS3Location
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Object getBodyS3Location()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.BodyS3Location`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location
  - getCorsConfiguration
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Object getCorsConfiguration()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.CorsConfiguration`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration
  - getCredentialsArn
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getCredentialsArn()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.CredentialsArn`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn
  - getDescription
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getDescription()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.Description`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description
  - getDisableSchemaValidation
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Object getDisableSchemaValidation()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation
  - getFailOnWarnings
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Object getFailOnWarnings()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.FailOnWarnings`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings
  - getName
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getName()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.Name`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name
  - getProtocolType
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getProtocolType()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.ProtocolType`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype
  - getRouteKey
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getRouteKey()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.RouteKey`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey
  - getRouteSelectionExpression
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getRouteSelectionExpression()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.RouteSelectionExpression`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression
  - getTags
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Object getTags()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.Tags`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags
  - getTarget
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getTarget()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.Target`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target
  - getVersion
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getVersion()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Api.Version`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version
  - builder
```
@Stability(value=Deprecated)
 @Deprecated
static CfnApiV2Props.Builder builder()
```
    Deprecated.
    
    Returns:
    
    a CfnApiV2Props.Builder of CfnApiV2Props

Interface CfnApiV2Props

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getApiKeySelectionExpression

getBasePath

getBody

getBodyS3Location

getCorsConfiguration

getCredentialsArn

getDescription

getDisableSchemaValidation

getFailOnWarnings

getName

getProtocolType

getRouteKey

getRouteSelectionExpression

getTags

getTarget

getVersion

builder