Class CfnApi.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnApi>
- Enclosing class:
CfnApi
CfnApi
.-
Method Summary
Modifier and TypeMethodDescriptionapiKeySelectionExpression
(String apiKeySelectionExpression) An API key selection expression.Specifies how to interpret the base path of the API during import.The OpenAPI definition.bodyS3Location
(IResolvable bodyS3Location) The S3 location of an OpenAPI definition.bodyS3Location
(CfnApi.BodyS3LocationProperty bodyS3Location) The S3 location of an OpenAPI definition.build()
corsConfiguration
(IResolvable corsConfiguration) A CORS configuration.corsConfiguration
(CfnApi.CorsProperty corsConfiguration) A CORS configuration.static CfnApi.Builder
credentialsArn
(String credentialsArn) This property is part of quick create.description
(String description) The description of the API.disableExecuteApiEndpoint
(Boolean disableExecuteApiEndpoint) Specifies whether clients can invoke your API by using the defaultexecute-api
endpoint.disableExecuteApiEndpoint
(IResolvable disableExecuteApiEndpoint) Specifies whether clients can invoke your API by using the defaultexecute-api
endpoint.disableSchemaValidation
(Boolean disableSchemaValidation) Avoid validating models when creating a deployment.disableSchemaValidation
(IResolvable disableSchemaValidation) Avoid validating models when creating a deployment.failOnWarnings
(Boolean failOnWarnings) Specifies whether to rollback the API creation when a warning is encountered.failOnWarnings
(IResolvable failOnWarnings) Specifies whether to rollback the API creation when a warning is encountered.The name of the API.protocolType
(String protocolType) The API protocol.This property is part of quick create.routeSelectionExpression
(String routeSelectionExpression) The route selection expression for the API.The collection of tags.This property is part of quick create.A version identifier for the API.
-
Method Details
-
create
@Stability(Stable) public static CfnApi.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnApi.Builder
.
-
apiKeySelectionExpression
@Stability(Stable) public CfnApi.Builder apiKeySelectionExpression(String apiKeySelectionExpression) An API key selection expression.Supported only for WebSocket APIs. See API Key Selection Expressions .
- Parameters:
apiKeySelectionExpression
- An API key selection expression. This parameter is required.- Returns:
this
- See Also:
-
basePath
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.- Parameters:
basePath
- Specifies how to interpret the base path of the API during import. This parameter is required.- Returns:
this
- See Also:
-
body
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.- Parameters:
body
- The OpenAPI definition. This parameter is required.- Returns:
this
- See Also:
-
bodyS3Location
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.- Parameters:
bodyS3Location
- The S3 location of an OpenAPI definition. This parameter is required.- Returns:
this
- See Also:
-
bodyS3Location
@Stability(Stable) public CfnApi.Builder bodyS3Location(CfnApi.BodyS3LocationProperty bodyS3Location) 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.- Parameters:
bodyS3Location
- The S3 location of an OpenAPI definition. This parameter is required.- Returns:
this
- See Also:
-
corsConfiguration
A CORS configuration.Supported only for HTTP APIs. See Configuring CORS for more information.
- Parameters:
corsConfiguration
- A CORS configuration. This parameter is required.- Returns:
this
- See Also:
-
corsConfiguration
A CORS configuration.Supported only for HTTP APIs. See Configuring CORS for more information.
- Parameters:
corsConfiguration
- A CORS configuration. This parameter is required.- Returns:
this
- See Also:
-
credentialsArn
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.- Parameters:
credentialsArn
- This property is part of quick create. This parameter is required.- Returns:
this
- See Also:
-
description
The description of the API.- Parameters:
description
- The description of the API. This parameter is required.- Returns:
this
- See Also:
-
disableExecuteApiEndpoint
@Stability(Stable) public CfnApi.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) 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.
- Parameters:
disableExecuteApiEndpoint
- Specifies whether clients can invoke your API by using the defaultexecute-api
endpoint. This parameter is required.- Returns:
this
- See Also:
-
disableExecuteApiEndpoint
@Stability(Stable) public CfnApi.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint) 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.
- Parameters:
disableExecuteApiEndpoint
- Specifies whether clients can invoke your API by using the defaultexecute-api
endpoint. This parameter is required.- Returns:
this
- See Also:
-
disableSchemaValidation
Avoid validating models when creating a deployment.Supported only for WebSocket APIs.
- Parameters:
disableSchemaValidation
- Avoid validating models when creating a deployment. This parameter is required.- Returns:
this
- See Also:
-
disableSchemaValidation
@Stability(Stable) public CfnApi.Builder disableSchemaValidation(IResolvable disableSchemaValidation) Avoid validating models when creating a deployment.Supported only for WebSocket APIs.
- Parameters:
disableSchemaValidation
- Avoid validating models when creating a deployment. This parameter is required.- Returns:
this
- See Also:
-
failOnWarnings
Specifies whether to rollback the API creation when a warning is encountered.By default, API creation continues if a warning is encountered.
- Parameters:
failOnWarnings
- Specifies whether to rollback the API creation when a warning is encountered. This parameter is required.- Returns:
this
- See Also:
-
failOnWarnings
Specifies whether to rollback the API creation when a warning is encountered.By default, API creation continues if a warning is encountered.
- Parameters:
failOnWarnings
- Specifies whether to rollback the API creation when a warning is encountered. This parameter is required.- Returns:
this
- See Also:
-
name
The name of the API.Required unless you specify an OpenAPI definition for
Body
orS3BodyLocation
.- Parameters:
name
- The name of the API. This parameter is required.- Returns:
this
- See Also:
-
protocolType
The API protocol.Valid values are
WEBSOCKET
orHTTP
. Required unless you specify an OpenAPI definition forBody
orS3BodyLocation
.- Parameters:
protocolType
- The API protocol. This parameter is required.- Returns:
this
- See Also:
-
routeKey
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.- Parameters:
routeKey
- This property is part of quick create. This parameter is required.- Returns:
this
- See Also:
-
routeSelectionExpression
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.- Parameters:
routeSelectionExpression
- The route selection expression for the API. This parameter is required.- Returns:
this
- See Also:
-
tags
The collection of tags.Each tag element is associated with a given resource.
- Parameters:
tags
- The collection of tags. This parameter is required.- Returns:
this
- See Also:
-
target
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.
- Parameters:
target
- This property is part of quick create. This parameter is required.- Returns:
this
- See Also:
-
version
A version identifier for the API.- Parameters:
version
- A version identifier for the API. This parameter is required.- Returns:
this
- See Also:
-
build
-