Interface CfnApiProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnApiProps.Jsii$Proxy
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; 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(Map.of( "tagsKey", "tags")) .target("target") .version("version") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnApiProps
static final class
An implementation forCfnApiProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnApiProps.Builder
builder()
default String
An API key selection expression.default String
Specifies how to interpret the base path of the API during import.default Object
getBody()
The OpenAPI definition.default Object
The S3 location of an OpenAPI definition.default Object
A CORS configuration.default String
This property is part of quick create.default String
The description of the API.default Object
Specifies whether clients can invoke your API by using the defaultexecute-api
endpoint.default Object
Avoid validating models when creating a deployment.default Object
Specifies whether to rollback the API creation when a warning is encountered.default String
getName()
The name of the API.default String
The API protocol.default String
This property is part of quick create.default String
The route selection expression for the API.getTags()
The collection of tags.default String
This property is part of quick create.default String
A version identifier for the API.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApiKeySelectionExpression
An API key selection expression.Supported only for WebSocket APIs. See API Key Selection Expressions .
- See Also:
-
getBasePath
Specifies how to interpret the base path of the API during import.Valid values are
ignore
,prepend
, andsplit
. The default value isignore
. To learn more, see Set the OpenAPI basePath Property . Supported only for HTTP APIs.- See Also:
-
getBody
The OpenAPI definition.Supported only for HTTP APIs. To import an HTTP API, you must specify a
Body
orBodyS3Location
. If you specify aBody
orBodyS3Location
, don't specify CloudFormation resources such asAWS::ApiGatewayV2::Authorizer
orAWS::ApiGatewayV2::Route
. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.- See Also:
-
getBodyS3Location
The S3 location of an OpenAPI definition.Supported only for HTTP APIs. To import an HTTP API, you must specify a
Body
orBodyS3Location
. If you specify aBody
orBodyS3Location
, don't specify CloudFormation resources such asAWS::ApiGatewayV2::Authorizer
orAWS::ApiGatewayV2::Route
. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.- See Also:
-
getCorsConfiguration
A CORS configuration.Supported only for HTTP APIs. See Configuring CORS for more information.
- See Also:
-
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, specifynull
. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.- See Also:
-
getDescription
The description of the API.- See Also:
-
getDisableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the defaultexecute-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.
- See Also:
-
getDisableSchemaValidation
Avoid validating models when creating a deployment.Supported only for WebSocket APIs.
- See Also:
-
getFailOnWarnings
Specifies whether to rollback the API creation when a warning is encountered.By default, API creation continues if a warning is encountered.
- See Also:
-
getName
The name of the API.Required unless you specify an OpenAPI definition for
Body
orS3BodyLocation
.- See Also:
-
getProtocolType
The API protocol.Valid values are
WEBSOCKET
orHTTP
. Required unless you specify an OpenAPI definition forBody
orS3BodyLocation
.- See Also:
-
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.- See Also:
-
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.- See Also:
-
getTags
The collection of tags.Each tag element is associated with a given resource.
- See Also:
-
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.
- See Also:
-
getVersion
A version identifier for the API.- See Also:
-
builder
- Returns:
- a
CfnApiProps.Builder
ofCfnApiProps
-