CfnApiProps

All Known Implementing Classes:: CfnApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:40.684Z")
public interface CfnApiProps

Properties for defining a `CfnApi`.

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 body;
 Object tags;
 CfnApiProps cfnApiProps = CfnApiProps.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")
         .disableExecuteApiEndpoint(false)
         .disableSchemaValidation(false)
         .failOnWarnings(false)
         .name("name")
         .protocolType("protocolType")
         .routeKey("routeKey")
         .routeSelectionExpression("routeSelectionExpression")
         .tags(tags)
         .target("target")
         .version("version")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnApiProps.Builder` A builder for `CfnApiProps`
`static class`	`CfnApiProps.Jsii$Proxy` An implementation for `CfnApiProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnApiProps.Builder`	`builder()`
`default java.lang.String`	`getApiKeySelectionExpression()` An API key selection expression.
`default java.lang.String`	`getBasePath()` Specifies how to interpret the base path of the API during import.
`default java.lang.Object`	`getBody()` The OpenAPI definition.
`default java.lang.Object`	`getBodyS3Location()` The S3 location of an OpenAPI definition.
`default java.lang.Object`	`getCorsConfiguration()` A CORS configuration.
`default java.lang.String`	`getCredentialsArn()` This property is part of quick create.
`default java.lang.String`	`getDescription()` The description of the API.
`default java.lang.Object`	`getDisableExecuteApiEndpoint()` Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
`default java.lang.Object`	`getDisableSchemaValidation()` Avoid validating models when creating a deployment.
`default java.lang.Object`	`getFailOnWarnings()` Specifies whether to rollback the API creation when a warning is encountered.
`default java.lang.String`	`getName()` The name of the API.
`default java.lang.String`	`getProtocolType()` The API protocol.
`default java.lang.String`	`getRouteKey()` This property is part of quick create.
`default java.lang.String`	`getRouteSelectionExpression()` The route selection expression for the API.
`default java.lang.Object`	`getTags()` The collection of tags.
`default java.lang.String`	`getTarget()` This property is part of quick create.
`default java.lang.String`	`getVersion()` A version identifier for the API.

- Method Detail
  - getApiKeySelectionExpression
```
default java.lang.String getApiKeySelectionExpression()
```
    An API key selection expression.
    Supported only for WebSocket APIs. See API Key Selection Expressions .
  - getBasePath
```
default java.lang.String getBasePath()
```
    Specifies how to interpret the base path of the API during import.
    Valid values are ignore , prepend , and split . The default value is ignore . To learn more, see Set the OpenAPI basePath Property . Supported only for HTTP APIs.
  - getBody
```
default java.lang.Object getBody()
```
    The OpenAPI definition.
    Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
  - getBodyS3Location
```
default java.lang.Object getBodyS3Location()
```
    The S3 location of an OpenAPI definition.
    Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
  - getCorsConfiguration
```
default java.lang.Object getCorsConfiguration()
```
    A CORS configuration.
    Supported only for HTTP APIs. See Configuring CORS for more information.
  - getCredentialsArn
```
default java.lang.String getCredentialsArn()
```
    This property is part of quick create.
    It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, specify null . Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
  - getDescription
```
default java.lang.String getDescription()
```
    The description of the API.
  - getDisableExecuteApiEndpoint
```
default java.lang.Object getDisableExecuteApiEndpoint()
```
    Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
    By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
  - getDisableSchemaValidation
```
default java.lang.Object getDisableSchemaValidation()
```
    Avoid validating models when creating a deployment.
    Supported only for WebSocket APIs.
  - getFailOnWarnings
```
default java.lang.Object getFailOnWarnings()
```
    Specifies whether to rollback the API creation when a warning is encountered.
    By default, API creation continues if a warning is encountered.
  - getName
```
default java.lang.String getName()
```
    The name of the API.
    Required unless you specify an OpenAPI definition for Body or S3BodyLocation .
  - getProtocolType
```
default java.lang.String getProtocolType()
```
    The API protocol.
    Valid values are WEBSOCKET or HTTP . Required unless you specify an OpenAPI definition for Body or S3BodyLocation .
  - getRouteKey
```
default java.lang.String getRouteKey()
```
    This property is part of quick create.
    If you don't specify a routeKey , a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
  - getRouteSelectionExpression
```
default java.lang.String getRouteSelectionExpression()
```
    The route selection expression for the API.
    For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path} . If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
  - getTags
```
default java.lang.Object getTags()
```
    The collection of tags.
    Each tag element is associated with a given resource.
  - getTarget
```
default java.lang.String getTarget()
```
    This property is part of quick create.
    Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
  - getVersion
```
default java.lang.String getVersion()
```
    A version identifier for the API.
  - builder
```
static CfnApiProps.Builder builder()
```
    Returns:
    
    a CfnApiProps.Builder of CfnApiProps

Interface CfnApiProps

Nested Class Summary

Method Summary

Method Detail

getApiKeySelectionExpression

getBasePath

getBody

getBodyS3Location

getCorsConfiguration

getCredentialsArn

getDescription

getDisableExecuteApiEndpoint

getDisableSchemaValidation

getFailOnWarnings

getName

getProtocolType

getRouteKey

getRouteSelectionExpression

getTags

getTarget

getVersion

builder